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

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

public class PipelineAuthenticator
extends AbstractLogEnabled
implements Serviceable, ThreadSafe, Disposable, Authenticator

Verify if a user can be authenticated.

Version:
CVS $Id: PipelineAuthenticator.java 53740 2004-10-04 19:20:08Z vgritsenko $
Author:
Carsten Ziegeler

Nested Class Summary
 
Nested classes inherited from class org.apache.cocoon.webapps.authentication.components.Authenticator
Authenticator.AuthenticationResult
 
Field Summary
protected  ServiceManager manager
          The service manager
protected  SourceResolver resolver
          The source resolver
 
Constructor Summary
PipelineAuthenticator()
           
 
Method Summary
 Authenticator.AuthenticationResult authenticate(HandlerConfiguration configuration, SourceParameters parameters)
          Try to authenticate the user.
 void dispose()
           
 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

manager

protected ServiceManager manager
The service manager


resolver

protected SourceResolver resolver
The source resolver

Constructor Detail

PipelineAuthenticator

public PipelineAuthenticator()
Method Detail

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

service

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

dispose

public void dispose()
Specified by:
dispose in interface Disposable

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.