Class SilentParamsAuthenticationHandler

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

public class SilentParamsAuthenticationHandler extends AuthenticationHandler
Read the authentification from the "silent" parameter, silentLogin, silentPassword.
Since:
jcms-5.7.0
Author:
Olivier Jaquemet
  • Field Details

    • ORDER_SILENT_PARAM_HANDLER

      public static final int ORDER_SILENT_PARAM_HANDLER
      Order used by the SilentParamsAuthenticationHandler
      See Also:
  • Method Details

    • getInstance

      public static final SilentParamsAuthenticationHandler 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
    • checkAuthenticationFromSilentParams

      public static final Member checkAuthenticationFromSilentParams(javax.servlet.http.HttpServletRequest request) throws IOException
      Returns the member corresponding to the given "silent" credentials given in the request (silentLogin, silentPassword).
      Parameters:
      request - the request where to look for silent params
      Returns:
      the authenticated member or null if not found
      Throws:
      IOException - if the underneath login operation with the silentLogin/silentPassword could not be performed