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

Interface OAuth2AuthorizationProfileConfiguration

All Known Subinterfaces:

OIDCAuthenticationProfileConfiguration, OIDCAuthenticationRelyingPartyProfileConfiguration, OIDCAuthorizationConfiguration

All Known Implementing Classes:

DefaultOIDCAuthorizationConfiguration

public interface OAuth2AuthorizationProfileConfiguration

Configuration for a generic OAuth 2.0 authorization request.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	OAuth2AuthorizationProfileConfiguration.HttpRequestMethod	Enumeration of the HTTP methods used in various OAuth requests.

Method Summary

Modifier and Type	Method	Description
OAuth2AuthorizationProfileConfiguration.HttpRequestMethod	getHttpRequestMethod(ProfileRequestContext profileRequestContext)	Get the HTTP request method for an authentication request.
String	getResponseMode(ProfileRequestContext profileRequestContext)	Get the response_mode to use for authorization requests.
Set<String>	getResponseModes(ProfileRequestContext profileRequestContext)	Get the response_modes that are allowed to be used in authorization requests.
String	getResponseType(ProfileRequestContext profileRequestContext)	Get the response_type to use for authorization requests.
Set<String>	getScopes(ProfileRequestContext profileRequestContext)	Get the scopes to use in authentication requests.
boolean	isRequireAuthenticationRequest(ProfileRequestContext profileRequestContext)	Get whether client is required to use OIDC authentication request vs plain OAuth2 authorization request.

Method Details

getScopes

@ConfigurationSetting(name="scopes")
@Nullable
@NonnullElements
@Unmodifiable
@NotLive
Set<String> getScopes(@Nullable
 ProfileRequestContext profileRequestContext)

Get the scopes to use in authentication requests.

Parameters:

profileRequestContext - the profile request context

Returns:

the scopes

Since:

2.2.0

getHttpRequestMethod

@ConfigurationSetting(name="httpRequestMethod")
@Nullable
OAuth2AuthorizationProfileConfiguration.HttpRequestMethod getHttpRequestMethod(@Nullable
 ProfileRequestContext profileRequestContext)

Get the HTTP request method for an authentication request.

Parameters:

profileRequestContext - profile request context

Returns:

the HTTP request method

getResponseMode

@ConfigurationSetting(name="responseMode")
@Nullable
@NotEmpty
String getResponseMode(@Nullable
 ProfileRequestContext profileRequestContext)

Get the response_mode to use for authorization requests.

Parameters:

profileRequestContext - the profile request context

Returns:

the response_mode

Since:

2.2.0

getResponseType

@ConfigurationSetting(name="responseType")
@Nullable
@NotEmpty
String getResponseType(@Nullable
 ProfileRequestContext profileRequestContext)

Get the response_type to use for authorization requests.

Parameters:

profileRequestContext - the profile request context

Returns:

the response_type

Since:

2.2.0

getResponseModes

@ConfigurationSetting(name="responseModes")
@Nonnull
@NonnullElements
@Unmodifiable
@NotLive
Set<String> getResponseModes(@Nullable
 ProfileRequestContext profileRequestContext)

Get the response_modes that are allowed to be used in authorization requests.

Parameters:

profileRequestContext - the profile request context

Returns:

the response_mode

Since:

3.1.0

isRequireAuthenticationRequest

@ConfigurationSetting(name="requireAuthenticationRequest")
boolean isRequireAuthenticationRequest(@Nullable
 ProfileRequestContext profileRequestContext)

Get whether client is required to use OIDC authentication request vs plain OAuth2 authorization request.

Parameters:

profileRequestContext - profile request context

Returns:

whether client is required to use OIDC authentication request vs plain OAuth2 authorization request

Since:

3.1.0