org.apache.cocoon.webapps.authentication.components
Class ServletAuthenticator

java.lang.Object
  extended byorg.apache.avalon.framework.logger.AbstractLogEnabled
      extended byorg.apache.cocoon.webapps.authentication.components.ServletAuthenticator
All Implemented Interfaces:
Authenticator, Contextualizable, LogEnabled, Serviceable, ThreadSafe

public class ServletAuthenticator
extends AbstractLogEnabled
implements Contextualizable, ThreadSafe, Serviceable, Authenticator

Verify if a user can be authenticated. This is a very simple authenticator that checks if the user is authenticated using the servlet authentication mechanisms.

Version:
CVS $Id: PipelineAuthenticator.java 30932 2004-07-29 17:35:38Z vgritsenko $
Author:
Carsten Ziegeler

Nested Class Summary
 
Nested classes inherited from class org.apache.cocoon.webapps.authentication.components.Authenticator
Authenticator.AuthenticationResult
 
Field Summary
protected  Context context
           
protected  ServiceManager manager
           
 
Constructor Summary
ServletAuthenticator()
           
 
Method Summary
 Authenticator.AuthenticationResult authenticate(HandlerConfiguration configuration, SourceParameters parameters)
          Try to authenticate the user.
 void contextualize(Context context)
           
protected  void fillContext(Document contextDoc)
          Fill the authentication context.
 void logout(UserHandler handler)
          This notifies the authenticator that a user logs out of the given handler.
 void service(ServiceManager manager)
           
 
Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled
enableLogging, getLogger, setupLogger, setupLogger, setupLogger
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

context

protected Context context

manager

protected ServiceManager manager
Constructor Detail

ServletAuthenticator

public ServletAuthenticator()
Method Detail

contextualize

public void contextualize(Context context)
                   throws ContextException
Specified by:
contextualize in interface Contextualizable
Throws:
ContextException

service

public void service(ServiceManager manager)
             throws ServiceException
Specified by:
service in interface Serviceable
Throws:
ServiceException

fillContext

protected void fillContext(Document contextDoc)
Fill the authentication context. This method can be overwritten to add any application specific data to the user. (Don't forget to call this implementation via super as well as it adds the ID).

Parameters:
contextDoc - The context. This document has already the authentication root node.

authenticate

public Authenticator.AuthenticationResult authenticate(HandlerConfiguration configuration,
                                                       SourceParameters parameters)
                                                throws ProcessingException
Description copied from interface: Authenticator
Try to authenticate the user.

Specified by:
authenticate in interface Authenticator
Returns:
A AuthenticationResult that is either valid (authentication successful) or invalid (authentication failed.
Throws:
ProcessingException - Only if an error occurs

logout

public void logout(UserHandler handler)
Description copied from interface: Authenticator
This notifies the authenticator that a user logs out of the given handler. After the authenticator is notified, the AuthenticationManager removes the authentication context, eventually the session etc.

Specified by:
logout in interface Authenticator


Copyright ? 1999-2005 The Apache Software Foundation. All Rights Reserved.