Package org.eclipse.jetty.security.internal

Class DeferredAuthenticationState

java.lang.Object

org.eclipse.jetty.security.internal.DeferredAuthenticationState

All Implemented Interfaces:

AuthenticationState, AuthenticationState.Deferred, Request.AuthenticationState

public class DeferredAuthenticationState
extends Object
implements AuthenticationState.Deferred

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jetty.security.AuthenticationState

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

Nested classes/interfaces inherited from interface org.eclipse.jetty.security.AuthenticationState.Deferred

AuthenticationState.Deferred.DeferredResponse

Field Summary

Fields

Modifier and Type	Field	Description
protected final LoginAuthenticator	_authenticator

Fields inherited from interface org.eclipse.jetty.security.AuthenticationState

CHALLENGE, SEND_FAILURE, SEND_SUCCESS

Constructor Summary

Constructors

Constructor	Description
DeferredAuthenticationState(LoginAuthenticator authenticator)

Method Summary

Modifier and Type	Method	Description
AuthenticationState.Succeeded	authenticate(Request request)	Authenticate the request using any credentials already associated with the request.
AuthenticationState	authenticate(Request request, Response response, Callback callback)	Authenticate the request using any credentials already associated with the request or challenging if necessary.
IdentityService.Association	getAssociation()
AuthenticationState.Succeeded	login(String username, Object password, Request request, Response response)	Authenticate the request with the passed credentials
void	logout(Request request, Response response)	Logout the authenticated user.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jetty.server.Request.AuthenticationState

getUserPrincipal

Field Details

_authenticator

protected final LoginAuthenticator _authenticator

Constructor Details

DeferredAuthenticationState

public DeferredAuthenticationState(LoginAuthenticator authenticator)

Method Details

authenticate

public AuthenticationState.Succeeded authenticate(Request request)

Description copied from interface: AuthenticationState.Deferred

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 IdentityService.Association is made available via AuthenticationState.Deferred.getAssociation().

Specified by:

authenticate in interface AuthenticationState.Deferred

Parameters:

request - The request to authenticate

Returns:

A AuthenticationState.Succeeded authentication or null

See Also:

• AuthenticationState.Deferred.getAssociation()

authenticate

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

Description copied from interface: AuthenticationState.Deferred

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 IdentityService.Association is made available via AuthenticationState.Deferred.getAssociation().

Specified by:

authenticate in interface AuthenticationState.Deferred

Parameters:

request - The request to authenticate

response - The response to use for a challenge.

callback - The callback to complete if a challenge is sent

Returns:

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

See Also:

• AuthenticationState.Deferred.getAssociation()

login

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

Description copied from interface: AuthenticationState.Deferred

Authenticate the request with the passed credentials

Specified by:

login in interface AuthenticationState.Deferred

Parameters:

username - The username to validate

password - The credential to validate

request - The request to authenticate

response - The response, which may be updated if the session ID is changed.

Returns:

A AuthenticationState.Succeeded authentication or null

logout

public void logout(Request request,
 Response response)

Description copied from interface: AuthenticationState.Deferred

Logout the authenticated user.

Specified by:

logout in interface AuthenticationState.Deferred

Parameters:

request - The authenticated request

response - The associated response, which may be updated to clear a session ID.

getAssociation

public IdentityService.Association getAssociation()

Specified by:

getAssociation in interface AuthenticationState.Deferred

Returns:

Any IdentityService.Association created during deferred authentication.

See Also:

• AuthenticationState.Deferred.authenticate(Request, Response, Callback)
• AuthenticationState.Deferred.authenticate(Request)