Modifier and Type	Class and Description
public class	AbstractLoginModule.JAASUserInfo

Modifier and Type	Field and Description
private boolean	authState
private CallbackHandler	callbackHandler
private boolean	commitState
private AbstractLoginModule.JAASUserInfo	currentUser
private Subject	subject

Access	Constructor and Description
public	AbstractLoginModule()

Method Summary

Modifier and Type	Method and Description
public boolean	abort() Implements javax.security.auth.spi.LoginModule.abort. Method to abort the authentication process (phase 2).
public boolean	commit() Implements javax.security.auth.spi.LoginModule.commit. Method to commit the authentication process (phase 2).
public Callback[]	configureCallbacks()
public CallbackHandler	getCallbackHandler()
public AbstractLoginModule.JAASUserInfo	getCurrentUser()
public Subject	getSubject()
public abstract UserInfo	getUserInfo(String username)
public void	initialize(Subject subject, CallbackHandler callbackHandler, Map<K, V> sharedState, Map<K, V> options) Implements javax.security.auth.spi.LoginModule.initialize. Initialize this `LoginModule`.
public boolean	isAuthenticated()
public boolean	isCommitted()
public boolean	login() Implements javax.security.auth.spi.LoginModule.login. Method to authenticate a `Subject` (phase 1).
public boolean	logout() Implements javax.security.auth.spi.LoginModule.logout. Method which logs out a `Subject`.
public void	setAuthenticated(boolean authState)
public void	setCallbackHandler(CallbackHandler h)
public void	setCommitted(boolean commitState)
public void	setCurrentUser(AbstractLoginModule.JAASUserInfo u)
public void	setSubject(Subject s)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

authState	back to summary
private boolean authState

callbackHandler	back to summary
private CallbackHandler callbackHandler

commitState	back to summary
private boolean commitState

currentUser	back to summary
private AbstractLoginModule.JAASUserInfo currentUser

subject	back to summary
private Subject subject

Constructor Detail

AbstractLoginModule	back to summary
public AbstractLoginModule()

Method Detail

abort back to summary

abort	back to summary
public boolean abort() throws LoginException Implements javax.security.auth.spi.LoginModule.abort. Doc from javax.security.auth.spi.LoginModule.abort. Method to abort the authentication process (phase 2). This method is called if the LoginContext's overall authentication failed. (the relevant REQUIRED, REQUISITE, SUFFICIENT and OPTIONAL LoginModules did not succeed). If this LoginModule's own authentication attempt succeeded (checked by retrieving the private state saved by the `login` method), then this method cleans up any state that was originally saved. Returns:boolean `true` if this method succeeded, or `false` if this `LoginModule` should be ignored. Exceptions LoginException: if the abort fails See Also `javax.security.auth.spi.LoginModule#abort()`

public boolean abort() throws LoginException

Implements javax.security.auth.spi.LoginModule.abort.

Doc from javax.security.auth.spi.LoginModule.abort.

Method to abort the authentication process (phase 2).

This method is called if the LoginContext's overall authentication failed. (the relevant REQUIRED, REQUISITE, SUFFICIENT and OPTIONAL LoginModules did not succeed).

If this LoginModule's own authentication attempt succeeded (checked by retrieving the private state saved by the login method), then this method cleans up any state that was originally saved.

Returns:boolean

true if this method succeeded, or false if this LoginModule should be ignored.

Exceptions

LoginException:: if the abort fails

commit back to summary

commit	back to summary
public boolean commit() throws LoginException Implements javax.security.auth.spi.LoginModule.commit. Doc from javax.security.auth.spi.LoginModule.commit. Method to commit the authentication process (phase 2). This method is called if the LoginContext's overall authentication succeeded (the relevant REQUIRED, REQUISITE, SUFFICIENT and OPTIONAL LoginModules succeeded). If this LoginModule's own authentication attempt succeeded (checked by retrieving the private state saved by the `login` method), then this method associates relevant Principals and Credentials with the `Subject` located in the `LoginModule`. If this LoginModule's own authentication attempted failed, then this method removes/destroys any state that was originally saved. Exceptions LoginException: if the commit fails See Also `javax.security.auth.spi.LoginModule#commit()`

public boolean commit() throws LoginException

Implements javax.security.auth.spi.LoginModule.commit.

Doc from javax.security.auth.spi.LoginModule.commit.

Method to commit the authentication process (phase 2).

This method is called if the LoginContext's overall authentication succeeded (the relevant REQUIRED, REQUISITE, SUFFICIENT and OPTIONAL LoginModules succeeded).

If this LoginModule's own authentication attempt succeeded (checked by retrieving the private state saved by the login method), then this method associates relevant Principals and Credentials with the Subject located in the LoginModule. If this LoginModule's own authentication attempted failed, then this method removes/destroys any state that was originally saved.

Exceptions

LoginException:: if the commit fails

configureCallbacks	back to summary
public Callback[] configureCallbacks()

getCallbackHandler	back to summary
public CallbackHandler getCallbackHandler()

getCurrentUser	back to summary
public AbstractLoginModule.JAASUserInfo getCurrentUser()

getSubject	back to summary
public Subject getSubject()

getUserInfo	back to summary
public abstract UserInfo getUserInfo(String username) throws Exception

initialize back to summary

initialize	back to summary
public void initialize(Subject subject, CallbackHandler callbackHandler, Map<K, V> sharedState, Map<K, V> options) Implements javax.security.auth.spi.LoginModule.initialize. Doc from javax.security.auth.spi.LoginModule.initialize. Initialize this `LoginModule`. This method is called by the `LoginContext` after this `LoginModule` has been instantiated. The purpose of this method is to initialize this `LoginModule` with the relevant information. If this `LoginModule` does not understand any of the data stored in `sharedState` or `options` parameters, they can be ignored. See Also `javax.security.auth.spi.LoginModule#initialize(javax.security.auth.Subject, javax.security.auth.callback.CallbackHandler, java.util.Map, java.util.Map)`

public void initialize(Subject subject, CallbackHandler callbackHandler, Map<K, V> sharedState, Map<K, V> options)

Implements javax.security.auth.spi.LoginModule.initialize.

Doc from javax.security.auth.spi.LoginModule.initialize.

Initialize this LoginModule.

This method is called by the LoginContext after this LoginModule has been instantiated. The purpose of this method is to initialize this LoginModule with the relevant information. If this LoginModule does not understand any of the data stored in sharedState or options parameters, they can be ignored.

See Also: javax.security.auth.spi.LoginModule#initialize(javax.security.auth.Subject, javax.security.auth.callback.CallbackHandler, java.util.Map, java.util.Map)

isAuthenticated	back to summary
public boolean isAuthenticated()

isCommitted	back to summary
public boolean isCommitted()

login	back to summary
public boolean login() throws LoginException Implements javax.security.auth.spi.LoginModule.login. Doc from javax.security.auth.spi.LoginModule.login. Method to authenticate a `Subject` (phase 1). The implementation of this method authenticates a `Subject`. For example, it may prompt for `Subject` information such as a username and password and then attempt to verify the password. This method saves the result of the authentication attempt as private state within the `LoginModule`. Exceptions LoginException: if the authentication fails See Also `javax.security.auth.spi.LoginModule#login()`

public boolean login() throws LoginException

Implements javax.security.auth.spi.LoginModule.login.

Doc from javax.security.auth.spi.LoginModule.login.

Method to authenticate a Subject (phase 1).

The implementation of this method authenticates a Subject. For example, it may prompt for Subject information such as a username and password and then attempt to verify the password. This method saves the result of the authentication attempt as private state within the LoginModule.

Exceptions

LoginException:: if the authentication fails

logout back to summary

logout	back to summary
public boolean logout() throws LoginException Implements javax.security.auth.spi.LoginModule.logout. Doc from javax.security.auth.spi.LoginModule.logout. Method which logs out a `Subject`. An implementation of this method might remove/destroy a Subject's Principals and Credentials. Exceptions LoginException: if the logout fails See Also `javax.security.auth.spi.LoginModule#logout()`

public boolean logout() throws LoginException

Implements javax.security.auth.spi.LoginModule.logout.

Doc from javax.security.auth.spi.LoginModule.logout.

Method which logs out a Subject.

An implementation of this method might remove/destroy a Subject's Principals and Credentials.

Exceptions

LoginException:: if the logout fails

setAuthenticated	back to summary
public void setAuthenticated(boolean authState)

setCallbackHandler	back to summary
public void setCallbackHandler(CallbackHandler h)

setCommitted	back to summary
public void setCommitted(boolean commitState)

setCurrentUser	back to summary
public void setCurrentUser(AbstractLoginModule.JAASUserInfo u)

setSubject	back to summary
public void setSubject(Subject s)

org.mortbay.jetty.plus.jaas.spi back to summary

public Class AbstractLoginModule.JAASUserInfo

Class Inheritance

extends Object

java.lang.Object
org.mortbay.jetty.plus.jaas.spi.AbstractLoginModule.JAASUserInfo

Field Summary

Modifier and Type	Field and Description
private Principal	principal
private List<E>	roles
private UserInfo	user

Constructor Summary

Access	Constructor and Description
public	JAASUserInfo(UserInfo u)

Method Summary

Modifier and Type	Method and Description
public boolean	checkCredential(Object suppliedCredential)
public Principal	getPrincipal()
public String	getUserName()
public void	setJAASInfo(Subject subject)
public void	setUserInfo(UserInfo u)
public void	unsetJAASInfo(Subject subject)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

principal	back to summary
private Principal principal

roles	back to summary
private List<E> roles

user	back to summary
private UserInfo user

Constructor Detail

JAASUserInfo	back to summary
public JAASUserInfo(UserInfo u)

Method Detail

checkCredential	back to summary
public boolean checkCredential(Object suppliedCredential)

getPrincipal	back to summary
public Principal getPrincipal()

getUserName	back to summary
public String getUserName()

setJAASInfo	back to summary
public void setJAASInfo(Subject subject)

setUserInfo	back to summary
public void setUserInfo(UserInfo u)

unsetJAASInfo	back to summary
public void unsetJAASInfo(Subject subject)

public abstract Class AbstractLoginModule

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class AbstractLoginModule.JAASUserInfo

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail