org.acegisecurity.captcha
Class CaptchaEntryPoint

java.lang.Object
  org.acegisecurity.captcha.CaptchaEntryPoint

All Implemented Interfaces:

ChannelEntryPoint, InitializingBean

public class CaptchaEntryPoint
extends Object
implements ChannelEntryPoint, InitializingBean

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

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

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

• original url => getOriginalRequestUrlParameterName()
• If isIncludeOriginalParameters()
• original method => getOriginalRequestMethodParameterName()
• original parameters => getOriginalRequestParametersParameterName()
• The original parameters string is contructed using :
  • a parameter separator getOriginalRequestParametersSeparator()
  • a parameter name value pair separator for each parameter getOriginalRequestParametersNameValueSeparator()

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 1496 2006-05-23 13:38:33Z benalex $

Author:

marc antoine Garrigue

Constructor Summary

CaptchaEntryPoint()

Method Summary

void	afterPropertiesSet()
void	commence(ServletRequest request, ServletResponse response) Commences a secure channel.
String	getCaptchaFormUrl() DOCUMENT ME!
boolean	getForceHttps()
String	getOriginalRequestMethodParameterName()
String	getOriginalRequestParametersNameValueSeparator()
String	getOriginalRequestParametersParameterName()
String	getOriginalRequestParametersSeparator()
String	getOriginalRequestUrlParameterName()
PortMapper	getPortMapper()
PortResolver	getPortResolver()
String	getUrlEncodingCharset()
boolean	isIncludeOriginalParameters()
boolean	isIncludeOriginalRequest()
boolean	isOutsideWebApp()
void	setCaptchaFormUrl(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().
void	setOriginalRequestMethodParameterName(String originalRequestMethodParameterName)
void	setOriginalRequestParametersNameValueSeparator(String originalRequestParametersNameValueSeparator)
void	setOriginalRequestParametersParameterName(String originalRequestParametersParameterName)
void	setOriginalRequestParametersSeparator(String originalRequestParametersSeparator)
void	setOriginalRequestUrlParameterName(String originalRequestUrlParameterName)
void	setOutsideWebApp(boolean isOutsideWebApp) if set to true, the commence(ServletRequest, ServletResponse) method uses the getCaptchaFormUrl() as a complete URL, else it as a 'inside WebApp' path.
void	setPortMapper(PortMapper portMapper)
void	setPortResolver(PortResolver portResolver)
void	setUrlEncodingCharset(String urlEncodingCharset)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CaptchaEntryPoint

public CaptchaEntryPoint()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface InitializingBean

Throws:

Exception

commence

public void commence(ServletRequest request,
                     ServletResponse response)
              throws IOException,
                     ServletException

Description copied from interface: 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 ChannelEntryPoint

Parameters:

request - that a ChannelProcessor has rejected

response - so that the user agent can begin using a new channel

Throws:

IOException - DOCUMENT ME!

ServletException - DOCUMENT ME!

getCaptchaFormUrl

public String getCaptchaFormUrl()

DOCUMENT ME!

Returns:

the captcha test page to redirect to.

getForceHttps

public boolean getForceHttps()

getOriginalRequestMethodParameterName

public String getOriginalRequestMethodParameterName()

getOriginalRequestParametersNameValueSeparator

public String getOriginalRequestParametersNameValueSeparator()

getOriginalRequestParametersParameterName

public String getOriginalRequestParametersParameterName()

getOriginalRequestParametersSeparator

public String getOriginalRequestParametersSeparator()

getOriginalRequestUrlParameterName

public String getOriginalRequestUrlParameterName()

getPortMapper

public PortMapper getPortMapper()

getPortResolver

public PortResolver getPortResolver()

getUrlEncodingCharset

public String getUrlEncodingCharset()

isIncludeOriginalParameters

public boolean isIncludeOriginalParameters()

isIncludeOriginalRequest

public boolean isIncludeOriginalRequest()

isOutsideWebApp

public boolean isOutsideWebApp()

setCaptchaFormUrl

public void setCaptchaFormUrl(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 /

Parameters:

captchaFormUrl -

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

Parameters:

forceHttps -

setIncludeOriginalParameters

public void setIncludeOriginalParameters(boolean includeOriginalParameters)

setIncludeOriginalRequest

public void setIncludeOriginalRequest(boolean includeOriginalRequest)

If set to true, the original request url will be appended to the redirect url using the getOriginalRequestUrlParameterName().

Parameters:

includeOriginalRequest -

setOriginalRequestMethodParameterName

public void setOriginalRequestMethodParameterName(String originalRequestMethodParameterName)

setOriginalRequestParametersNameValueSeparator

public void setOriginalRequestParametersNameValueSeparator(String originalRequestParametersNameValueSeparator)

setOriginalRequestParametersParameterName

public void setOriginalRequestParametersParameterName(String originalRequestParametersParameterName)

setOriginalRequestParametersSeparator

public void setOriginalRequestParametersSeparator(String originalRequestParametersSeparator)

setOriginalRequestUrlParameterName

public void setOriginalRequestUrlParameterName(String originalRequestUrlParameterName)

setOutsideWebApp

public void setOutsideWebApp(boolean isOutsideWebApp)

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

Parameters:

isOutsideWebApp -

setPortMapper

public void setPortMapper(PortMapper portMapper)

setPortResolver

public void setPortResolver(PortResolver portResolver)

setUrlEncodingCharset

public void setUrlEncodingCharset(String urlEncodingCharset)