Interface IAuthManager

    • Field Detail

      • CRED_SSL_CLIENT_CERT

        static final java.lang.String CRED_SSL_CLIENT_CERT
        See Also:
        Constant Field Values
      • CRED_CMC_SIGNING_CERT

        static final java.lang.String CRED_CMC_SIGNING_CERT
        See Also:
        Constant Field Values
      • CRED_CMC_SELF_SIGNED

        static final java.lang.String CRED_CMC_SELF_SIGNED
        See Also:
        Constant Field Values
      • CRED_CERT_SERIAL_TO_REVOKE

        static final java.lang.String CRED_CERT_SERIAL_TO_REVOKE
        Standard credential for client cert's serial number from revocation.
        See Also:
        Constant Field Values
    • Method Detail

      • getName

        java.lang.String getName()
        Get the name of this authentication manager instance.

        Returns:
        the name of this authentication manager.
      • getImplName

        java.lang.String getImplName()
        Get name of authentication manager plugin.

        Returns:
        the name of the authentication manager plugin.
      • init

        void init​(java.lang.String name,
                  java.lang.String implName,
                  AuthManagerConfig config)
           throws EBaseException
        Initialize this authentication manager.
        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.
      • shutdown

        void shutdown()
        Prepare this authentication manager for a shutdown. Called when the server is exiting for any cleanup needed.
      • getRequiredCreds

        java.lang.String[] getRequiredCreds()
        Gets a list of the required credentials for this authentication manager.
        Returns:
        The required credential attributes.
      • getConfigParams

        java.lang.String[] getConfigParams()
                                    throws EBaseException
        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.
        Returns:
        a list of configuration parameters.
        Throws:
        EBaseException - If an internal error occurred
      • getConfigStore

        AuthManagerConfig getConfigStore()
        Get the configuration store for this authentication manager.
        Returns:
        The configuration store of this authentication manager.