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

Quick Search    Search Deep

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

java.lang.Object
  extended byorg.acegisecurity.ui.AbstractProcessingFilter
      extended byorg.acegisecurity.ui.webapp.AuthenticationProcessingFilter
All Implemented Interfaces:
org.springframework.context.ApplicationEventPublisherAware, javax.servlet.Filter, org.springframework.beans.factory.InitializingBean, org.springframework.context.MessageSourceAware
Direct Known Subclasses:
SiteminderAuthenticationProcessingFilter

public class AuthenticationProcessingFilter
extends org.acegisecurity.ui.AbstractProcessingFilter

Processes an authentication form.

Login forms must present two parameters to this filter: a username and password. The parameter names to use are contained in the static fields ACEGI_SECURITY_FORM_USERNAME_KEY 55 and ACEGI_SECURITY_FORM_PASSWORD_KEY 55 .

Do not use this class directly. Instead configure web.xml to use the org.acegisecurity.util.FilterToBeanProxy.

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

Field Summary
static java.lang.String ACEGI_SECURITY_FORM_PASSWORD_KEY
           
static java.lang.String ACEGI_SECURITY_FORM_USERNAME_KEY
           
static java.lang.String ACEGI_SECURITY_LAST_USERNAME_KEY
           
 
Fields inherited from class org.acegisecurity.ui.AbstractProcessingFilter
ACEGI_SECURITY_LAST_EXCEPTION_KEY, ACEGI_SECURITY_TARGET_URL_KEY, logger, messages
 
Constructor Summary
AuthenticationProcessingFilter()
           
 
Method Summary
 org.acegisecurity.Authentication attemptAuthentication(javax.servlet.http.HttpServletRequest request)
          Performs actual authentication.
 java.lang.String getDefaultFilterProcessesUrl()
          This filter by default responds to /j_acegi_security_check.
 void init(javax.servlet.FilterConfig filterConfig)
          Does nothing.
protected  java.lang.String obtainPassword(javax.servlet.http.HttpServletRequest request)
          Enables subclasses to override the composition of the password, such as by including additional values and a separator.
protected  java.lang.String obtainUsername(javax.servlet.http.HttpServletRequest request)
          Enables subclasses to override the composition of the username, such as by including additional values and a separator.
protected  void setDetails(javax.servlet.http.HttpServletRequest request, org.acegisecurity.providers.UsernamePasswordAuthenticationToken authRequest)
          Provided so that subclasses may configure what is put into the authentication request's details property.
 
Methods inherited from class org.acegisecurity.ui.AbstractProcessingFilter
afterPropertiesSet, destroy, doFilter, getAuthenticationFailureUrl, getAuthenticationManager, getDefaultTargetUrl, getExceptionMappings, getFilterProcessesUrl, getRememberMeServices, isAlwaysUseDefaultTargetUrl, isContinueChainBeforeSuccessfulAuthentication, onPreAuthentication, onSuccessfulAuthentication, onUnsuccessfulAuthentication, requiresAuthentication, setAlwaysUseDefaultTargetUrl, setApplicationEventPublisher, setAuthenticationFailureUrl, setAuthenticationManager, setContinueChainBeforeSuccessfulAuthentication, setDefaultTargetUrl, setExceptionMappings, setFilterProcessesUrl, setMessageSource, setRememberMeServices, successfulAuthentication, unsuccessfulAuthentication
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ACEGI_SECURITY_FORM_USERNAME_KEY

public static final java.lang.String ACEGI_SECURITY_FORM_USERNAME_KEY
See Also:
Constant Field Values

ACEGI_SECURITY_FORM_PASSWORD_KEY

public static final java.lang.String ACEGI_SECURITY_FORM_PASSWORD_KEY
See Also:
Constant Field Values

ACEGI_SECURITY_LAST_USERNAME_KEY

public static final java.lang.String ACEGI_SECURITY_LAST_USERNAME_KEY
See Also:
Constant Field Values
Constructor Detail

AuthenticationProcessingFilter

public AuthenticationProcessingFilter()
Method Detail

getDefaultFilterProcessesUrl

public java.lang.String getDefaultFilterProcessesUrl()
This filter by default responds to /j_acegi_security_check.


attemptAuthentication

public org.acegisecurity.Authentication attemptAuthentication(javax.servlet.http.HttpServletRequest request)
                                                       throws org.acegisecurity.AuthenticationException
Description copied from class: org.acegisecurity.ui.AbstractProcessingFilter
Performs actual authentication.


init

public void init(javax.servlet.FilterConfig filterConfig)
          throws javax.servlet.ServletException
Description copied from class: org.acegisecurity.ui.AbstractProcessingFilter
Does nothing. We use IoC container lifecycle services instead.


setDetails

protected void setDetails(javax.servlet.http.HttpServletRequest request,
                          org.acegisecurity.providers.UsernamePasswordAuthenticationToken authRequest)
Provided so that subclasses may configure what is put into the authentication request's details property. The default implementation simply constructs org.acegisecurity.ui.WebAuthenticationDetails.


obtainPassword

protected java.lang.String obtainPassword(javax.servlet.http.HttpServletRequest request)
Enables subclasses to override the composition of the password, such as by including additional values and a separator.

This might be used for example if a postcode/zipcode was required in addition to the password. A delimiter such as a pipe (|) should be used to separate the password and extended value(s). The AuthenticationDao will need to generate the expected password in a corresponding manner.


obtainUsername

protected java.lang.String obtainUsername(javax.servlet.http.HttpServletRequest request)
Enables subclasses to override the composition of the username, such as by including additional values and a separator.