org.apache.cocoon.webapps.authentication
Interface AuthenticationManager

All Known Implementing Classes:

DefaultAuthenticationManager

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

public interface AuthenticationManager

This is the authentication manager. It is used to authenticate (login, logout) a user. Usually, this component should not be used from custom code. The provided actions perform all required tasks.

Version:

CVS $Id: AuthenticationManager.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Author:

Carsten Ziegeler

Field Summary

static String

ROLE Deprecated. The Avalon Role

Method Summary

boolean	checkAuthentication(Redirector redirector, String handlerName, String applicationName) Deprecated. Is the current user authenticated for the given handler?
SessionContext	createApplicationContext(String name, String loadURI, String saveURI) Deprecated. Create Application Context.
RequestState	getState() Deprecated. Get the current state of authentication
UserHandler	isAuthenticated(String handlerName) Deprecated. Is the current user authenticated for the given handler?
UserHandler	login(String handlerName, String applicationName, SourceParameters parameters) Deprecated. Try to login the user.
void	logout(String handlerName, int mode) Deprecated. Perform a logout of the user.

Field Detail

ROLE

static final String ROLE

Deprecated.

The Avalon Role

Method Detail

isAuthenticated

UserHandler isAuthenticated(String handlerName)
                            throws ProcessingException

Deprecated.

Is the current user authenticated for the given handler?

Returns:

Returns the corresponding handler if the user is authenticated.

Throws:

ProcessingException

checkAuthentication

boolean checkAuthentication(Redirector redirector,
                            String handlerName,
                            String applicationName)
                            throws ProcessingException,
                                   IOException

Deprecated.

Is the current user authenticated for the given handler? If the user is already authenticated, the RequestState is updated to the provided information (handler and application).

Throws:

ProcessingException

IOException

login

UserHandler login(String handlerName,
                  String applicationName,
                  SourceParameters parameters)
                  throws ProcessingException

Deprecated.

Try to login the user. If the authentication is successful, the user handler is returned. If not, null is returned.

Throws:

ProcessingException

logout

void logout(String handlerName,
            int mode)
            throws ProcessingException

Deprecated.

Perform a logout of the user.

Throws:

ProcessingException

getState

RequestState getState()

Deprecated.

Get the current state of authentication

createApplicationContext

SessionContext createApplicationContext(String name,
                                        String loadURI,
                                        String saveURI)
                                        throws ProcessingException

Deprecated.

Create Application Context. This context is destroyed when the user logs out of the handler

Throws:

ProcessingException