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

Quick Search    Search Deep

org.acegisecurity.ui.webapp
Class AuthenticationProcessingFilterEntryPoint  view AuthenticationProcessingFilterEntryPoint download AuthenticationProcessingFilterEntryPoint.java

java.lang.Object
  extended byorg.acegisecurity.ui.webapp.AuthenticationProcessingFilterEntryPoint
All Implemented Interfaces:
org.acegisecurity.intercept.web.AuthenticationEntryPoint, org.springframework.beans.factory.InitializingBean

public class AuthenticationProcessingFilterEntryPoint
extends java.lang.Object
implements org.acegisecurity.intercept.web.AuthenticationEntryPoint, org.springframework.beans.factory.InitializingBean

Used by the SecurityEnforcementFilter to commence authentication via the AuthenticationProcessingFilter. This object holds the location of the login form, relative to the web app context path, and is used to commence a redirect to that form.

By setting the forceHttps property to true, you may configure the class to force the protocol used for the login form to be HTTPS, even if the original intercepted request for a resource used the HTTP protocol. When this happens, after a successful login (via HTTPS), the original resource will still be accessed as HTTP, via the original request URL. For the forced HTTPS feature to work, the org.acegisecurity.util.PortMapper is consulted to determine the HTTP:HTTPS pairs.

Version:
$Id: AuthenticationProcessingFilterEntryPoint.java,v 1.11 2005/11/17 00:55:50 benalex Exp $

Field Summary
private  boolean forceHttps
           
private static org.apache.commons.logging.Log logger
           
private  java.lang.String loginFormUrl
           
private  org.acegisecurity.util.PortMapper portMapper
           
private  org.acegisecurity.util.PortResolver portResolver
           
 
Constructor Summary
AuthenticationProcessingFilterEntryPoint()
           
 
Method Summary
 void afterPropertiesSet()
          Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
 void commence(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, org.acegisecurity.AuthenticationException authException)
          Commences an authentication scheme.
 boolean getForceHttps()
           
 java.lang.String getLoginFormUrl()
           
 org.acegisecurity.util.PortMapper getPortMapper()
           
 org.acegisecurity.util.PortResolver getPortResolver()
           
 void setForceHttps(boolean forceHttps)
          Set to true to force login form access to be via https.
 void setLoginFormUrl(java.lang.String loginFormUrl)
          The URL where the AuthenticationProcessingFilter login page can be found.
 void setPortMapper(org.acegisecurity.util.PortMapper portMapper)
           
 void setPortResolver(org.acegisecurity.util.PortResolver portResolver)
           
 
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

loginFormUrl

private java.lang.String loginFormUrl

forceHttps

private boolean forceHttps
Constructor Detail

AuthenticationProcessingFilterEntryPoint

public AuthenticationProcessingFilterEntryPoint()
Method Detail

setForceHttps

public void setForceHttps(boolean forceHttps)
Set to true to force login 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()

setLoginFormUrl

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


getLoginFormUrl

public java.lang.String getLoginFormUrl()

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()

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,
                     org.acegisecurity.AuthenticationException authException)
              throws java.io.IOException,
                     javax.servlet.ServletException
Description copied from interface: org.acegisecurity.intercept.web.AuthenticationEntryPoint
Commences an authentication scheme.

SecurityEnforcementFilter will populate the HttpSession attribute named AuthenticationProcessingFilter.ACEGI_SECURITY_TARGET_URL_KEY with the requested target URL before calling this method.

Implementations should modify the headers on the ServletResponse as necessary to commence the authentication process.

Specified by:
commence in interface org.acegisecurity.intercept.web.AuthenticationEntryPoint