com.jalios.jcms.authentication.handlers
Class LoggingAuthenticationHandler

java.lang.Object
  extended by com.jalios.jcms.authentication.AuthenticationHandler
      extended by com.jalios.jcms.authentication.handlers.LoggingAuthenticationHandler
All Implemented Interfaces:
PluginComponent, Comparable<AuthenticationHandler>

public final class LoggingAuthenticationHandler
extends AuthenticationHandler

Provide logging of the authentication process using log4j.
This authentication handler must be the first in the list of authentication handlers to be able to log authentication made by other handlers.

Since:
jcms-5.7.0
Version:
$Revision: 37672 $
Author:
Olivier Jaquemet

Field Summary
static int ORDER_LOGGING_HANDLER
          Order used by the LoggingAuthenticationHandler
static String REVISION
           
 
Fields inherited from class com.jalios.jcms.authentication.AuthenticationHandler
channel, GENERIC_BAD_AUTHENTICATION_MSG
 
Method Summary
static LoggingAuthenticationHandler getInstance()
           
 void login(AuthenticationContext ctxt)
          Authenticate a member.
 void logout(AuthenticationContext ctxt)
          This methods is called when users logout from JCMS.
 
Methods inherited from class com.jalios.jcms.authentication.AuthenticationHandler
compareTo, equals, getOrder, init, loadProperties, 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_LOGGING_HANDLER

public static final int ORDER_LOGGING_HANDLER
Order used by the LoggingAuthenticationHandler

See Also:
Constant Field Values
Method Detail

getInstance

public static final LoggingAuthenticationHandler getInstance()

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

logout

public void logout(AuthenticationContext ctxt)
            throws IOException
Description copied from class: AuthenticationHandler
This methods is called when users logout from JCMS.
It may not be called if user simply close its browser. Don't rely on this for critical operation

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

Overrides:
logout in class AuthenticationHandler
Parameters:
ctxt - the AuthenticationContext used for this login
Throws:
IOException


Copyright © 2001-2010 Jalios SA. All Rights Reserved.