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

java.lang.Object
  org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.cocoon.webapps.authentication.components.ServletAuthenticator

All Implemented Interfaces:

Contextualizable, LogEnabled, Serviceable, ThreadSafe, Authenticator

Deprecated. This block is deprecated and will be removed in future versions.

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: ServletAuthenticator.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Author:

Carsten Ziegeler

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.cocoon.webapps.authentication.components.Authenticator

Authenticator.AuthenticationResult

Field Summary

protected Context	context Deprecated.
protected ServiceManager	manager Deprecated.

Constructor Summary

ServletAuthenticator()
Deprecated.

Method Summary

Authenticator.AuthenticationResult	authenticate(HandlerConfiguration configuration, SourceParameters parameters) Deprecated. Try to authenticate the user.
void	contextualize(Context context) Deprecated.
protected void	fillContext(Document contextDoc) Deprecated. Fill the authentication context.
void	logout(UserHandler handler) Deprecated. This notifies the authenticator that a user logs out of the given handler.
void	service(ServiceManager manager) Deprecated.

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

Deprecated.

manager

protected ServiceManager manager

Deprecated.

Constructor Detail

ServletAuthenticator

public ServletAuthenticator()

Deprecated.

Method Detail

contextualize

public void contextualize(Context context)
                   throws ContextException

Deprecated.

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

service

public void service(ServiceManager manager)
             throws ServiceException

Deprecated.

Specified by:

service in interface Serviceable

Throws:

ServiceException

fillContext

protected void fillContext(Document contextDoc)

Deprecated.

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

Deprecated.

Description copied from interface: Authenticator

Try to authenticate the user.

Specified by:

authenticate in interface Authenticator

Returns:

An AuthenticationResult that is either valid (authentication successful) or invalid (authentication failed.

Throws:

ProcessingException - Only if an error occurs

logout

public void logout(UserHandler handler)

Deprecated.

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