Package de.ipk_gatersleben.bit.bi.edal.primary_data.login

Class UserLoginModule

  • All Implemented Interfaces:
    javax.security.auth.spi.LoginModule
    public class UserLoginModule
extends java.lang.Object
implements javax.security.auth.spi.LoginModule
    This sample LoginModule authenticates users with a password. This LoginModule only recognizes one user: testUser testUser's password is: testPassword If testUser successfully authenticates itself, a SamplePrincipal with the testUser's user name is added to the Subject. This LoginModule recognizes the debug option. If set to true in the login Configuration, debug messages will be output to the output stream, System.out.

    • Constructor Summary

      Constructors 
      Constructor Description
      UserLoginModule()  

    • Method Summary

      Modifier and Type Method Description
      boolean abort()
      This method is called if the LoginContext's overall authentication failed.
      boolean commit()
      This method is called if the LoginContext's overall authentication succeeded (the relevant REQUIRED, REQUISITE, SUFFICIENT and OPTIONAL LoginModules succeeded).
      java.util.Map<java.lang.String,​?> getOptions()  
      java.util.Map<java.lang.String,​?> getSharedState()  
      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)
      Initialize this LoginModule.
      boolean login()
      Authenticate the user by prompting for a user name and password.
      boolean logout()
      Logout the user.
      void setOptions​(java.util.Map<java.lang.String,​?> options)  
      void setSharedState​(java.util.Map<java.lang.String,​?> sharedState)  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • UserLoginModule

        public UserLoginModule()

    • 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)
        Initialize this LoginModule.
        Specified by:
        initialize in interface javax.security.auth.spi.LoginModule
        Parameters:
        subject - the Subject to be authenticated.
        callbackHandler - a CallbackHandler for communicating with the end user (prompting for user names and passwords, for example).
        sharedState - shared LoginModule state.
        options - options specified in the login Configuration for this particular LoginModule.

      • login

        public boolean login()
              throws javax.security.auth.login.LoginException
        Authenticate the user by prompting for a user name and password.
        Specified by:
        login in interface javax.security.auth.spi.LoginModule
        Returns:
        true in all cases since this LoginModule should not be ignored.
        Throws:
        javax.security.auth.login.FailedLoginException - if the authentication fails.
        javax.security.auth.login.LoginException - if this LoginModule is unable to perform the authentication.

      • commit

        public boolean commit()
               throws javax.security.auth.login.LoginException
        This method is called if the LoginContext's overall authentication succeeded (the relevant REQUIRED, REQUISITE, SUFFICIENT and OPTIONAL LoginModules succeeded). If this LoginModule's own authentication attempt succeeded (checked by retrieving the private state saved by the login method), then this method associates a SamplePrincipal with the Subject located in the LoginModule. If this LoginModule's own authentication attempted failed, then this method removes any state that was originally saved.
        Specified by:
        commit in interface javax.security.auth.spi.LoginModule
        Returns:
        true if this LoginModule's own login and commit attempts succeeded, or false otherwise.
        Throws:
        javax.security.auth.login.LoginException - if the commit fails.

      • abort

        public boolean abort()
              throws javax.security.auth.login.LoginException
        This method is called if the LoginContext's overall authentication failed. (the relevant REQUIRED, REQUISITE, SUFFICIENT and OPTIONAL LoginModules did not succeed). If this LoginModule's own authentication attempt succeeded (checked by retrieving the private state saved by the login and commit methods), then this method cleans up any state that was originally saved.
        Specified by:
        abort in interface javax.security.auth.spi.LoginModule
        Returns:
        false if this LoginModule's own login and/or commit attempts failed, and true otherwise.
        Throws:
        javax.security.auth.login.LoginException - if the abort fails.

      • logout

        public boolean logout()
               throws javax.security.auth.login.LoginException
        Logout the user. This method removes the SamplePrincipal that was added by the commit method.
        Specified by:
        logout in interface javax.security.auth.spi.LoginModule
        Returns:
        true in all cases since this LoginModule should not be ignored.
        Throws:
        javax.security.auth.login.LoginException - if the logout fails.

      • getSharedState

        public java.util.Map<java.lang.String,​?> getSharedState()
        Returns:
        the sharedState

      • setSharedState

        public void setSharedState​(java.util.Map<java.lang.String,​?> sharedState)
        Parameters:
        sharedState - the sharedState to set

      • getOptions

        public java.util.Map<java.lang.String,​?> getOptions()
        Returns:
        the options

      • setOptions

        public void setOptions​(java.util.Map<java.lang.String,​?> options)
        Parameters:
        options - the options to set