Package org.eclipse.jetty.security

Class AbstractUserAuthentication

java.lang.Object

org.eclipse.jetty.security.AbstractUserAuthentication

All Implemented Interfaces:

Serializable, Authentication, Authentication.LogoutAuthentication, Authentication.User

Direct Known Subclasses:

SessionAuthentication, UserAuthentication

public abstract class AbstractUserAuthentication
extends Object
implements Authentication.User, Serializable

AbstractUserAuthentication Base class for representing an authenticated user.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jetty.server.Authentication

Authentication.Challenge, Authentication.Deferred, Authentication.Failed, Authentication.Failure, Authentication.LoginAuthentication, Authentication.LogoutAuthentication, Authentication.NonAuthenticated, Authentication.ResponseSent, Authentication.SendSuccess, Authentication.User, Authentication.Wrapped

Field Summary

Fields

Modifier and Type	Field	Description
protected String	_method
protected UserIdentity	_userIdentity

Fields inherited from interface org.eclipse.jetty.server.Authentication

NOT_CHECKED, SEND_CONTINUE, SEND_FAILURE, SEND_SUCCESS, UNAUTHENTICATED

Constructor Summary

Constructors

Constructor	Description
AbstractUserAuthentication(String method, UserIdentity userIdentity)

Method Summary

Modifier and Type	Method	Description
boolean	declaredRolesContains(String roleName)
String	getAuthMethod()
UserIdentity	getUserIdentity()
boolean	isUserInRole(UserIdentity.Scope scope, String role)
Authentication	logout(jakarta.servlet.ServletRequest request)	Remove any user information that may be present in the request such that a call to getUserPrincipal/getRemoteUser will return null.

Methods inherited from class java.lang.Object

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

Field Details

_method

protected String _method

_userIdentity

protected transient UserIdentity _userIdentity

Constructor Details

AbstractUserAuthentication

public AbstractUserAuthentication(String method,
 UserIdentity userIdentity)

Method Details

getAuthMethod

public String getAuthMethod()

Specified by:

getAuthMethod in interface Authentication.User

getUserIdentity

public UserIdentity getUserIdentity()

Specified by:

getUserIdentity in interface Authentication.User

isUserInRole

public boolean isUserInRole(UserIdentity.Scope scope,
 String role)

Specified by:

isUserInRole in interface Authentication.User

declaredRolesContains

public boolean declaredRolesContains(String roleName)

logout

public Authentication logout(jakarta.servlet.ServletRequest request)

Description copied from interface: Authentication.LogoutAuthentication

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 Authentication.LogoutAuthentication

Parameters:

request - the request

Returns:

NoAuthentication if we successfully logged out