Package net.shibboleth.oidc.profile.config

Interface OIDCAuthenticationProfileConfiguration

All Superinterfaces:

OAuth2AuthorizationProfileConfiguration

All Known Subinterfaces:

OIDCAuthenticationRelyingPartyProfileConfiguration, OIDCAuthorizationConfiguration

public interface OIDCAuthenticationProfileConfiguration
extends OAuth2AuthorizationProfileConfiguration

Generic configuration for an OIDC 1.0 authentication request.

Nested Class Summary

Nested classes/interfaces inherited from interface net.shibboleth.oidc.profile.oauth2.config.OAuth2AuthorizationProfileConfiguration

OAuth2AuthorizationProfileConfiguration.HttpRequestMethod

Field Summary

Fields

Modifier and Type	Field	Description
static String	PROFILE_ID	ID for this profile configuration.

Method Summary

Modifier and Type	Method	Description
Function<Collection<String>,Collection<Principal>>	getAuthenticationContextClassReferenceTranslationStrategy(ProfileRequestContext prc)	Get the function used to translate ACRs in the id_token into an appropriate set of custom Principal objects to populate into the subject.
Function<Collection<String>,Collection<Principal>>	getAuthenticationMethodsReferencesTranslationStrategy(ProfileRequestContext prc)	Get the function used to translate AMRs in the id_token into an appropriate set of custom Principal objects to populate into the subject.
String	getLoginHint(ProfileRequestContext profileRequestContext)	Get the login_hint to use.
Duration	getMaxAuthenticationAge(ProfileRequestContext profileRequestContext)	Get the max authentication age.
boolean	isUseRequestObject(ProfileRequestContext profileRequestContext)	Should OpenID specific authentication request parameters should be passed in a single, self contained, JWT?

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

getHttpRequestMethod, getResponseMode, getResponseType, getScopes

Field Detail

PROFILE_ID

@Nonnull
@NotEmpty
static final String PROFILE_ID

ID for this profile configuration.

See Also:

Constant Field Values

Method Detail

isUseRequestObject

boolean isUseRequestObject(@Nullable
                           ProfileRequestContext profileRequestContext)

Should OpenID specific authentication request parameters should be passed in a single, self contained, JWT?

Parameters:

profileRequestContext - the profile request context

Returns:

whether authentication request parameters should be passed in a single, self contained, JWT

getAuthenticationMethodsReferencesTranslationStrategy

@Nullable
Function<Collection<String>,Collection<Principal>> getAuthenticationMethodsReferencesTranslationStrategy(@Nullable
                                                                                                               ProfileRequestContext prc)

Get the function used to translate AMRs in the id_token into an appropriate set of custom Principal objects to populate into the subject.

Parameters:

prc - current profile request context

Returns:

translation function

Since:

2.2.0

getAuthenticationContextClassReferenceTranslationStrategy

@Nullable
Function<Collection<String>,Collection<Principal>> getAuthenticationContextClassReferenceTranslationStrategy(@Nullable
                                                                                                                   ProfileRequestContext prc)

Get the function used to translate ACRs in the id_token into an appropriate set of custom Principal objects to populate into the subject.

Parameters:

prc - current profile request context

Returns:

translation function

Since:

2.2.0

getLoginHint

@Nullable
@NotEmpty
String getLoginHint(@Nullable
                    ProfileRequestContext profileRequestContext)

Get the login_hint to use.

Parameters:

profileRequestContext - profile request context

Returns:

the login_hint to use

Since:

2.2.0

getMaxAuthenticationAge

@Nullable
Duration getMaxAuthenticationAge(@Nullable
                                 ProfileRequestContext profileRequestContext)

Get the max authentication age.

Parameters:

profileRequestContext - profile request context

Returns:

max authentication age

Since:

2.2.0