Package org.eclipse.jetty.security.authentication

Class DeferredAuthentication

java.lang.Object

org.eclipse.jetty.security.authentication.DeferredAuthentication

All Implemented Interfaces:

Authentication, Authentication.Deferred, Authentication.LoginAuthentication, Authentication.LogoutAuthentication

public class DeferredAuthentication
extends Object
implements Authentication.Deferred

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 final LoginAuthenticator	_authenticator

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

NOT_CHECKED, SEND_CONTINUE, SEND_FAILURE, SEND_SUCCESS, UNAUTHENTICATED

Constructor Summary

Constructors

Constructor	Description
DeferredAuthentication(LoginAuthenticator authenticator)

Method Summary

Modifier and Type	Method	Description
Authentication	authenticate(jakarta.servlet.ServletRequest request)	Authenticate if possible without sending a challenge.
Authentication	authenticate(jakarta.servlet.ServletRequest request, jakarta.servlet.ServletResponse response)	Authenticate and possibly send a challenge.
Object	getPreviousAssociation()
static boolean	isDeferred(jakarta.servlet.http.HttpServletResponse response)
Authentication	login(String username, Object password, jakarta.servlet.ServletRequest request)	Login with the LOGIN authenticator
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

_authenticator

protected final LoginAuthenticator _authenticator

Constructor Details

DeferredAuthentication

public DeferredAuthentication(LoginAuthenticator authenticator)

Method Details

authenticate

public Authentication authenticate(jakarta.servlet.ServletRequest request)

Description copied from interface: Authentication.Deferred

Authenticate if possible without sending a challenge. This is used to check credentials that have been sent for non-mandatory authentication.

Specified by:

authenticate in interface Authentication.Deferred

Parameters:

request - the request

Returns:

The new Authentication state.

authenticate

public Authentication authenticate(jakarta.servlet.ServletRequest request,
 jakarta.servlet.ServletResponse response)

Description copied from interface: Authentication.Deferred

Authenticate and possibly send a challenge. This is used to initiate authentication for previously non-mandatory authentication.

Specified by:

authenticate in interface Authentication.Deferred

Parameters:

request - the request

response - the response

Returns:

The new Authentication state.

login

public Authentication login(String username,
 Object password,
 jakarta.servlet.ServletRequest request)

Description copied from interface: Authentication.LoginAuthentication

Login with the LOGIN authenticator

Specified by:

login in interface Authentication.LoginAuthentication

Parameters:

username - the username

password - the password

request - the request

Returns:

The new Authentication state

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

getPreviousAssociation

public Object getPreviousAssociation()

isDeferred

public static boolean isDeferred(jakarta.servlet.http.HttpServletResponse response)

Parameters:

response - the response

Returns:

true if this response is from a deferred call to authenticate(ServletRequest)