com.jalios.jcms.authentication.handlers
Class SessionAuthenticationHandler

java.lang.Object
  com.jalios.jcms.authentication.AuthenticationHandler
      com.jalios.jcms.authentication.handlers.SessionAuthenticationHandler

All Implemented Interfaces:

PluginComponent, Comparable<AuthenticationHandler>

public class SessionAuthenticationHandler
extends AuthenticationHandler

Save authentification made by other handlers into session and use it later on to re-authenticate.

Since:

jcms-5.7.0

Version:

$Revision: 37782 $

Author:

Olivier Jaquemet

Field Summary

static int	ORDER_SESSION_HANDLER Order used by the SessionAuthenticationHandler
static String	REVISION

Fields inherited from class com.jalios.jcms.authentication.AuthenticationHandler

channel, GENERIC_BAD_AUTHENTICATION_MSG

Method Summary

static Member	checkAuthenticationFromSession(javax.servlet.http.HttpServletRequest request) Returns the member corresponding to the information specified in the session.
static SessionAuthenticationHandler	getInstance()
void	loadProperties() This method will be called by the AuthenticationManager each time the Channel properties are loaded/reloaded. You can use it to reload properties that might have been changed. This method is called during initialization of the AuthenticationManager
void	login(AuthenticationContext ctxt) Authenticate a member.
static void	storeSessionAuthentication(javax.servlet.http.HttpServletRequest request, Member loggedMember) Store the given logged Member into the session for future authentication.

Methods inherited from class com.jalios.jcms.authentication.AuthenticationHandler

compareTo, equals, getOrder, init, logout, setOrder

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

REVISION

public static final String REVISION

See Also:

Constant Field Values

ORDER_SESSION_HANDLER

public static final int ORDER_SESSION_HANDLER

Order used by the SessionAuthenticationHandler

See Also:

Constant Field Values

Method Detail

getInstance

public static final SessionAuthenticationHandler getInstance()

loadProperties

public void loadProperties()

Description copied from class: AuthenticationHandler

This method will be called by the AuthenticationManager each time the Channel properties are loaded/reloaded.
You can use it to reload properties that might have been changed.
This method is called during initialization of the AuthenticationManager

Overrides:

loadProperties in class AuthenticationHandler

login

public void login(AuthenticationContext ctxt)
           throws IOException

Description copied from class: AuthenticationHandler

Authenticate a member.
This method is invoked by the authentication chain on each request.
A typical implementation of this method would follow the following pattern :

1. Examine informations required to perform the authentication through the AuthenticationContext object (request, response, login.. etc)
2. Perform your authentication before chain invokation and set the logged Member AuthenticationContext.setLoggedMember(com.jalios.jcms.Member)
3. a) Either invoke the next entity in the chain using AuthenticationContext.doChain(),
4. b) or else skip the chain invokation and block other authentication handler of the chain (do this with caution...)
5. Perform redirection, set information/warning/error message or any other process, after chain invokation, using AuthenticationContext.

Default implementation is to invoke the next handler in the chain.

Overrides:

login in class AuthenticationHandler

Parameters:

ctxt - the AuthenticationContext used for this login

Throws:

IOException

checkAuthenticationFromSession

public static final Member checkAuthenticationFromSession(javax.servlet.http.HttpServletRequest request)

Returns the member corresponding to the information specified in the session. ("loggedMemberId" attribute).

Parameters:

request - the request where to look for silent params

Returns:

the authenticated member or null if not found

Since:

jcms-5.7.0

storeSessionAuthentication

public static final void storeSessionAuthentication(javax.servlet.http.HttpServletRequest request,
                                                    Member loggedMember)

Store the given logged Member into the session for future authentication.

Parameters:

request - the current HttpServletRequest

loggedMember - the Member newly logged in

Since:

jcms-5.7.0