Package net.shibboleth.oidc.profile.oauth2.config

Interface OAuth2TokenRevocationConfiguration

All Superinterfaces:

AuthenticationProfileConfiguration, Component, ConditionalProfileConfiguration, IdentifiedComponent, OAuth2ClientAuthenticableProfileConfiguration, OAuth2DPoPProofValidatingProfileConfiguration, OAuth2ProfileConfiguration, OAuth2TokenValidatingProfileConfiguration, OverriddenIssuerProfileConfiguration, ProfileConfiguration

All Known Implementing Classes:

DefaultOAuth2TokenRevocationConfiguration

public interface OAuth2TokenRevocationConfiguration
extends OAuth2TokenValidatingProfileConfiguration

Configuration for the OAuth 2.0 Token Revocation profile.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	OAuth2TokenRevocationConfiguration.OAuth2TokenRevocationMethod	Enumeration of the OAuth2 token revocation methods.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROFILE_ID	ID for this profile configuration.
static final String	PROTOCOL_URI	OAuth2 Token Revocation URI.

Fields inherited from interface net.shibboleth.profile.config.ProfileConfiguration

DEFAULT_DISALLOWED_FEATURES

Method Summary

Modifier and Type	Method	Description
Duration	getRevocationLifetime(ProfileRequestContext profileRequestContext)	Get revocation lifetime.
OAuth2TokenRevocationConfiguration.OAuth2TokenRevocationMethod	getRevocationMethod(ProfileRequestContext profileRequestContext)	Get the revocation method used when revoking a token.

Methods inherited from interface net.shibboleth.idp.authn.config.AuthenticationProfileConfiguration

getAuthenticationFlows, getDefaultAuthenticationMethods, getPostAuthenticationFlows, getProxyCount, isForceAuthn, isLocal

Methods inherited from interface net.shibboleth.profile.config.ConditionalProfileConfiguration

getActivationCondition

Methods inherited from interface net.shibboleth.shared.component.IdentifiedComponent

getId

Methods inherited from interface net.shibboleth.oidc.profile.oauth2.config.OAuth2ClientAuthenticableProfileConfiguration

getClaimsValidator, getTokenEndpointAuthMethods, getUnregisteredClientPolicy

Methods inherited from interface net.shibboleth.oidc.profile.oauth2.config.OAuth2DPoPProofValidatingProfileConfiguration

getDpopProofClaimsValidator, getDpopProofNonceGenerator, getDpopProofSignatureValidationConfiguration, isRequireDpopProof

Methods inherited from interface net.shibboleth.oidc.profile.oauth2.config.OAuth2TokenValidatingProfileConfiguration

getIssuedClaimsValidator

Methods inherited from interface net.shibboleth.profile.config.OverriddenIssuerProfileConfiguration

getIssuer

Methods inherited from interface net.shibboleth.profile.config.ProfileConfiguration

getDisallowedFeatures, getSecurityConfiguration, isFeatureDisallowed

Field Details

PROTOCOL_URI

@Nonnull
@NotEmpty
static final String PROTOCOL_URI

OAuth2 Token Revocation URI.

See Also:

• Constant Field Values

PROFILE_ID

@Nonnull
@NotEmpty
static final String PROFILE_ID

ID for this profile configuration.

See Also:

• Constant Field Values

Method Details

getRevocationMethod

@ConfigurationSetting(name="revocationMethod")
@Nullable
OAuth2TokenRevocationConfiguration.OAuth2TokenRevocationMethod getRevocationMethod(@Nullable
 ProfileRequestContext profileRequestContext)

Get the revocation method used when revoking a token.

Parameters:

profileRequestContext - profile request context.

Returns:

The revocation method used when revoking a token.

Since:

2.1.0

getRevocationLifetime

@ConfigurationSetting(name="revocationLifetime")
@Positive
@Nonnull
Duration getRevocationLifetime(@Nullable
 ProfileRequestContext profileRequestContext)

Get revocation lifetime.

Defaults to 6 hours.

Parameters:

profileRequestContext - profile request context

Returns:

revocation lifetime

Since:

2.1.0