Modifier and Type	Class and Description
public static class	LoginAuthenticator.LoggedOutAuthentication
public static class	LoginAuthenticator.UserAuthenticationSent This Authentication represents a just completed authentication, that has sent a response, typically to redirect the client to the original request target..
public static class	LoginAuthenticator.UserAuthenticationSucceeded Base class for representing a successful authentication state.

Modifier and Type	Field and Description
protected IdentityService	_identityService
protected LoginService	_loginService
private int	_sessionMaxInactiveIntervalOnAuthentication
private boolean	_sessionRenewedOnAuthentication
private static final Logger	LOG

Access	Constructor and Description
protected	LoginAuthenticator()

Modifier and Type	Method and Description
public LoginService	getLoginService()
public UserIdentity	login(String the username of the client to be authenticated username, Object the user's credential password, Request the inbound request that needs authentication request, Response response) If the UserIdentity returned from `LoginService#login(String, Object, Request, Function)` is not null, it is assumed that the user is fully authenticated and we need to change the session id to prevent session fixation vulnerability.
public void	logout(Request request, Response response)
public void	setConfiguration(Authenticator.Configuration the configuration configuration) Implements org.eclipse.jetty.security.Authenticator.setConfiguration. Configure the Authenticator
protected void	updateSession(Request the request httpRequest, Response the response httpResponse) Update the session on authentication.

_identityService	back to summary
protected IdentityService _identityService

_loginService	back to summary
protected LoginService _loginService

_sessionMaxInactiveIntervalOnAuthentication	back to summary
private int _sessionMaxInactiveIntervalOnAuthentication

_sessionRenewedOnAuthentication	back to summary
private boolean _sessionRenewedOnAuthentication

LOG	back to summary
private static final Logger LOG

LoginAuthenticator	back to summary
protected LoginAuthenticator()

Method Detail

getLoginService	back to summary
public LoginService getLoginService()

login	back to summary
public UserIdentity login(String username, Object password, Request request, Response response) If the UserIdentity returned from `LoginService#login(String, Object, Request, Function)` is not null, it is assumed that the user is fully authenticated and we need to change the session id to prevent session fixation vulnerability. If the UserIdentity is not necessarily fully authenticated, then subclasses must override this method and determine when the UserIdentity IS fully authenticated and renew the session id. Parameters username:String the username of the client to be authenticated password:Object the user's credential request:Request the inbound request that needs authentication

public UserIdentity login(String username, Object password, Request request, Response response)

If the UserIdentity returned from LoginService#login(String, Object, Request, Function) is not null, it is assumed that the user is fully authenticated and we need to change the session id to prevent session fixation vulnerability. If the UserIdentity is not necessarily fully authenticated, then subclasses must override this method and determine when the UserIdentity IS fully authenticated and renew the session id.

Parameters

username:String: the username of the client to be authenticated
password:Object: the user's credential
request:Request: the inbound request that needs authentication

logout	back to summary
public void logout(Request request, Response response)

setConfiguration	back to summary
public void setConfiguration(Authenticator.Configuration configuration) Implements org.eclipse.jetty.security.Authenticator.setConfiguration. Doc from org.eclipse.jetty.security.Authenticator.setConfiguration. Configure the Authenticator Parameters configuration:Authenticator.Configuration the configuration Annotations @Override

setConfiguration

back to summary

public void setConfiguration(Authenticator.Configuration configuration)

Implements org.eclipse.jetty.security.Authenticator.setConfiguration.

Doc from org.eclipse.jetty.security.Authenticator.setConfiguration.

Configure the Authenticator

Parameters

configuration:Authenticator.Configuration: the configuration

Annotations

@Override

updateSession back to summary

updateSession	back to summary
protected void updateSession(Request httpRequest, Response httpResponse) Update the session on authentication. The session is changed to a new instance with a new ID if and only if: A session exists. The `Configuration#isSessionRenewedOnAuthentication()` returns true. The session ID has been given to unauthenticated responses Parameters httpRequest:Request the request httpResponse:Response the response See Also `Configuration#isSessionRenewedOnAuthentication()`, `Configuration#getSessionMaxInactiveIntervalOnAuthentication()`

protected void updateSession(Request httpRequest, Response httpResponse)

Update the session on authentication. The session is changed to a new instance with a new ID if and only if:

A session exists.
The Configuration#isSessionRenewedOnAuthentication() returns true.
The session ID has been given to unauthenticated responses

Parameters

httpRequest:Request: the request
httpResponse:Response: the response

org.eclipse.jetty.security.authentication back to summary

public Class LoginAuthenticator.LoggedOutAuthentication

Class Inheritance

extends Object
implements Deferred

java.lang.Object
org.eclipse.jetty.security.authentication.LoginAuthenticator.LoggedOutAuthentication

All Implemented Interfaces

org.eclipse.jetty.security.AuthenticationState.Deferred, org.eclipse.jetty.security.AuthenticationState, org.eclipse.jetty.server.Request.AuthenticationState

Field Summary

Modifier and Type	Field and Description
private final AuthenticationState.Deferred	_delegate

Constructor Summary

Access	Constructor and Description
public	LoggedOutAuthentication(LoginAuthenticator authenticator)

Method Summary

Modifier and Type	Method and Description
public AuthenticationState.Succeeded	authenticate(Request The request to authenticate request) Implements org.eclipse.jetty.security.AuthenticationState.Deferred.authenticate. Authenticate the request using any credentials already associated with the request.
public AuthenticationState	authenticate(Request The request to authenticate request, Response The response to use for a challenge. response, Callback The callback to complete if a challenge is sent callback) Implements org.eclipse.jetty.security.AuthenticationState.Deferred.authenticate. Authenticate the request using any credentials already associated with the request or challenging if necessary.
public IdentityService.Association	getAssociation() Implements org.eclipse.jetty.security.AuthenticationState.Deferred.getAssociation.
public AuthenticationState.Succeeded	login(String The username to validate username, Object The credential to validate password, Request The request to authenticate request, Response The response, which may be updated if the session ID is changed. response) Implements org.eclipse.jetty.security.AuthenticationState.Deferred.login. Authenticate the request with the passed credentials
public void	logout(Request The authenticated request request, Response The associated response, which may be updated to clear a session ID. response) Implements org.eclipse.jetty.security.AuthenticationState.Deferred.logout. Logout the authenticated user.

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

Field Detail

_delegate	back to summary
private final AuthenticationState.Deferred _delegate

Constructor Detail

LoggedOutAuthentication	back to summary
public LoggedOutAuthentication(LoginAuthenticator authenticator)

Method Detail

authenticate back to summary

authenticate	back to summary
public AuthenticationState.Succeeded authenticate(Request request) Implements org.eclipse.jetty.security.AuthenticationState.Deferred.authenticate. Doc from org.eclipse.jetty.security.AuthenticationState.Deferred.authenticate. Authenticate the request using any credentials already associated with the request. No challenge can be sent. If the login is successful, then the `IdentityService#associate(UserIdentity, RunAsToken)` method is used and the returned `org.eclipse.jetty.security.IdentityService.Association` is made available via `getAssociation()`. Parameters request:Request The request to authenticate Returns:AuthenticationState.Succeeded A `Succeeded` authentication or null Annotations @Override

public AuthenticationState.Succeeded authenticate(Request request)

Implements org.eclipse.jetty.security.AuthenticationState.Deferred.authenticate.

Doc from org.eclipse.jetty.security.AuthenticationState.Deferred.authenticate.

Authenticate the request using any credentials already associated with the request. No challenge can be sent. If the login is successful, then the IdentityService#associate(UserIdentity, RunAsToken) method is used and the returned org.eclipse.jetty.security.IdentityService.Association is made available via getAssociation().

Parameters

request:Request: The request to authenticate

Returns:AuthenticationState.Succeeded

A Succeeded authentication or null

Annotations

@Override

authenticate back to summary

authenticate	back to summary
public AuthenticationState authenticate(Request request, Response response, Callback callback) Implements org.eclipse.jetty.security.AuthenticationState.Deferred.authenticate. Doc from org.eclipse.jetty.security.AuthenticationState.Deferred.authenticate. Authenticate the request using any credentials already associated with the request or challenging if necessary. If the login is successful, then the `IdentityService#associate(UserIdentity, RunAsToken)` method is used and the returned `org.eclipse.jetty.security.IdentityService.Association` is made available via `getAssociation()`. Parameters request:Request The request to authenticate response:Response The response to use for a challenge. callback:Callback The callback to complete if a challenge is sent Returns:AuthenticationState The next `AuthenticationState`, if it is `ResponseSent`, then the callback will be completed. Annotations @Override

public AuthenticationState authenticate(Request request, Response response, Callback callback)

Implements org.eclipse.jetty.security.AuthenticationState.Deferred.authenticate.

Doc from org.eclipse.jetty.security.AuthenticationState.Deferred.authenticate.

Authenticate the request using any credentials already associated with the request or challenging if necessary. If the login is successful, then the IdentityService#associate(UserIdentity, RunAsToken) method is used and the returned org.eclipse.jetty.security.IdentityService.Association is made available via getAssociation().

Parameters

request:Request: The request to authenticate
response:Response: The response to use for a challenge.
callback:Callback: The callback to complete if a challenge is sent

Returns:AuthenticationState

The next AuthenticationState, if it is ResponseSent, then the callback will be completed.

Annotations

@Override

getAssociation back to summary

getAssociation	back to summary
public IdentityService.Association getAssociation() Implements org.eclipse.jetty.security.AuthenticationState.Deferred.getAssociation. Returns:IdentityService.Association Doc from org.eclipse.jetty.security.AuthenticationState.Deferred.getAssociation. Any `org.eclipse.jetty.security.IdentityService.Association` created during deferred authentication. Annotations @Override

public IdentityService.Association getAssociation()

Implements org.eclipse.jetty.security.AuthenticationState.Deferred.getAssociation.

Returns:IdentityService.Association

Doc from org.eclipse.jetty.security.AuthenticationState.Deferred.getAssociation.

Any org.eclipse.jetty.security.IdentityService.Association created during deferred authentication.

Annotations

@Override

login	back to summary
public AuthenticationState.Succeeded login(String username, Object password, Request request, Response response) Implements org.eclipse.jetty.security.AuthenticationState.Deferred.login. Doc from org.eclipse.jetty.security.AuthenticationState.Deferred.login. Authenticate the request with the passed credentials Parameters username:String The username to validate password:Object The credential to validate request:Request The request to authenticate response:Response The response, which may be updated if the session ID is changed. Returns:AuthenticationState.Succeeded A `Succeeded` authentication or null Annotations @Override

public AuthenticationState.Succeeded login(String username, Object password, Request request, Response response)

Implements org.eclipse.jetty.security.AuthenticationState.Deferred.login.

Doc from org.eclipse.jetty.security.AuthenticationState.Deferred.login.

Authenticate the request with the passed credentials

Parameters

username:String: The username to validate
password:Object: The credential to validate
request:Request: The request to authenticate
response:Response: The response, which may be updated if the session ID is changed.

Returns:AuthenticationState.Succeeded

A Succeeded authentication or null

Annotations

@Override

logout	back to summary
public void logout(Request request, Response response) Implements org.eclipse.jetty.security.AuthenticationState.Deferred.logout. Doc from org.eclipse.jetty.security.AuthenticationState.Deferred.logout. Logout the authenticated user. Parameters request:Request The authenticated request response:Response The associated response, which may be updated to clear a session ID. Annotations @Override

logout

back to summary

public void logout(Request request, Response response)

Implements org.eclipse.jetty.security.AuthenticationState.Deferred.logout.

Doc from org.eclipse.jetty.security.AuthenticationState.Deferred.logout.

Logout the authenticated user.

Parameters

request:Request: The authenticated request
response:Response: The associated response, which may be updated to clear a session ID.

Annotations

@Override

org.eclipse.jetty.security.authentication back to summary

public Class LoginAuthenticator.UserAuthenticationSent

Class Inheritance

extends UserAuthenticationSucceeded
implements ResponseSent

java.lang.Object
org.eclipse.jetty.security.authentication.LoginAuthenticator.UserAuthenticationSucceeded
org.eclipse.jetty.security.authentication.LoginAuthenticator.UserAuthenticationSent

All Implemented Interfaces

org.eclipse.jetty.security.AuthenticationState.ResponseSent, org.eclipse.jetty.security.AuthenticationState, org.eclipse.jetty.server.Request.AuthenticationState

This Authentication represents a just completed authentication, that has sent a response, typically to redirect the client to the original request target..

Field Summary

Inherited from org.eclipse.jetty.security.authentication.LoginAuthenticator.UserAuthenticationSucceeded:: _authenticationType _userIdentity

Constructor Summary

Access	Constructor and Description
public	UserAuthenticationSent(String method, UserIdentity userIdentity)

Method Summary

Inherited from org.eclipse.jetty.security.authentication.LoginAuthenticator.UserAuthenticationSucceeded:: getAuthenticationType getUserIdentity isUserInRole logout toString

Constructor Detail

UserAuthenticationSent	back to summary
public UserAuthenticationSent(String method, UserIdentity userIdentity)

org.eclipse.jetty.security.authentication back to summary

public Class LoginAuthenticator.UserAuthenticationSucceeded

Class Inheritance

extends Object
implements Succeeded, Serializable

java.lang.Object
org.eclipse.jetty.security.authentication.LoginAuthenticator.UserAuthenticationSucceeded

All Implemented Interfaces

java.io.Serializable, org.eclipse.jetty.security.AuthenticationState.Succeeded, org.eclipse.jetty.security.AuthenticationState, org.eclipse.jetty.server.Request.AuthenticationState

Known Direct Subclasses

org.eclipse.jetty.security.authentication.LoginAuthenticator.UserAuthenticationSent, org.eclipse.jetty.security.authentication.SessionAuthentication

Base class for representing a successful authentication state.

Field Summary

Modifier and Type	Field and Description
protected String	_authenticationType
protected transient UserIdentity	_userIdentity
private static final long	serialVersionUID

Constructor Summary

Access	Constructor and Description
public	UserAuthenticationSucceeded(String authenticationType, UserIdentity userIdentity)

Method Summary

Modifier and Type	Method and Description
public String	getAuthenticationType() Implements org.eclipse.jetty.security.AuthenticationState.Succeeded.getAuthenticationType.
public UserIdentity	getUserIdentity() Implements org.eclipse.jetty.security.AuthenticationState.Succeeded.getUserIdentity.
public boolean	isUserInRole(String The role to check. role) Implements org.eclipse.jetty.security.AuthenticationState.Succeeded.isUserInRole.
public void	logout(Request the request request, Response the response response) Implements org.eclipse.jetty.security.AuthenticationState.Succeeded.logout. Remove any user information that may be present in the request such that a call to getUserPrincipal/getRemoteUser will return null.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

Field Detail

_authenticationType	back to summary
protected String _authenticationType

_userIdentity	back to summary
protected transient UserIdentity _userIdentity

serialVersionUID	back to summary
private static final long serialVersionUID Annotations @Serial

Constructor Detail

UserAuthenticationSucceeded	back to summary
public UserAuthenticationSucceeded(String authenticationType, UserIdentity userIdentity)

Method Detail

getAuthenticationType	back to summary
public String getAuthenticationType() Implements org.eclipse.jetty.security.AuthenticationState.Succeeded.getAuthenticationType. Returns:String Doc from org.eclipse.jetty.security.AuthenticationState.Succeeded.getAuthenticationType. The method used to authenticate the user. Annotations @Override

getAuthenticationType

back to summary

public String getAuthenticationType()

Implements org.eclipse.jetty.security.AuthenticationState.Succeeded.getAuthenticationType.

Returns:String

Doc from org.eclipse.jetty.security.AuthenticationState.Succeeded.getAuthenticationType.

The method used to authenticate the user.

Annotations

@Override

getUserIdentity back to summary

getUserIdentity	back to summary
public UserIdentity getUserIdentity() Implements org.eclipse.jetty.security.AuthenticationState.Succeeded.getUserIdentity. Returns:UserIdentity Doc from org.eclipse.jetty.security.AuthenticationState.Succeeded.getUserIdentity. The `UserIdentity` of the authenticated user. Annotations @Override

public UserIdentity getUserIdentity()

Implements org.eclipse.jetty.security.AuthenticationState.Succeeded.getUserIdentity.

Returns:UserIdentity

Doc from org.eclipse.jetty.security.AuthenticationState.Succeeded.getUserIdentity.

The UserIdentity of the authenticated user.

Annotations

@Override

isUserInRole	back to summary
public boolean isUserInRole(String role) Implements org.eclipse.jetty.security.AuthenticationState.Succeeded.isUserInRole. Parameters role:String Doc from org.eclipse.jetty.security.AuthenticationState.Succeeded.isUserInRole. The role to check. Returns:boolean Doc from org.eclipse.jetty.security.AuthenticationState.Succeeded.isUserInRole. True if the user is in the passed role Annotations @Override

isUserInRole

back to summary

public boolean isUserInRole(String role)

Implements org.eclipse.jetty.security.AuthenticationState.Succeeded.isUserInRole.

Parameters

role:String

Doc from org.eclipse.jetty.security.AuthenticationState.Succeeded.isUserInRole.

The role to check.

Returns:boolean

Doc from org.eclipse.jetty.security.AuthenticationState.Succeeded.isUserInRole.

True if the user is in the passed role

Annotations

@Override

logout	back to summary
public void logout(Request request, Response response) Implements org.eclipse.jetty.security.AuthenticationState.Succeeded.logout. Doc from org.eclipse.jetty.security.AuthenticationState.Succeeded.logout. Remove any user information that may be present in the request such that a call to getUserPrincipal/getRemoteUser will return null. Parameters request:Request the request response:Response the response Annotations @Override

logout

back to summary

public void logout(Request request, Response response)

Implements org.eclipse.jetty.security.AuthenticationState.Succeeded.logout.

Doc from org.eclipse.jetty.security.AuthenticationState.Succeeded.logout.

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

Parameters

request:Request: the request
response:Response: the response

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public abstract Class LoginAuthenticator

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class LoginAuthenticator.LoggedOutAuthentication

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class LoginAuthenticator.UserAuthenticationSent

Field Summary

Constructor Summary

Method Summary

Constructor Detail

public Class LoginAuthenticator.UserAuthenticationSucceeded

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail