Eclipse Plug-in Developer Guide (Galileo) - ILoginContext (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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 Summary

LoginContext getLoginContext ()
          The method exposes underlying JAAS LoginContext.

Subject getSubject ()
          Retrieves the current Subject.

void login ()
          Call this method to perform a login.

void logout ()
          Call this method to perform a logout.

void registerListener ( ILoginContextListener listener)
          Adds listener to be notified on security-related events.

void unregisterListener ( ILoginContextListener listener)
          Removes listener previously registered to receive notifications on security-related events.

Method Detail

login

void login()
           throws 
LoginException

Call this method to perform a login.

Throws:: LoginException
See Also:: LoginContext.login()

logout

void logout()
            throws 
LoginException

Call this method to perform a logout.

Throws:: LoginException
See Also:: LoginContext.logout()

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:: LoginContext.getSubject()

registerListener

void registerListener(
ILoginContextListener listener)

Adds listener to be notified on security-related events.

Parameters:: listener - the listener to be registered
See Also:: ILoginContextListener

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:: ILoginContextListener

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.