Interface Authentication.LogoutAuthentication

All Superinterfaces:

Authentication, Request.AuthenticationState

All Known Subinterfaces:

Authentication.Deferred, Authentication.User

All Known Implementing Classes:

AbstractUserAuthentication, DeferredAuthentication, FormAuthenticator.FormAuthentication, OpenIdAuthenticator.OpenIdAuthentication, SessionAuthentication, UserAuthentication

Enclosing interface:

Authentication

public static interface Authentication.LogoutAuthentication
extends Authentication

An authentication that is capable of performing a programmatic logout operation.

Nested Class Summary

Nested classes/interfaces inherited from interface 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 inherited from interface Authentication

NOT_CHECKED, SEND_CONTINUE, SEND_FAILURE, SEND_SUCCESS, UNAUTHENTICATED

Method Summary

Modifier and Type	Method	Description
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 interface Request.AuthenticationState

getUserPrincipal

Method Details

logout

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.

Parameters:

request - the request

Returns:

NoAuthentication if we successfully logged out