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

Class OAuth2TokenAudienceConfiguration

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent

net.shibboleth.idp.profile.config.AbstractProfileConfiguration

net.shibboleth.idp.profile.config.AbstractConditionalProfileConfiguration

net.shibboleth.oidc.profile.oauth2.config.OAuth2TokenAudienceConfiguration

All Implemented Interfaces:

net.shibboleth.idp.profile.config.AttributeResolvingProfileConfiguration, net.shibboleth.idp.profile.config.ConditionalProfileConfiguration, net.shibboleth.idp.profile.config.OverriddenIssuerProfileConfiguration, net.shibboleth.idp.profile.config.ProfileConfiguration, OAuth2ProfileConfiguration, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent

public class OAuth2TokenAudienceConfiguration
extends net.shibboleth.idp.profile.config.AbstractConditionalProfileConfiguration
implements OAuth2ProfileConfiguration, net.shibboleth.idp.profile.config.OverriddenIssuerProfileConfiguration, net.shibboleth.idp.profile.config.AttributeResolvingProfileConfiguration

Interface for OAuth 2 token "audience" profile configuration.

This applies to behavior controlling the characteristics of tokens issued to the parties intended to process them, as distinct from the clients that use them.

Field Summary

Fields

Modifier and Type	Field	Description
private Function<ProfileRequestContext,Duration>	accessTokenLifetimeLookupStrategy	Lookup function to supply access token lifetime.
private Function<ProfileRequestContext,String>	accessTokenTypeLookupStrategy	Lookup functioon to supply access token type.
private Predicate<ProfileRequestContext>	encryptionOptionalPredicate	Whether encryption is optional in the face of no key, etc.
private Function<ProfileRequestContext,String>	issuerLookupStrategy	Lookup function to override issuer value.
static String	PROFILE_ID	ID for this profile configuration.
static String	PROTOCOL_URI	OAuth2 Token Revocation URI.
private Predicate<ProfileRequestContext>	resolveAttributesPredicate	Whether attributes should be resolved in the course of the profile.

Fields inherited from class net.shibboleth.idp.profile.config.AbstractProfileConfiguration

DEFAULT_DISALLOWED_FEATURES

Constructor Summary

Constructors

Constructor	Description
OAuth2TokenAudienceConfiguration()	Constructor.
OAuth2TokenAudienceConfiguration(String profileId)	Creates a new configuration instance.

Method Summary

Modifier and Type	Method	Description
Duration	getAccessTokenLifetime(ProfileRequestContext profileRequestContext)	Get access token lifetime.
String	getAccessTokenType(ProfileRequestContext profileRequestContext)	Get access token type.
String	getIssuer(ProfileRequestContext profileRequestContext)
boolean	isEncryptionOptional(ProfileRequestContext profileRequestContext)	Get whether encryption is optional in the face of a missing key, etc.
boolean	isResolveAttributes(ProfileRequestContext profileRequestContext)
void	setAccessTokenLifetime(Duration lifetime)	Set the lifetime of an access token.
void	setAccessTokenLifetimeLookupStrategy(Function<ProfileRequestContext,Duration> strategy)	Set a lookup strategy for the access token lifetime.
void	setAccessTokenType(String type)	Set access token type.
void	setAccessTokenTypeLookupStrategy(Function<ProfileRequestContext,String> strategy)	Set lookup strategy for access token type.
void	setEncryptionOptional(boolean flag)	Set whether encryption is optional in the face of a missing key, etc.
void	setEncryptionOptionalPredicate(Predicate<ProfileRequestContext> condition)	Set a condition to determine whether encryption is optional in the face of a missing key, etc.
void	setIssuer(String issuer)	Set overridden issuer value.
void	setIssuerLookupStrategy(Function<ProfileRequestContext,String> strategy)	Sets lookup strategy for overridden issuer value.
void	setResolveAttributes(boolean flag)	Set whether attributes should be resolved during the profile.
void	setResolveAttributesPredicate(Predicate<ProfileRequestContext> condition)	Set a condition to determine whether attributes should be resolved during the profile.

Methods inherited from class net.shibboleth.idp.profile.config.AbstractConditionalProfileConfiguration

getActivationCondition, setActivationCondition

Methods inherited from class net.shibboleth.idp.profile.config.AbstractProfileConfiguration

equals, getDisallowedFeatures, getInboundInterceptorFlows, getOutboundInterceptorFlows, getSecurityConfiguration, hashCode, isFeatureDisallowed, setDisallowedFeatures, setDisallowedFeaturesLookupStrategy, setInboundFlowsLookupStrategy, setInboundInterceptorFlows, setInboundInterceptorFlowsLookupStrategy, setOutboundFlowsLookupStrategy, setOutboundInterceptorFlows, setOutboundInterceptorFlowsLookupStrategy, setSecurityConfiguration, setSecurityConfigurationLookupStrategy

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent

setId

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

doInitialize, getId

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, doDestroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.shibboleth.utilities.java.support.component.IdentifiedComponent

getId

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

getInboundInterceptorFlows, getOutboundInterceptorFlows, getSecurityConfiguration

