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

Interface OAuth2AccessTokenProducingProfileConfiguration

All Superinterfaces:

Component, ConditionalProfileConfiguration, IdentifiedComponent, OAuth2ProfileConfiguration, ProfileConfiguration

All Known Subinterfaces:

OAuth2TokenAudienceConfiguration, OAuth2TokenConfiguration, OIDCAuthorizationConfiguration, OIDCSSOProviderConfiguration

All Known Implementing Classes:

AbstractOIDCSSOConfiguration, DefaultOAuth2TokenAudienceConfiguration, DefaultOAuth2TokenConfiguration, DefaultOIDCAuthorizationConfiguration

public interface OAuth2AccessTokenProducingProfileConfiguration
extends OAuth2ProfileConfiguration

Configuration common to OAuth 2.0 access token producing profiles.

Field Summary

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

DEFAULT_DISALLOWED_FEATURES

Method Summary

Modifier and Type	Method	Description
BiFunction<ProfileRequestContext,Map<String,Object>,Map<String,Object>>	getAccessTokenClaimsSetManipulationStrategy(ProfileRequestContext profileRequestContext)	Get the bi-function for manipulating access token claims set.
Duration	getAccessTokenLifetime(ProfileRequestContext profileRequestContext)	Get access token lifetime.
String	getAccessTokenType(ProfileRequestContext profileRequestContext)	Get access 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

getAccessTokenType

@ConfigurationSetting(name="accessTokenType")
@Nullable
@NotEmpty
String getAccessTokenType(@Nullable
 ProfileRequestContext profileRequestContext)

Get access token type.

Parameters:

profileRequestContext - profile request context

Returns:

access token type, or null for unspecified/opaque

Since:

2.1.0

getAccessTokenLifetime

@ConfigurationSetting(name="accessTokenLifetime")
@Positive
@Nonnull
Duration getAccessTokenLifetime(@Nullable
 ProfileRequestContext profileRequestContext)

Get access token lifetime.

Defaults to 10 minutes.

Parameters:

profileRequestContext - profile request context

Returns:

access token lifetime

getAccessTokenClaimsSetManipulationStrategy

@ConfigurationSetting(name="accessTokenClaimsSetManipulationStrategy")
@Nullable
BiFunction<ProfileRequestContext,Map<String,Object>,Map<String,Object>> getAccessTokenClaimsSetManipulationStrategy(@Nullable
 ProfileRequestContext profileRequestContext)

Get the bi-function for manipulating access token claims set.

Parameters:

profileRequestContext - profile request context

Returns:

the bi-function for manipulating access token claims set

Since:

2.1.0