Class TokenAuthentication

    • Field Detail

      • logger

        public static org.slf4j.Logger logger
      • mRequiredCreds

        protected java.lang.String[] mRequiredCreds
      • mConfigParams

        protected static java.lang.String[] mConfigParams
    • Constructor Detail

      • TokenAuthentication

        public TokenAuthentication()
    • Method Detail

      • init

        public void init​(java.lang.String name,
                         java.lang.String implName,
                         AuthManagerConfig config)
                  throws EBaseException
        initializes the TokenAuthentication auth manager

        called by AuthSubsystem init() method, when initializing all available authentication managers.

        Specified by:
        init in interface IAuthManager
        Parameters:
        name - 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 java.lang.String getName()
        Gets the name of this authentication manager.
        Specified by:
        getName in interface IAuthManager
        Returns:
        the name of this authentication manager.
      • getImplName

        public java.lang.String getImplName()
        Gets the plugin name of authentication manager.
        Specified by:
        getImplName in interface IAuthManager
        Returns:
        the name of the authentication manager plugin.
      • getRequiredCreds

        public java.lang.String[] getRequiredCreds()
        get the list of authentication credential attribute names required by this authentication manager. Generally used by the servlets that handle agent operations to authenticate its users. It calls this method to know which are the required credentials from the user (e.g. Javascript form data)
        Specified by:
        getRequiredCreds in interface IAuthManager
        Returns:
        attribute names in Vector
      • getConfigParams

        public java.lang.String[] getConfigParams()
        get the list of configuration parameter names required by this authentication manager. Generally used by the Certificate Server Console to display the table for configuration purposes. CertUserDBAuthentication is currently not exposed in this case, so this method is not to be used.
        Specified by:
        getConfigParams in interface IAuthManager
        Returns:
        configuration parameter names in Hashtable of Vectors where each hashtable entry's key is the substore name, value is a Vector of parameter names. If no substore, the parameter name is the Hashtable key itself, with value same as key.
      • shutdown

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

        public java.lang.String getName​(java.util.Locale locale)
        Retrieves the localizable name of this policy.
        Specified by:
        getName in interface IProfileAuthenticator
        Parameters:
        locale - end user locale
        Returns:
        localized authenticator name
      • getText

        public java.lang.String getText​(java.util.Locale locale)
        Retrieves the localizable description of this policy.
        Specified by:
        getText in interface IProfileAuthenticator
        Parameters:
        locale - end user locale
        Returns:
        localized authenticator description
      • getValueNames

        public java.util.Enumeration<java.lang.String> getValueNames()
        Retrieves a list of names of the value parameter.
        Specified by:
        getValueNames in interface IProfileAuthenticator
        Returns:
        a list of property names
      • isValueWriteable

        public boolean isValueWriteable​(java.lang.String name)
        Description copied from interface: IProfileAuthenticator
        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 IProfileAuthenticator
        Parameters:
        name - property name
        Returns:
        true if the property is not security related
      • getValueDescriptor

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