Field Detail

PROTOCOL_URI

@Nonnull
@NotEmpty
public static final String PROTOCOL_URI

OAuth2 Token Revocation URI.

See Also:

Constant Field Values

PROFILE_ID

@Nonnull
@NotEmpty
public static final String PROFILE_ID

ID for this profile configuration.

See Also:

Constant Field Values

issuerLookupStrategy

@Nonnull
private Function<ProfileRequestContext,String> issuerLookupStrategy

Lookup function to override issuer value.

resolveAttributesPredicate

@Nonnull
private Predicate<ProfileRequestContext> resolveAttributesPredicate

Whether attributes should be resolved in the course of the profile.

encryptionOptionalPredicate

@Nonnull
private Predicate<ProfileRequestContext> encryptionOptionalPredicate

Whether encryption is optional in the face of no key, etc.

accessTokenTypeLookupStrategy

@Nonnull
private Function<ProfileRequestContext,String> accessTokenTypeLookupStrategy

Lookup functioon to supply access token type.

accessTokenLifetimeLookupStrategy

@Nonnull
private Function<ProfileRequestContext,Duration> accessTokenLifetimeLookupStrategy

Lookup function to supply access token lifetime.

Constructor Detail

OAuth2TokenAudienceConfiguration

public OAuth2TokenAudienceConfiguration()

Constructor.

OAuth2TokenAudienceConfiguration

public OAuth2TokenAudienceConfiguration(@Nonnull @NotEmpty
                                        String profileId)

Creates a new configuration instance.

Parameters:

profileId - Unique profile identifier.

Method Detail

getIssuer

@Nullable
@NotEmpty
public String getIssuer(@Nullable
                        ProfileRequestContext profileRequestContext)

Specified by:

getIssuer in interface net.shibboleth.idp.profile.config.OverriddenIssuerProfileConfiguration

setIssuer

public void setIssuer(@Nullable @NotEmpty
                      String issuer)

Set overridden issuer value.

Parameters:

issuer - issuer value

setIssuerLookupStrategy

public void setIssuerLookupStrategy(@Nonnull
                                    Function<ProfileRequestContext,String> strategy)

Sets lookup strategy for overridden issuer value.

Parameters:

strategy - lookup strategy

isResolveAttributes

public boolean isResolveAttributes(@Nullable
                                   ProfileRequestContext profileRequestContext)

Specified by:

isResolveAttributes in interface net.shibboleth.idp.profile.config.AttributeResolvingProfileConfiguration

setResolveAttributes

public void setResolveAttributes(boolean flag)

Set whether attributes should be resolved during the profile.

Parameters:

flag - flag to set

setResolveAttributesPredicate

public void setResolveAttributesPredicate(@Nonnull
                                          Predicate<ProfileRequestContext> condition)

Set a condition to determine whether attributes should be resolved during the profile.

Parameters:

condition - condition to set

isEncryptionOptional

public boolean isEncryptionOptional(@Nullable
                                    ProfileRequestContext profileRequestContext)

Get whether encryption is optional in the face of a missing key, etc.

Parameters:

profileRequestContext - current profile request context

Returns:

true iff encryption is optional

setEncryptionOptional

public void setEncryptionOptional(boolean flag)

Set whether encryption is optional in the face of a missing key, etc.

Parameters:

flag - flag to set

setEncryptionOptionalPredicate

public void setEncryptionOptionalPredicate(@Nonnull
                                           Predicate<ProfileRequestContext> condition)

Set a condition to determine whether encryption is optional in the face of a missing key, etc.

Parameters:

condition - condition to set

getAccessTokenType

@Nullable
@NotEmpty
public String getAccessTokenType(@Nullable
                                 ProfileRequestContext profileRequestContext)

Get access token type.

Parameters:

profileRequestContext - profile request context

Returns:

access token type, or null for unspecified/opaque

setAccessTokenType

public void setAccessTokenType(@Nullable @NotEmpty
                               String type)

Set access token type.

Parameters:

type - token type, or null for unspecified/opaque

setAccessTokenTypeLookupStrategy

public void setAccessTokenTypeLookupStrategy(@Nonnull
                                             Function<ProfileRequestContext,String> strategy)

Set lookup strategy for access token type.

Parameters:

strategy - lookup strategy

getAccessTokenLifetime

@Positive
@Nonnull
public Duration getAccessTokenLifetime(@Nullable
                                       ProfileRequestContext profileRequestContext)

Get access token lifetime.

Defaults to 10 minutes.

Parameters:

profileRequestContext - profile request context

Returns:

access token lifetime

setAccessTokenLifetime

public void setAccessTokenLifetime(@Positive @Nonnull
                                   Duration lifetime)

Set the lifetime of an access token.

Parameters:

lifetime - lifetime of an access token in milliseconds

setAccessTokenLifetimeLookupStrategy

public void setAccessTokenLifetimeLookupStrategy(@Nullable
                                                 Function<ProfileRequestContext,Duration> strategy)

Set a lookup strategy for the access token lifetime.

Parameters:

strategy - lookup strategy