Package org.eclipse.equinox.security.auth.module

Class ExtensionLoginModule

  • All Implemented Interfaces:
    javax.security.auth.spi.LoginModule
    public final class ExtensionLoginModule
extends java.lang.Object
implements javax.security.auth.spi.LoginModule
    This class allows login modules specified via loginModule extension point to be included in the login configurations.

    To include your login module in a login configuration, specify this class as a login module using its qualified Java name. Options specified for such entry should contain an option named extensionId set to the qualified ID of the extension describing your login module.

    This class should not be extended or instantiated directly.

    Restriction:
    This class is not intended to be instantiated by clients.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String OPTION_MODULE_POINT
      The key for the option that specifies an extension describing the actual login module

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean abort()  
      boolean commit()  
      void initialize​(javax.security.auth.Subject subject, javax.security.auth.callback.CallbackHandler callbackHandler, java.util.Map<java.lang.String,​?> sharedState, java.util.Map<java.lang.String,​?> options)  
      boolean login()  
      boolean logout()  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • OPTION_MODULE_POINT

        public static final java.lang.String OPTION_MODULE_POINT
        The key for the option that specifies an extension describing the actual login module
        See Also:
        Constant Field Values

    • Constructor Detail

      • ExtensionLoginModule

        public ExtensionLoginModule()
        Constructor

    • Method Detail

      • initialize

        public void initialize​(javax.security.auth.Subject subject,
                       javax.security.auth.callback.CallbackHandler callbackHandler,
                       java.util.Map<java.lang.String,​?> sharedState,
                       java.util.Map<java.lang.String,​?> options)
        Specified by:
        initialize in interface javax.security.auth.spi.LoginModule

      • login

        public boolean login()
              throws javax.security.auth.login.LoginException
        Specified by:
        login in interface javax.security.auth.spi.LoginModule
        Throws:
        javax.security.auth.login.LoginException

      • commit

        public boolean commit()
               throws javax.security.auth.login.LoginException
        Specified by:
        commit in interface javax.security.auth.spi.LoginModule
        Throws:
        javax.security.auth.login.LoginException

      • abort

        public boolean abort()
              throws javax.security.auth.login.LoginException
        Specified by:
        abort in interface javax.security.auth.spi.LoginModule
        Throws:
        javax.security.auth.login.LoginException

      • logout

        public boolean logout()
               throws javax.security.auth.login.LoginException
        Specified by:
        logout in interface javax.security.auth.spi.LoginModule
        Throws:
        javax.security.auth.login.LoginException