Package org.eclipse.equinox.security.auth

Interface ILoginContext

public interface ILoginContext
The ILoginContext is the central entry point for the authentication support. Use it to perform login, logout, and retrieve information associated with the security subject.

This interface is not intended to be implemented by clients.

Restriction:
This interface is not intended to be implemented by clients.

  • Method Details

    • login

      void login() throws LoginException
      Call this method to perform a login.
      Throws:
      LoginException - if the authentication fails.
      See Also:

    • logout

      void logout() throws LoginException
      Call this method to perform a logout.
      Throws:
      LoginException - if the logout fails.
      See Also:

    • getSubject

      Subject getSubject() throws LoginException
      Retrieves the current Subject. Calling this method will force a login to occur if the user is not already logged in.
      Returns:
      the Subject
      Throws:
      LoginException
      See Also:

    • registerListener

      void registerListener(ILoginContextListener listener)
      Adds listener to be notified on security-related events.
      Parameters:
      listener - the listener to be registered
      See Also:

    • unregisterListener

      void unregisterListener(ILoginContextListener listener)
      Removes listener previously registered to receive notifications on security-related events.
      Parameters:
      listener - the listener to be unregistered
      See Also:

    • getLoginContext

      LoginContext getLoginContext() throws LoginException
      The method exposes underlying JAAS LoginContext.

      Using the LoginContext directly will bypass some of the processing offered by this interface and should be used only when other methods are not sufficient.

      Returns:
      the underlying JAAS LoginContext
      Throws:
      LoginException - if exception was encountered while creating LoginContext