Class LoginAuthenticator.UserAuthenticationSucceeded

java.lang.Object

org.eclipse.jetty.security.authentication.LoginAuthenticator.UserAuthenticationSucceeded

All Implemented Interfaces:

Serializable, AuthenticationState, AuthenticationState.Succeeded, Request.AuthenticationState

Direct Known Subclasses:

LoginAuthenticator.UserAuthenticationSent, SessionAuthentication

Enclosing class:

LoginAuthenticator

public static class LoginAuthenticator.UserAuthenticationSucceeded
extends Object
implements AuthenticationState.Succeeded, Serializable

Base class for representing a successful authentication state.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface AuthenticationState

AuthenticationState.Deferred, AuthenticationState.ResponseSent, AuthenticationState.ServeAs, AuthenticationState.Succeeded

Field Summary

Fields

Modifier and Type	Field	Description
protected String	_authenticationType
protected UserIdentity	_userIdentity

Fields inherited from interface AuthenticationState

CHALLENGE, SEND_FAILURE, SEND_SUCCESS

Constructor Summary

Constructors

Constructor	Description
UserAuthenticationSucceeded(String authenticationType, UserIdentity userIdentity)

Method Summary

Modifier and Type	Method	Description
String	getAuthenticationType()
UserIdentity	getUserIdentity()
boolean	isUserInRole(String role)
void	logout(Request request, Response response)	Remove any user information that may be present in the request such that a call to getUserPrincipal/getRemoteUser will return null.
String	toString()

Methods inherited from class Object

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

Methods inherited from interface AuthenticationState.Succeeded

getUserPrincipal

Field Details

_authenticationType

protected String _authenticationType

_userIdentity

protected transient UserIdentity _userIdentity

Constructor Details

UserAuthenticationSucceeded

public UserAuthenticationSucceeded(String authenticationType,
 UserIdentity userIdentity)

Method Details

getAuthenticationType

public String getAuthenticationType()

Specified by:

getAuthenticationType in interface AuthenticationState.Succeeded

Returns:

The method used to authenticate the user.

getUserIdentity

public UserIdentity getUserIdentity()

Specified by:

getUserIdentity in interface AuthenticationState.Succeeded

Returns:

The UserIdentity of the authenticated user.

isUserInRole

public boolean isUserInRole(String role)

Specified by:

isUserInRole in interface AuthenticationState.Succeeded

Parameters:

role - The role to check.

Returns:

True if the user is in the passed role

logout

public void logout(Request request,
 Response response)

Description copied from interface: AuthenticationState.Succeeded

Remove any user information that may be present in the request such that a call to getUserPrincipal/getRemoteUser will return null.

Specified by:

logout in interface AuthenticationState.Succeeded

Parameters:

request - the request

response - the response

toString

public String toString()

Overrides:

toString in class Object