Modifier and Type	Class and Description
public abstract static class	AbstractLoginModule.JAASUser

Modifier and Type	Field and Description
private boolean	authState
private CallbackHandler	callbackHandler
private boolean	commitState
private AbstractLoginModule.JAASUser	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	Returns: true if committed, false if not (likely not authenticated) commit() Implements javax.security.auth.spi.LoginModule.commit. Method to commit the authentication process (phase 2).
public Callback[]	configureCallbacks()
public CallbackHandler	getCallbackHandler()
public AbstractLoginModule.JAASUser	getCurrentUser()
public Subject	getSubject()
public abstract AbstractLoginModule.JAASUser	getUser(String username)
public void	initialize(Subject the subject subject, CallbackHandler the callback handler callbackHandler, Map<String, ?> the shared state map sharedState, Map<String, ?> the option map options) Implements javax.security.auth.spi.LoginModule.initialize. Initialize this `LoginModule`.
public boolean	isAuthenticated()
public boolean	isCommitted()
public boolean	isIgnored()
public boolean	Returns: true if is authenticated, false otherwise login() Implements javax.security.auth.spi.LoginModule.login. Method to authenticate a `Subject` (phase 1).
public boolean	Returns: true always 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.JAASUser 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.JAASUser 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. Annotations @Override Exceptions LoginException: if the abort fails

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.

Annotations

@Override

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. Returns:boolean true if committed, false if not (likely not authenticated) Annotations @Override Exceptions LoginException: if unable to commit See Also `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.

Returns:boolean

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

Annotations

@Override

Exceptions

LoginException:: if unable to commit

See Also

LoginModule#commit()

configureCallbacks	back to summary
public Callback[] configureCallbacks()

getCallbackHandler	back to summary
public CallbackHandler getCallbackHandler()

getCurrentUser	back to summary
public AbstractLoginModule.JAASUser getCurrentUser()

getSubject	back to summary
public Subject getSubject()

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

initialize back to summary

initialize	back to summary
public void initialize(Subject subject, CallbackHandler callbackHandler, Map<String, ?> sharedState, Map<String, ?> 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. Parameters subject:Subject the subject callbackHandler:CallbackHandler the callback handler sharedState:Map<String, ?> the shared state map options:Map<String, ?> the option map Annotations @Override See Also `LoginModule#initialize(Subject, CallbackHandler, Map, Map)`

public void initialize(Subject subject, CallbackHandler callbackHandler, Map<String, ?> sharedState, Map<String, ?> 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.

Parameters

subject:Subject: the subject
callbackHandler:CallbackHandler: the callback handler
sharedState:Map<String, ?>: the shared state map
options:Map<String, ?>: the option map

Annotations

@Override

isAuthenticated	back to summary
public boolean isAuthenticated()

isCommitted	back to summary
public boolean isCommitted()

isIgnored	back to summary
public boolean isIgnored()

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`. Returns:boolean true if is authenticated, false otherwise Annotations @Override Exceptions LoginException: if unable to login See Also `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.

Returns:boolean

true if is authenticated, false otherwise

Annotations

@Override

Exceptions

LoginException:: if unable to login

See Also

LoginModule#login()

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. Returns:boolean true always Annotations @Override Exceptions LoginException: if unable to logout See Also `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.

Returns:boolean

true always

Annotations

@Override

Exceptions

LoginException:: if unable to logout

See Also

LoginModule#logout()

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.JAASUser u)

setSubject	back to summary
public void setSubject(Subject s)

org.eclipse.jetty.security.jaas.spi back to summary

public abstract Class AbstractLoginModule.JAASUser

Class Inheritance

extends Object

java.lang.Object
org.eclipse.jetty.security.jaas.spi.AbstractLoginModule.JAASUser

Known Direct Subclasses

org.eclipse.jetty.security.jaas.spi.LdapLoginModule.LDAPUser, org.eclipse.jetty.security.jaas.spi.LdapLoginModule.LDAPBindingUser, org.eclipse.jetty.security.jaas.spi.AbstractDatabaseLoginModule.JDBCUser

Field Summary

Modifier and Type	Field and Description
private List<JAASRole>	_roles
private final UserPrincipal	_user

Constructor Summary

Access	Constructor and Description
public	JAASUser(UserPrincipal u)

Method Summary

Modifier and Type	Method and Description
public boolean	checkCredential(Object suppliedCredential)
public abstract List<String>	doFetchRoles()
public void	fetchRoles()
public String	getUserName()
public void	setJAASInfo(Subject The subject subject)
public void	unsetJAASInfo(Subject The subject subject)

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

Field Detail

_roles	back to summary
private List<JAASRole> _roles

_user	back to summary
private final UserPrincipal _user

Constructor Detail

JAASUser	back to summary
public JAASUser(UserPrincipal u)

Method Detail

checkCredential	back to summary
public boolean checkCredential(Object suppliedCredential)

doFetchRoles	back to summary
public abstract List<String> doFetchRoles() throws Exception

fetchRoles	back to summary
public void fetchRoles() throws Exception

getUserName	back to summary
public String getUserName()

setJAASInfo	back to summary
public void setJAASInfo(Subject subject) Parameters subject:Subject The subject

unsetJAASInfo	back to summary
public void unsetJAASInfo(Subject subject) Parameters subject:Subject The subject

public abstract Class AbstractLoginModule

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public abstract Class AbstractLoginModule.JAASUser

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail