Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep
Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> org >> acegisecurity >> [ captcha overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of org.acegisecurity.captcha.CaptchaEntryPoint JAVADOC | Sourc code of org.acegisecurity.captcha.CaptchaEntryPoint SOURCE | Download org.acegisecurity.captcha.CaptchaEntryPoint DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.acegisecurity.captcha
Class CaptchaEntryPoint  view CaptchaEntryPoint download CaptchaEntryPoint.java

java.lang.Object
  extended byorg.acegisecurity.captcha.CaptchaEntryPoint
All Implemented Interfaces:
org.acegisecurity.securechannel.ChannelEntryPoint, org.springframework.beans.factory.InitializingBean
public class CaptchaEntryPoint
extends java.lang.Object
implements org.acegisecurity.securechannel.ChannelEntryPoint, org.springframework.beans.factory.InitializingBean

The captcha entry point : redirect to the captcha test page.

This entry point can force the use of SSL : see getForceHttps() 55

This entry point allows internal OR external redirect : see setOutsideWebApp(boolean) 55
/ Original request can be added to the redirect path using a custom translation : see setIncludeOriginalRequest(boolean) 55
Original request is translated using URLEncoding and the following translation mapping in the redirect url :

Default values :
forceHttps = false
includesOriginalRequest = true
includesOriginalParameters = false
isOutsideWebApp=false
originalRequestUrlParameterName =original_requestUrl
originalRequestParametersParameterName = original_request_parameters
originalRequestParametersNameValueSeparator = __
originalRequestParametersSeparator = ;;
originalRequestMethodParameterName = original_request_method
urlEncodingCharset = UTF-8

Version:
$Id: CaptchaEntryPoint.java,v 1.4 2005/11/17 00:55:49 benalex Exp $

Field Summary
private  java.lang.String captchaFormUrl
           
private  boolean forceHttps
           
private  boolean includeOriginalParameters
           
private  boolean includeOriginalRequest
           
private  boolean isOutsideWebApp
           
private static org.apache.commons.logging.Log logger
           
private  java.lang.String originalRequestMethodParameterName
           
private  java.lang.String originalRequestParametersNameValueSeparator
           
private  java.lang.String originalRequestParametersParameterName
           
private  java.lang.String originalRequestParametersSeparator
           
private  java.lang.String originalRequestUrlParameterName
           
private  org.acegisecurity.util.PortMapper portMapper
           
private  org.acegisecurity.util.PortResolver portResolver
           
private  java.lang.String urlEncodingCharset
           
 
Constructor Summary
CaptchaEntryPoint()
           
 
Method Summary
 void afterPropertiesSet()
          Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
private  void buildInternalRedirect(java.lang.StringBuffer redirectUrl, javax.servlet.http.HttpServletRequest req)
           
 void commence(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response)
          Commences a secure channel.
 java.lang.String getCaptchaFormUrl()
          DOCUMENT ME!
 boolean getForceHttps()
           
 java.lang.String getOriginalRequestMethodParameterName()
           
 java.lang.String getOriginalRequestParametersNameValueSeparator()
           
 java.lang.String getOriginalRequestParametersParameterName()
           
 java.lang.String getOriginalRequestParametersSeparator()
           
 java.lang.String getOriginalRequestUrlParameterName()
           
 org.acegisecurity.util.PortMapper getPortMapper()
           
 org.acegisecurity.util.PortResolver getPortResolver()
           
 java.lang.String getUrlEncodingCharset()
           
private  void includeOriginalRequest(java.lang.StringBuffer redirectUrl, javax.servlet.http.HttpServletRequest req)
           
 boolean isIncludeOriginalParameters()
           
 boolean isIncludeOriginalRequest()
           
 boolean isOutsideWebApp()
           
 void setCaptchaFormUrl(java.lang.String captchaFormUrl)
          The URL where the CaptchaProcessingFilter login page can be found.
 void setForceHttps(boolean forceHttps)
          Set to true to force captcha form access to be via https.
 void setIncludeOriginalParameters(boolean includeOriginalParameters)
           
 void setIncludeOriginalRequest(boolean includeOriginalRequest)
          If set to true, the original request url will be appended to the redirect url using the getOriginalRequestUrlParameterName() 55 .
 void setOriginalRequestMethodParameterName(java.lang.String originalRequestMethodParameterName)
           
 void setOriginalRequestParametersNameValueSeparator(java.lang.String originalRequestParametersNameValueSeparator)
           
 void setOriginalRequestParametersParameterName(java.lang.String originalRequestParametersParameterName)
           
 void setOriginalRequestParametersSeparator(java.lang.String originalRequestParametersSeparator)
           
 void setOriginalRequestUrlParameterName(java.lang.String originalRequestUrlParameterName)
           
 void setOutsideWebApp(boolean isOutsideWebApp)
          if set to true, the commence(ServletRequest, ServletResponse) 55 method uses the getCaptchaFormUrl() 55 as a complete URL, else it as a 'inside WebApp' path.
 void setPortMapper(org.acegisecurity.util.PortMapper portMapper)
           
 void setPortResolver(org.acegisecurity.util.PortResolver portResolver)
           
 void setUrlEncodingCharset(java.lang.String urlEncodingCharset)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

logger

private static final org.apache.commons.logging.Log logger

portMapper

private org.acegisecurity.util.PortMapper portMapper

portResolver

private org.acegisecurity.util.PortResolver portResolver

captchaFormUrl

private java.lang.String captchaFormUrl

originalRequestMethodParameterName

private java.lang.String originalRequestMethodParameterName

originalRequestParametersNameValueSeparator

private java.lang.String originalRequestParametersNameValueSeparator

originalRequestParametersParameterName

private java.lang.String originalRequestParametersParameterName

originalRequestParametersSeparator

private java.lang.String originalRequestParametersSeparator

originalRequestUrlParameterName

private java.lang.String originalRequestUrlParameterName

urlEncodingCharset

private java.lang.String urlEncodingCharset

forceHttps

private boolean forceHttps

includeOriginalParameters

private boolean includeOriginalParameters

includeOriginalRequest

private boolean includeOriginalRequest

isOutsideWebApp

private boolean isOutsideWebApp
Constructor Detail

CaptchaEntryPoint

public CaptchaEntryPoint()
Method Detail

setCaptchaFormUrl

public void setCaptchaFormUrl(java.lang.String captchaFormUrl)
The URL where the CaptchaProcessingFilter login page can be found. Should be relative to the web-app context path, and include a leading /

getCaptchaFormUrl

public java.lang.String getCaptchaFormUrl()
DOCUMENT ME!

setForceHttps

public void setForceHttps(boolean forceHttps)
Set to true to force captcha form access to be via https. If this value is ture (the default is false), and the incoming request for the protected resource which triggered the interceptor was not already https, then

getForceHttps

public boolean getForceHttps()

setIncludeOriginalParameters

public void setIncludeOriginalParameters(boolean includeOriginalParameters)

isIncludeOriginalParameters

public boolean isIncludeOriginalParameters()

setIncludeOriginalRequest

public void setIncludeOriginalRequest(boolean includeOriginalRequest)
If set to true, the original request url will be appended to the redirect url using the getOriginalRequestUrlParameterName() 55 .

isIncludeOriginalRequest

public boolean isIncludeOriginalRequest()

setOriginalRequestMethodParameterName

public void setOriginalRequestMethodParameterName(java.lang.String originalRequestMethodParameterName)

getOriginalRequestMethodParameterName

public java.lang.String getOriginalRequestMethodParameterName()

setOriginalRequestParametersNameValueSeparator

public void setOriginalRequestParametersNameValueSeparator(java.lang.String originalRequestParametersNameValueSeparator)

getOriginalRequestParametersNameValueSeparator

public java.lang.String getOriginalRequestParametersNameValueSeparator()

setOriginalRequestParametersParameterName

public void setOriginalRequestParametersParameterName(java.lang.String originalRequestParametersParameterName)

getOriginalRequestParametersParameterName

public java.lang.String getOriginalRequestParametersParameterName()

setOriginalRequestParametersSeparator

public void setOriginalRequestParametersSeparator(java.lang.String originalRequestParametersSeparator)

getOriginalRequestParametersSeparator

public java.lang.String getOriginalRequestParametersSeparator()

setOriginalRequestUrlParameterName

public void setOriginalRequestUrlParameterName(java.lang.String originalRequestUrlParameterName)

getOriginalRequestUrlParameterName

public java.lang.String getOriginalRequestUrlParameterName()

setOutsideWebApp

public void setOutsideWebApp(boolean isOutsideWebApp)
if set to true, the commence(ServletRequest, ServletResponse) 55 method uses the getCaptchaFormUrl() 55 as a complete URL, else it as a 'inside WebApp' path.

isOutsideWebApp

public boolean isOutsideWebApp()

setPortMapper

public void setPortMapper(org.acegisecurity.util.PortMapper portMapper)

getPortMapper

public org.acegisecurity.util.PortMapper getPortMapper()

setPortResolver

public void setPortResolver(org.acegisecurity.util.PortResolver portResolver)

getPortResolver

public org.acegisecurity.util.PortResolver getPortResolver()

setUrlEncodingCharset

public void setUrlEncodingCharset(java.lang.String urlEncodingCharset)

getUrlEncodingCharset

public java.lang.String getUrlEncodingCharset()

afterPropertiesSet

public void afterPropertiesSet()
                        throws java.lang.Exception
Description copied from interface: org.springframework.beans.factory.InitializingBean
Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).

This method allows the bean instance to perform initialization only possible when all bean properties have been set and to throw an exception in the event of misconfiguration.

Specified by:
afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

commence

public void commence(javax.servlet.ServletRequest request,
                     javax.servlet.ServletResponse response)
              throws java.io.IOException,
                     javax.servlet.ServletException
Description copied from interface: org.acegisecurity.securechannel.ChannelEntryPoint
Commences a secure channel.

Implementations should modify the headers on the ServletResponse as necessary to commence the user agent using the implementation's supported channel type.

Specified by:
commence in interface org.acegisecurity.securechannel.ChannelEntryPoint

buildInternalRedirect

private void buildInternalRedirect(java.lang.StringBuffer redirectUrl,
                                   javax.servlet.http.HttpServletRequest req)

includeOriginalRequest

private void includeOriginalRequest(java.lang.StringBuffer redirectUrl,
                                    javax.servlet.http.HttpServletRequest req)
Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> org >> acegisecurity >> [ captcha overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of org.acegisecurity.captcha.CaptchaEntryPoint JAVADOC | Sourc code of org.acegisecurity.captcha.CaptchaEntryPoint SOURCE | Download org.acegisecurity.captcha.CaptchaEntryPoint DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD