Class SessionAuthentication

java.lang.Object
com.netscape.cms.authentication.SessionAuthentication
All Implemented Interfaces:
ProfileAuthenticator, AuthManager
public class SessionAuthentication extends Object implements ProfileAuthenticator
Pull any existing auth token from the session context. Use with caution as a profile authenticator; if there is a session it will unconditionally approve the request (subject to constraints, etc).

  • Constructor Details

    • SessionAuthentication

      public SessionAuthentication()

  • Method Details

    • init

      public void init(String instName, String implName, AuthManagerConfig config) throws EBaseException
      Description copied from interface: AuthManager
      Initialize this authentication manager.
      Specified by:
      init in interface AuthManager
      Parameters:
      instName - The name of this authentication manager instance.
      implName - The name of the authentication manager plugin.
      config - The configuration store for this authentication manager.
      Throws:
      EBaseException - If an initialization error occurred.

    • getName

      public String getName()
      Gets the name of this authentication manager.
      Specified by:
      getName in interface AuthManager
      Returns:
      the name of this authentication manager.

    • getImplName

      public String getImplName()
      Gets the plugin name of authentication manager.
      Specified by:
      getImplName in interface AuthManager
      Returns:
      the name of the authentication manager plugin.

    • isSSLClientRequired

      public boolean isSSLClientRequired()
      Description copied from interface: ProfileAuthenticator
      Checks if this authenticator requires SSL client authentication.
      Specified by:
      isSSLClientRequired in interface ProfileAuthenticator
      Returns:
      client authentication required or not

    • authenticate

      public IAuthToken authenticate(IAuthCredentials authCred) throws EMissingCredential
      Authenticate user.
      Specified by:
      authenticate in interface AuthManager
      Parameters:
      authCred - The authentication credentials
      Returns:
      the auth token from existing session context, if any.
      Throws:
      EMissingCredential - if no auth token or no session

    • getRequiredCreds

      public String[] getRequiredCreds()
      Description copied from interface: AuthManager
      Gets a list of the required credentials for this authentication manager.
      Specified by:
      getRequiredCreds in interface AuthManager
      Returns:
      The required credential attributes.

    • getConfigParams

      public String[] getConfigParams()
      Description copied from interface: AuthManager
      Get configuration parameters for this implementation. The configuration parameters returned is passed to the configuration console so configuration for instances of this implementation can be made through the console.
      Specified by:
      getConfigParams in interface AuthManager
      Returns:
      a list of configuration parameters.

    • shutdown

      public void shutdown()
      prepare this authentication manager for shutdown.
      Specified by:
      shutdown in interface AuthManager

    • getConfigStore

      public AuthManagerConfig getConfigStore()
      gets the configuretion substore used by this authentication manager
      Specified by:
      getConfigStore in interface AuthManager
      Specified by:
      getConfigStore in interface ProfileAuthenticator
      Returns:
      configuration store

    • init

      public void init(Profile profile, IConfigStore config)
      Description copied from interface: ProfileAuthenticator
      Initializes this default policy.
      Specified by:
      init in interface ProfileAuthenticator
      Parameters:
      profile - owner of this authenticator
      config - configuration store

    • getName

      public String getName(Locale locale)
      Retrieves the localizable name of this policy.
      Specified by:
      getName in interface ProfileAuthenticator
      Parameters:
      locale - end user locale
      Returns:
      localized authenticator name

    • getText

      public String getText(Locale locale)
      Retrieves the localizable description of this policy.
      Specified by:
      getText in interface ProfileAuthenticator
      Parameters:
      locale - end user locale
      Returns:
      localized authenticator description

    • getValueNames

      public Enumeration<String> getValueNames()
      Retrieves a list of names of the value parameter.
      Specified by:
      getValueNames in interface ProfileAuthenticator
      Returns:
      a list of property names

    • isValueWriteable

      public boolean isValueWriteable(String name)
      Description copied from interface: ProfileAuthenticator
      Checks if the value of the given property should be serializable into the request. Passsword or other security-related value may not be desirable for storage.
      Specified by:
      isValueWriteable in interface ProfileAuthenticator
      Parameters:
      name - property name
      Returns:
      true if the property is not security related

    • getValueDescriptor

      public IDescriptor getValueDescriptor(Locale locale, String name)
      Retrieves the descriptor of the given value parameter by name.
      Specified by:
      getValueDescriptor in interface ProfileAuthenticator
      Parameters:
      locale - user locale
      name - property name
      Returns:
      descriptor of the requested property

    • populate

      public void populate(IAuthToken token, IRequest request)
      Description copied from interface: ProfileAuthenticator
      Populates authentication specific information into the request for auditing purposes.
      Specified by:
      populate in interface ProfileAuthenticator
      Parameters:
      token - authentication token
      request - request