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

Interface OAuth2RefreshTokenProducingProfileConfiguration

All Superinterfaces:

Component, ConditionalProfileConfiguration, IdentifiedComponent, OAuth2ProfileConfiguration, ProfileConfiguration

All Known Subinterfaces:

OAuth2TokenConfiguration, OIDCAuthorizationConfiguration, OIDCSSOProviderConfiguration

All Known Implementing Classes:

AbstractOIDCSSOConfiguration, DefaultOAuth2PushedAuthorizationRequestConfiguration, DefaultOAuth2TokenConfiguration, DefaultOIDCAuthorizationConfiguration

public interface OAuth2RefreshTokenProducingProfileConfiguration
extends OAuth2ProfileConfiguration

Configuration common to OAuth 2.0 refresh token producing profiles.

Field Summary

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

DEFAULT_DISALLOWED_FEATURES

Method Summary

Modifier and Type	Method	Description
Duration	getRefreshTokenChainLifetime(ProfileRequestContext profileRequestContext)	Get refresh token chain lifetime.
Duration	getRefreshTokenTimeout(ProfileRequestContext profileRequestContext)	Get refresh token timeout.
String	getRefreshTokenType(ProfileRequestContext profileRequestContext)	Get refresh token type.

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.profile.config.ProfileConfiguration

getDisallowedFeatures, getSecurityConfiguration, isFeatureDisallowed

Method Details

getRefreshTokenTimeout

@ConfigurationSetting(name="refreshTokenTimeout")
@Nonnull
@Positive
Duration getRefreshTokenTimeout(@Nullable
 ProfileRequestContext profileRequestContext)

Get refresh token timeout. The expiration of a single refresh token is calculated based on this value.

Defaults to 2 hours.

Parameters:

profileRequestContext - profile request context

Returns:

refresh token timeout

Since:

2.2.0

getRefreshTokenChainLifetime

@ConfigurationSetting(name="refreshTokenChainLifetime")
@Nonnull
@Positive
Duration getRefreshTokenChainLifetime(@Nullable
 ProfileRequestContext profileRequestContext)

Get refresh token chain lifetime. The expiration of a single refresh token is calculated based on this value.

Defaults to 2 hours.

Parameters:

profileRequestContext - profile request context

Returns:

refresh token timeout

Since:

2.2.0

getRefreshTokenType

@ConfigurationSetting(name="refreshTokenType")
@Nullable
@NotEmpty
String getRefreshTokenType(@Nullable
 ProfileRequestContext profileRequestContext)

Get refresh token type.

Parameters:

profileRequestContext - profile request context

Returns:

refresh token type, or null for unspecified/opaque

Since:

3.1.0