Top Description Methods
jakarta.security.enterprise.authentication.mechanism.http.openid

public @Interface LogoutDefinition

extends Annotation
Annotations
@Retention:RUNTIME
Imports
java.lang.annotation.Retention
LogoutDefinition annotation defines logout and RP session management configuration in openid connect client.
Author
jGauravGupta

Method Summary

Modifier and TypeMethod and Description
public boolean
accessTokenExpiry()

Session timeout on the expiry of Access Token.

public String
accessTokenExpiryExpression()

Allow the session timeout definition using a Jakarta Expression Language expression.

public boolean
identityTokenExpiry()

Session timeout on the expiry of Identity Token.

public String
identityTokenExpiryExpression()

Allow the session timeout using the Jakarta Expression Language expression.

public boolean

Returns:

true when OIDC provider is notified of logout.
notifyProvider()

Optional.

public String
notifyProviderExpression()

Optional.

public String

Returns:

URL after logout is performed on the client.
redirectURI()

Optional.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

accessTokenExpiryback to summary
public boolean accessTokenExpiry()

Session timeout on the expiry of Access Token.

accessTokenExpiryExpressionback to summary
public String accessTokenExpiryExpression()

Allow the session timeout definition using a Jakarta Expression Language expression. If set, overrides the value defined with accessTokenExpiry.

identityTokenExpiryback to summary
public boolean identityTokenExpiry()

Session timeout on the expiry of Identity Token.

identityTokenExpiryExpressionback to summary
public String identityTokenExpiryExpression()

Allow the session timeout using the Jakarta Expression Language expression. If set, overrides the identityTokenExpiry value.

notifyProviderback to summary
public boolean notifyProvider()

Optional. Notify the OIDC provider (OP) that the user has logged out of the application and might want to log out of the OP as well. If true then after having logged out the user from RP, redirects the End-User's User Agent to the OP's logout endpoint URL. This URL is normally obtained via the end_session_endpoint element of the OP's metadata or can be customized via OpenIdProviderMetadata#endSessionEndpoint.

Returns:boolean

true when OIDC provider is notified of logout.

notifyProviderExpressionback to summary
public String notifyProviderExpression()

Optional. Allows the OIDC provider (OP) notification that the user has logged using the Jakarta Expression Language expression. If set, overrides the value set by notifyProvider.

redirectURIback to summary
public String redirectURI()

Optional. The post logout redirect URI to which the RP is requesting that the End-User's User Agent be redirected after a logout has been performed. If redirect URI is empty then redirect to OpenID connect provider authorization_endpoint for re-authentication. *

Returns:String

URL after logout is performed on the client.