fish.payara.security.annotations

Annotation Type LogoutDefinition

@Retention(value=RUNTIME)
public @interface LogoutDefinition

LogoutDefinition annotation defines logout and RP session management configuration in openid connect client.

Author:

jGauravGupta

Field Summary

Fields

Modifier and Type	Fields and Description
static String	OPENID_MP_LOGOUT_ON_ACCESS_TOKEN_EXPIRY The Microprofile Config key for session timeout on the expiry of Access Tokens is "payara.security.openid.logout.access.token.expiry".
static String	OPENID_MP_LOGOUT_ON_IDENTITY_TOKEN_EXPIRY The Microprofile Config key for session timeout on the expiry of Identity Tokens is "payara.security.openid.logout.identity.token.expiry".
static String	OPENID_MP_POST_LOGOUT_REDIRECT_URI The Microprofile Config key for the post logout redirect URI is "payara.security.openid.logout.redirectURI"
static String	OPENID_MP_PROVIDER_NOTIFY_LOGOUT The Microprofile Config key for the flag logout redirect URI is "payara.security.openid.provider.notify.logout"

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	accessTokenExpiry Session timeout on the expiry of Access Token.
boolean	identityTokenExpiry Session timeout on the expiry of Identity Token.
boolean	notifyProvider Optional.
String	redirectURI Optional.

Field Detail

OPENID_MP_PROVIDER_NOTIFY_LOGOUT

public static final String OPENID_MP_PROVIDER_NOTIFY_LOGOUT

The Microprofile Config key for the flag logout redirect URI is "payara.security.openid.provider.notify.logout"

OPENID_MP_POST_LOGOUT_REDIRECT_URI

public static final String OPENID_MP_POST_LOGOUT_REDIRECT_URI

The Microprofile Config key for the post logout redirect URI is "payara.security.openid.logout.redirectURI"

OPENID_MP_LOGOUT_ON_ACCESS_TOKEN_EXPIRY

public static final String OPENID_MP_LOGOUT_ON_ACCESS_TOKEN_EXPIRY

The Microprofile Config key for session timeout on the expiry of Access Tokens is "payara.security.openid.logout.access.token.expiry".

OPENID_MP_LOGOUT_ON_IDENTITY_TOKEN_EXPIRY

public static final String OPENID_MP_LOGOUT_ON_IDENTITY_TOKEN_EXPIRY

The Microprofile Config key for session timeout on the expiry of Identity Tokens is "payara.security.openid.logout.identity.token.expiry".

Element Detail

notifyProvider

public abstract 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 fish.payara.security.annotations.OpenIdProviderMetadata#endSessionEndpoint. To set this using Microprofile Config use payara.security.openid.provider.notify.logout

Returns:

Default:

false

redirectURI

public abstract 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. To set this using Microprofile Config use payara.security.openid.logout.redirectURI

Returns:

Default:

""

accessTokenExpiry

public abstract boolean accessTokenExpiry

Session timeout on the expiry of Access Token.

Returns:

Default:

false

identityTokenExpiry

public abstract boolean identityTokenExpiry

Session timeout on the expiry of Identity Token.

Returns:

Default:

false