com.sun.identity.authentication.jaas

Class LoginContext

java.lang.Object

com.sun.identity.authentication.jaas.LoginContext

All Implemented Interfaces:

LoginContext

public class LoginContext
extends Object
implements LoginContext

This class is pulled out from JDK1.4. Removed doPrivileged() on invoke() method so that Error and Runtime exceptions can be passed back to the caller. Otherwise any exception is converted to LoginException.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LoginContext.ModuleInfo LoginModule information - encapsulates Configuration info and actual module instances.

Constructor Summary

Constructors

Constructor and Description
LoginContext(AppConfigurationEntry[] entries, CallbackHandler callbackHandler)
LoginContext(AppConfigurationEntry[] entries, Subject subject, CallbackHandler callbackHandler)

Method Summary

Modifier and Type	Method and Description
List<String>	getModuleInstanceNames() Returns module instance names list
LoginContext.ModuleInfo[]	getModuleStack()
LinkedList<LoginContext.ModuleInfo>	getModuleStackQueue()
LoginException	getOptionalException()
LoginException	getRequiredException()
Subject	getSubject() Return the authenticated Subject.
void	login() Perform the authentication.
void	logout() Logout the Subject.
void	resetAuthChainToModule(int moduleIndex) Resets auth chain to particular module, auth chain starts with this module
void	setModuleStackQueue(LinkedList<LoginContext.ModuleInfo> moduleStackQueue)
void	setNextModule(int moduleIndex) Sets next module by module index in chain, allows to modify auth chain during auth
void	setNextModule(String moduleName) Sets next module by module name, allows to modify auth chain during auth

Methods inherited from class java.lang.Object

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

Constructor Detail

LoginContext

public LoginContext(AppConfigurationEntry[] entries,
                    CallbackHandler callbackHandler)
             throws LoginException

Throws:

LoginException

LoginContext

public LoginContext(AppConfigurationEntry[] entries,
                    Subject subject,
                    CallbackHandler callbackHandler)
             throws LoginException

Throws:

LoginException

Method Detail

login

public void login()
           throws LoginException

Description copied from interface: LoginContext

Perform the authentication.

Specified by:

login in interface LoginContext

Throws:

LoginException - if the authentication fails.

logout

public void logout()
            throws LoginException

Description copied from interface: LoginContext

Logout the Subject.

Specified by:

logout in interface LoginContext

Throws:

LoginException - if the logout fails.

getModuleStack

public LoginContext.ModuleInfo[] getModuleStack()

getSubject

public Subject getSubject()

Description copied from interface: LoginContext

Return the authenticated Subject.

Specified by:

getSubject in interface LoginContext

Returns:

the authenticated subject.

setNextModule

public void setNextModule(String moduleName)

Sets next module by module name, allows to modify auth chain during auth

Parameters:

moduleName -

setNextModule

public void setNextModule(int moduleIndex)

Sets next module by module index in chain, allows to modify auth chain during auth

Parameters:

moduleName -

getModuleInstanceNames

public List<String> getModuleInstanceNames()

Returns module instance names list

Returns:

module instance names list

resetAuthChainToModule

public void resetAuthChainToModule(int moduleIndex)
                            throws ResetAuthChainException

Resets auth chain to particular module, auth chain starts with this module

Parameters:

moduleIndex - index of module

Throws:

ResetAuthChainException

getRequiredException

public LoginException getRequiredException()

getOptionalException

public LoginException getOptionalException()

getModuleStackQueue

public LinkedList<LoginContext.ModuleInfo> getModuleStackQueue()

setModuleStackQueue

public void setModuleStackQueue(LinkedList<LoginContext.ModuleInfo> moduleStackQueue)