Class AbstractLoginModule

java.lang.Object

org.eclipse.jetty.security.jaas.spi.AbstractLoginModule

All Implemented Interfaces:

LoginModule

Direct Known Subclasses:

AbstractDatabaseLoginModule, LdapLoginModule, PropertyFileLoginModule

public abstract class AbstractLoginModule
extends Object
implements LoginModule

Abstract base class for all LoginModules. Subclasses should implement getUser(String) method, and subclass AbstractLoginModule.JAASUser to implement AbstractLoginModule.JAASUser.doFetchRoles() method.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractLoginModule.JAASUser

Constructor Summary

Constructors

Constructor	Description
AbstractLoginModule()

Method Summary

Modifier and Type	Method	Description
boolean	abort()
boolean	commit()
Callback[]	configureCallbacks()
CallbackHandler	getCallbackHandler()
AbstractLoginModule.JAASUser	getCurrentUser()
Subject	getSubject()
abstract AbstractLoginModule.JAASUser	getUser(String username)
void	initialize(Subject subject, CallbackHandler callbackHandler, Map<String,?> sharedState, Map<String,?> options)
boolean	isAuthenticated()
boolean	isCommitted()
boolean	isIgnored()
boolean	login()
boolean	logout()
void	setAuthenticated(boolean authState)
void	setCallbackHandler(CallbackHandler h)
void	setCommitted(boolean commitState)
void	setCurrentUser(AbstractLoginModule.JAASUser u)
void	setSubject(Subject s)

Methods inherited from class Object

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

Constructor Details

AbstractLoginModule

public AbstractLoginModule()

Method Details

getUser

public abstract AbstractLoginModule.JAASUser getUser(String username)
                                              throws Exception

Throws:

Exception

getSubject

public Subject getSubject()

setSubject

public void setSubject(Subject s)

getCurrentUser

public AbstractLoginModule.JAASUser getCurrentUser()

setCurrentUser

public void setCurrentUser(AbstractLoginModule.JAASUser u)

getCallbackHandler

public CallbackHandler getCallbackHandler()

setCallbackHandler

public void setCallbackHandler(CallbackHandler h)

isAuthenticated

public boolean isAuthenticated()

isCommitted

public boolean isCommitted()

setAuthenticated

public void setAuthenticated(boolean authState)

setCommitted

public void setCommitted(boolean commitState)

abort

public boolean abort()
              throws LoginException

Specified by:

abort in interface LoginModule

Throws:

LoginException

commit

public boolean commit()
               throws LoginException

Specified by:

commit in interface LoginModule

Returns:

true if committed, false if not (likely not authenticated)

Throws:

LoginException - if unable to commit

See Also:

• LoginModule.commit()

configureCallbacks

public Callback[] configureCallbacks()

isIgnored

public boolean isIgnored()

login

public boolean login()
              throws LoginException

Specified by:

login in interface LoginModule

Returns:

true if is authenticated, false otherwise

Throws:

LoginException - if unable to login

See Also:

• LoginModule.login()

logout

public boolean logout()
               throws LoginException

Specified by:

logout in interface LoginModule

Returns:

true always

Throws:

LoginException - if unable to logout

See Also:

• LoginModule.logout()

initialize

public void initialize(Subject subject,
 CallbackHandler callbackHandler,
 Map<String,?> sharedState,
 Map<String,?> options)

Specified by:

initialize in interface LoginModule

Parameters:

subject - the subject

callbackHandler - the callback handler

sharedState - the shared state map

options - the option map

See Also:

• LoginModule.initialize(Subject, CallbackHandler, Map, Map)