Interface ILoginContextListener


  • public interface ILoginContextListener
    This is a common interface that tags a class that can be registered as a listener for security events.

    This interface is not intended to be implemented or extended by clients.

    See Also:
    ILoginContextListener
    Restriction:
    This interface is not intended to be implemented by clients.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void onLoginFinish​(javax.security.auth.Subject subject, javax.security.auth.login.LoginException loginException)
      This method is called after login sequence is finished.
      void onLoginStart​(javax.security.auth.Subject subject)
      This method is called before login starts.
      void onLogoutFinish​(javax.security.auth.Subject subject, javax.security.auth.login.LoginException logoutException)
      This method is called after logout sequence finishes.
      void onLogoutStart​(javax.security.auth.Subject subject)
      This method is called before logout starts.
    • Method Detail

      • onLoginStart

        void onLoginStart​(javax.security.auth.Subject subject)
        This method is called before login starts.
        Parameters:
        subject - the subject being authenticated, might be null if there is no subject associated the context at this time
      • onLoginFinish

        void onLoginFinish​(javax.security.auth.Subject subject,
                           javax.security.auth.login.LoginException loginException)
        This method is called after login sequence is finished. If login exception is not null, the login failed.
        Parameters:
        subject - the subject being authenticated, might be null if there is no subject associated the context at this time
        loginException - null if login succeeded, otherwise contains exception caused login to fail
      • onLogoutStart

        void onLogoutStart​(javax.security.auth.Subject subject)
        This method is called before logout starts.
        Parameters:
        subject - the authenticated subject, might be null if there is no subject associated the context at this time
      • onLogoutFinish

        void onLogoutFinish​(javax.security.auth.Subject subject,
                            javax.security.auth.login.LoginException logoutException)
        This method is called after logout sequence finishes. If logout exception is not null, the logout failed.
        Parameters:
        subject - the authenticated subject, might be null if there is no subject associated the context at this time
        logoutException - null if logout succeeded, otherwise contains exception caused logout to fail