io.micronaut.security.oauth2.openid.configuration

Class OpenIdConfiguration

java.lang.Object

io.micronaut.security.oauth2.openid.configuration.OpenIdConfiguration

All Implemented Interfaces:

OpenIdProviderMetadata, OpenIdProviderMetadataSession

@Introspected
public class OpenIdConfiguration
extends java.lang.Object
implements OpenIdProviderMetadata, OpenIdProviderMetadataSession

Since:

1.0.0

Author:

Sergio del Amo

See Also:

OpenID connect Discovery Spec

Constructor Summary

Constructors

Constructor and Description
OpenIdConfiguration() Empty Constructor.

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getAcrValuesSupported() acr_values_supported.
java.lang.String	getAuthorizationEndpoint() authorization_endpoint.
java.lang.String	getCheckSessionIframe() check_session_iframe.
java.util.List<java.lang.String>	getClaimsLocalesSupported() claims_locales_supported OPTIONAL.
java.lang.Boolean	getClaimsParameterSupported() claims_parameter_supported OPTIONAL.
java.util.List<java.lang.String>	getClaimsSupported() claims_supported RECOMMENDED.
java.util.List<java.lang.String>	getClaimTypesSupported() claim_types_supported OPTIONAL.
java.util.List<java.lang.String>	getCodeChallengeMethodsSupported() code_challenge_methods_supported.
java.util.List<java.lang.String>	getDefaultGrantTypesSupported() As specified in Open ID Discovery Spec, if omitted, the default value is ["authorization_code", "implicit"].
java.lang.Boolean	getDefaultRequestParameterSupported()
java.lang.Boolean	getDefaultRequestUriParameterSupported()
java.lang.Boolean	getDefaultRequireRequestUriRegistration()
java.util.List<java.lang.String>	getDefaultResponseTypesSupported()
java.util.List<java.lang.String>	getDisplayValuesSupported() display_values_supported OPTIONAL.
java.lang.String	getEndSessionEndpoint() end_session_endpoint.
java.util.List<java.lang.String>	getGrantTypesSupported() grant_types_supported.
java.util.List<java.lang.String>	getIdTokenEncryptionEncValuesSupported() id_token_encryption_enc_values_supported OPTIONAL.
java.util.List<java.lang.String>	getIdTokenSigningAlgValuesSupported() id_token_signing_alg_values_supported REQUIRED.
java.lang.String	getIntrospectionEndpoint()
java.util.List<java.lang.String>	getIntrospectionEndpointAuthMethodsSupported()
java.lang.String	getIssuer() issuer.
java.lang.String	getJwksUri() jwks_uri.
java.lang.String	getOpPolicyUri() op_policy_uri OPTIONAL.
java.lang.String	getOpTosUri() op_tos_uri.
java.lang.String	getRegistrationEndpoint() registration_endpoint.
java.util.List<java.lang.String>	getRequestObjectEncryptionAlgValuesSupported() request_object_encryption_alg_values_supported OPTIONAL.
java.util.List<java.lang.String>	getRequestObjectEncryptionEncValuesSupported() request_object_encryption_enc_values_supported OPTIONAL.
java.util.List<java.lang.String>	getRequestObjectSigningAlgValuesSupported() request_object_signing_alg_values_supported.
java.lang.Boolean	getRequestParameterSupported() request_parameter_supported OPTIONAL.
java.lang.Boolean	getRequestUriParameterSupported() request_uri_parameter_supported OPTIONAL.
java.lang.Boolean	getRequireRequestUriRegistration() require_request_uri_registration OPTIONAL.
java.util.List<java.lang.String>	getResponseModesSupported() response_modes_supported.
java.util.List<java.lang.String>	getResponseTypesSupported() As specified in Open ID Discovery Spec, if omitted, the default for Dynamic OpenID Providers is ["query", "fragment"].
java.lang.String	getRevocationEndpoint()
java.util.List<java.lang.String>	getRevocationEndpointAuthMethodsSupported()
java.util.List<java.lang.String>	getScopesSupported() scopes_supported.
java.lang.String	getServiceDocumentation() service_documentation OPTIONAL.
java.util.List<java.lang.String>	getSubjectTypesSupported() subject_types_supported.
java.lang.String	getTokenEndpoint() token_endpoint.
java.util.List<java.lang.String>	getTokenEndpointAuthMethodsSupported() token_endpoint_auth_methods_supported OPTIONAL.
java.util.List<java.lang.String>	getTokenEndpointAuthSigningAlgValuesSupported() token_endpoint_auth_signing_alg_values_supported OPTIONAL.
java.util.List<java.lang.String>	getUriLocalesSupported() ui_locales_supported OPTIONAL.
java.util.List<java.lang.String>	getUserInfoEncryptionAlgValuesSupported() userinfo_encryption_alg_values_supported.
java.util.List<java.lang.String>	getUserinfoEncryptionEncValuesSupported() userinfo_encryption_enc_values_supported OPTIONAL.
java.lang.String	getUserinfoEndpoint() userinfo_endpoint.
void	setAcrValuesSupported(java.util.List<java.lang.String> acrValuesSupported)
void	setAuthorizationEndpoint(java.lang.String authorizationEndpoint)
void	setCheckSessionIframe(java.lang.String checkSessionIframe)
void	setClaimsLocalesSupported(java.util.List<java.lang.String> claimsLocalesSupported)
void	setClaimsParameterSupported(java.lang.Boolean claimsParameterSupported)
void	setClaimsSupported(java.util.List<java.lang.String> claimsSupported)
void	setClaimTypesSupported(java.util.List<java.lang.String> claimTypesSupported)
void	setCodeChallengeMethodsSupported(java.util.List<java.lang.String> codeChallengeMethodsSupported)
void	setDisplayValuesSupported(java.util.List<java.lang.String> displayValuesSupported)
void	setEndSessionEndpoint(java.lang.String endSessionEndpoint)
void	setGrantTypesSupported(java.util.List<java.lang.String> grantTypesSupported)
void	setIdTokenEncryptionEncValuesSupported(java.util.List<java.lang.String> idTokenEncryptionEncValuesSupported)
void	setIdTokenSigningAlgValuesSupported(java.util.List<java.lang.String> idTokenSigningAlgValuesSupported)
void	setIntrospectionEndpoint(java.lang.String introspectionEndpoint)
void	setIntrospectionEndpointAuthMethodsSupported(java.util.List<java.lang.String> introspectionEndpointAuthMethodsSupported)
void	setIssuer(java.lang.String issuer)
void	setJwksUri(java.lang.String jwksUri)
void	setOpPolicyUri(java.lang.String opPolicyUri)
void	setOpTosUri(java.lang.String opTosUri)
void	setRegistrationEndpoint(java.lang.String registrationEndpoint)
void	setRequestObjectEncryptionAlgValuesSupported(java.util.List<java.lang.String> requestObjectEncryptionAlgValuesSupported)
void	setRequestObjectEncryptionEncValuesSupported(java.util.List<java.lang.String> requestObjectEncryptionEncValuesSupported)
void	setRequestObjectSigningAlgValuesSupported(java.util.List<java.lang.String> requestObjectSigningAlgValuesSupported)
void	setRequestParameterSupported(java.lang.Boolean requestParameterSupported)
void	setRequestUriParameterSupported(java.lang.Boolean requestUriParameterSupported)
void	setRequireRequestUriRegistration(java.lang.Boolean requireRequestUriRegistration)
void	setResponseModesSupported(java.util.List<java.lang.String> responseModesSupported)
void	setResponseTypesSupported(java.util.List<java.lang.String> responseTypesSupported)
void	setRevocationEndpoint(java.lang.String revocationEndpoint)
void	setRevocationEndpointAuthMethodsSupported(java.util.List<java.lang.String> revocationEndpointAuthMethodsSupported)
void	setScopesSupported(java.util.List<java.lang.String> scopesSupported)
void	setServiceDocumentation(java.lang.String serviceDocumentation)
void	setSubjectTypesSupported(java.util.List<java.lang.String> subjectTypesSupported)
void	setTokenEndpoint(java.lang.String tokenEndpoint)
void	setTokenEndpointAuthMethodsSupported(java.util.List<java.lang.String> tokenEndpointAuthMethodsSupported)
void	setTokenEndpointAuthSigningAlgValuesSupported(java.util.List<java.lang.String> tokenEndpointAuthSigningAlgValuesSupported)
void	setUriLocalesSupported(java.util.List<java.lang.String> uriLocalesSupported)
void	setUserinfoEncryptionAlgValuesSupported(java.util.List<java.lang.String> userinfoEncryptionAlgValuesSupported)
void	setUserinfoEncryptionEncValuesSupported(java.util.List<java.lang.String> userinfoEncryptionEncValuesSupported)
void	setUserinfoEndpoint(java.lang.String userinfoEndpoint)

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenIdConfiguration

public OpenIdConfiguration()

Empty Constructor.

Method Detail

getRequireRequestUriRegistration

@Nullable
public java.lang.Boolean getRequireRequestUriRegistration()

Description copied from interface: OpenIdProviderMetadata

require_request_uri_registration OPTIONAL.

Specified by:

getRequireRequestUriRegistration in interface OpenIdProviderMetadata

Returns:

Boolean value specifying whether the OP requires any request_uri values used to be pre-registered using the request_uris registration parameter.

getDefaultRequireRequestUriRegistration

@Nullable
public java.lang.Boolean getDefaultRequireRequestUriRegistration()

Returns:

If require_request_uri_registration omitted, the default value is false.

setRequireRequestUriRegistration

public void setRequireRequestUriRegistration(@Nullable
                                             java.lang.Boolean requireRequestUriRegistration)

Parameters:

requireRequestUriRegistration - Boolean value specifying whether the OP requires any request_uri values used to be pre-registered using the request_uris registration parameter.

getAuthorizationEndpoint

@Nonnull
public java.lang.String getAuthorizationEndpoint()

Description copied from interface: OpenIdProviderMetadata

authorization_endpoint. REQUIRED.

Specified by:

getAuthorizationEndpoint in interface OpenIdProviderMetadata

Returns:

URL of the Open ID Provider's OAuth 2.0 Authorization Endpoint

setAuthorizationEndpoint

public void setAuthorizationEndpoint(@Nonnull
                                     java.lang.String authorizationEndpoint)

Parameters:

authorizationEndpoint - URL of the Open ID Provider's OAuth 2.0 Authorization Endpoint.

setUserinfoEncryptionEncValuesSupported

public void setUserinfoEncryptionEncValuesSupported(@Nullable
                                                    java.util.List<java.lang.String> userinfoEncryptionEncValuesSupported)

Parameters:

userinfoEncryptionEncValuesSupported - List of the JWE encryption algorithms (enc values) [JWA] supported by the UserInfo Endpoint to encode the Claims in a JWT.

getIdTokenSigningAlgValuesSupported

@Nonnull
public java.util.List<java.lang.String> getIdTokenSigningAlgValuesSupported()

Description copied from interface: OpenIdProviderMetadata

id_token_signing_alg_values_supported REQUIRED.

Specified by:

getIdTokenSigningAlgValuesSupported in interface OpenIdProviderMetadata

Returns:

List of the JWS signing algorithms (alg values) supported by the OP for the ID Token to encode the Claims in a JWT [JWT].

getIdTokenEncryptionEncValuesSupported

@Nullable
public java.util.List<java.lang.String> getIdTokenEncryptionEncValuesSupported()

Description copied from interface: OpenIdProviderMetadata

id_token_encryption_enc_values_supported OPTIONAL.

Specified by:

getIdTokenEncryptionEncValuesSupported in interface OpenIdProviderMetadata

Returns:

List of the JWE encryption algorithms (enc values) supported by the OP for the ID Token to encode the Claims in a JWT [JWT].

setIdTokenEncryptionEncValuesSupported

public void setIdTokenEncryptionEncValuesSupported(@Nullable
                                                   java.util.List<java.lang.String> idTokenEncryptionEncValuesSupported)

Parameters:

idTokenEncryptionEncValuesSupported - List of the JWE encryption algorithms (enc values) supported by the OP for the ID Token to encode the Claims in a JWT.

getUserInfoEncryptionAlgValuesSupported

@Nullable
public java.util.List<java.lang.String> getUserInfoEncryptionAlgValuesSupported()

Description copied from interface: OpenIdProviderMetadata

userinfo_encryption_alg_values_supported. OPTIONAL.

Specified by:

getUserInfoEncryptionAlgValuesSupported in interface OpenIdProviderMetadata

Returns:

List of the JWE [JWE] encryption algorithms (alg values) [JWA] supported by the UserInfo Endpoint to encode the Claims in a JWT [JWT].

setUserinfoEncryptionAlgValuesSupported

public void setUserinfoEncryptionAlgValuesSupported(@Nullable
                                                    java.util.List<java.lang.String> userinfoEncryptionAlgValuesSupported)

Parameters:

userinfoEncryptionAlgValuesSupported - List of the JWE [JWE] encryption algorithms (alg values) [JWA] supported by the UserInfo Endpoint to encode the Claims in a JWT.

getUserinfoEncryptionEncValuesSupported

@Nullable
public java.util.List<java.lang.String> getUserinfoEncryptionEncValuesSupported()

Description copied from interface: OpenIdProviderMetadata

userinfo_encryption_enc_values_supported OPTIONAL.

Specified by:

getUserinfoEncryptionEncValuesSupported in interface OpenIdProviderMetadata

Returns:

List of the JWE encryption algorithms (enc values) [JWA] supported by the UserInfo Endpoint to encode the Claims in a JWT [JWT].

setIdTokenSigningAlgValuesSupported

public void setIdTokenSigningAlgValuesSupported(@Nonnull
                                                java.util.List<java.lang.String> idTokenSigningAlgValuesSupported)

Parameters:

idTokenSigningAlgValuesSupported - List of the JWE encryption algorithms (enc values) supported by the OP for the ID Token to encode the Claims in a JWT.

getIssuer

@Nonnull
public java.lang.String getIssuer()

Description copied from interface: OpenIdProviderMetadata

issuer. REQUIRED.

Specified by:

getIssuer in interface OpenIdProviderMetadata

Returns:

URL using the https scheme with no query or fragment component that the Open ID Provider asserts as its Issuer Identifier.

setIssuer

public void setIssuer(@Nonnull
                      java.lang.String issuer)

Parameters:

issuer - URL using the https scheme with no query or fragment component that the Open ID Provider asserts as its Issuer Identifier.

getJwksUri

@Nonnull
public java.lang.String getJwksUri()

Description copied from interface: OpenIdProviderMetadata

jwks_uri. REQUIRED

Specified by:

getJwksUri in interface OpenIdProviderMetadata

Returns:

URL of the Open ID Provider's JSON Web Key Set

setJwksUri

public void setJwksUri(@Nonnull
                       java.lang.String jwksUri)

Parameters:

jwksUri - URL of the Open ID Provider's JSON Web Key Set.

getResponseTypesSupported

@Nullable
public java.util.List<java.lang.String> getResponseTypesSupported()

As specified in Open ID Discovery Spec, if omitted, the default for Dynamic OpenID Providers is ["query", "fragment"].

Specified by:

getResponseTypesSupported in interface OpenIdProviderMetadata

Returns:

Supported response types.

getDefaultResponseTypesSupported

@Nonnull
public java.util.List<java.lang.String> getDefaultResponseTypesSupported()

Returns:

if Response Types Supported is ommited, default for Dynamic OpenID Providers is ["query", "fragment"].

setResponseTypesSupported

public void setResponseTypesSupported(@Nullable
                                      java.util.List<java.lang.String> responseTypesSupported)

Parameters:

responseTypesSupported - List of the OAuth 2.0 response_type values that this Open ID Provider supports.

getScopesSupported

@Nullable
public java.util.List<java.lang.String> getScopesSupported()

Description copied from interface: OpenIdProviderMetadata

scopes_supported. RECOMMENDED.

Specified by:

getScopesSupported in interface OpenIdProviderMetadata

Returns:

List of the OAuth 2.0 [RFC6749] scope values that this server supports.

setScopesSupported

public void setScopesSupported(@Nullable
                               java.util.List<java.lang.String> scopesSupported)

Parameters:

scopesSupported - List of the OAuth 2.0 [RFC6749] scope values that this server supports.

getSubjectTypesSupported

@Nonnull
public java.util.List<java.lang.String> getSubjectTypesSupported()

Description copied from interface: OpenIdProviderMetadata

subject_types_supported. REQUIRED

Specified by:

getSubjectTypesSupported in interface OpenIdProviderMetadata

Returns:

List of the Subject Identifier types that this OP supports.

setSubjectTypesSupported

public void setSubjectTypesSupported(@Nonnull
                                     java.util.List<java.lang.String> subjectTypesSupported)

Parameters:

subjectTypesSupported - List of the Subject Identifier types that this OP supports.

getTokenEndpoint

@Nullable
public java.lang.String getTokenEndpoint()

Description copied from interface: OpenIdProviderMetadata

token_endpoint. This is REQUIRED unless only the Implicit Flow is used.

Specified by:

getTokenEndpoint in interface OpenIdProviderMetadata

Returns:

URL of the Open ID Provider's OAuth 2.0 Token Endpoint

setTokenEndpoint

public void setTokenEndpoint(@Nullable
                             java.lang.String tokenEndpoint)

Parameters:

tokenEndpoint - URL of the Open ID Provider's OAuth 2.0 Token Endpoint.

getTokenEndpointAuthMethodsSupported

@Nullable
public java.util.List<java.lang.String> getTokenEndpointAuthMethodsSupported()

Description copied from interface: OpenIdProviderMetadata

token_endpoint_auth_methods_supported OPTIONAL.

Specified by:

getTokenEndpointAuthMethodsSupported in interface OpenIdProviderMetadata

Returns:

List of Client Authentication methods supported by this Token Endpoint.

getTokenEndpointAuthSigningAlgValuesSupported

@Nullable
public java.util.List<java.lang.String> getTokenEndpointAuthSigningAlgValuesSupported()

Description copied from interface: OpenIdProviderMetadata

token_endpoint_auth_signing_alg_values_supported OPTIONAL.

Specified by:

getTokenEndpointAuthSigningAlgValuesSupported in interface OpenIdProviderMetadata

Returns:

List of the JWS signing algorithms (alg values) supported by the Token Endpoint.

setTokenEndpointAuthSigningAlgValuesSupported

public void setTokenEndpointAuthSigningAlgValuesSupported(@Nullable
                                                          java.util.List<java.lang.String> tokenEndpointAuthSigningAlgValuesSupported)

Parameters:

tokenEndpointAuthSigningAlgValuesSupported - List of the JWS signing algorithms (alg values) supported by the Token Endpoint.

getDisplayValuesSupported

@Nullable
public java.util.List<java.lang.String> getDisplayValuesSupported()

Description copied from interface: OpenIdProviderMetadata

display_values_supported OPTIONAL.

Specified by:

getDisplayValuesSupported in interface OpenIdProviderMetadata

Returns:

List of the display parameter values that the OpenID Provider supports.

setDisplayValuesSupported

public void setDisplayValuesSupported(@Nullable
                                      java.util.List<java.lang.String> displayValuesSupported)

Parameters:

displayValuesSupported - List of the display parameter values that the OpenID Provider supports.

getClaimTypesSupported

@Nullable
public java.util.List<java.lang.String> getClaimTypesSupported()

Description copied from interface: OpenIdProviderMetadata

claim_types_supported OPTIONAL.

Specified by:

getClaimTypesSupported in interface OpenIdProviderMetadata

Returns:

List of the Claim Types that the OpenID Provider supports.

setClaimTypesSupported

public void setClaimTypesSupported(@Nullable
                                   java.util.List<java.lang.String> claimTypesSupported)

Parameters:

claimTypesSupported - List of the Claim Types that the OpenID Provider supports.

setTokenEndpointAuthMethodsSupported

public void setTokenEndpointAuthMethodsSupported(@Nullable
                                                 java.util.List<java.lang.String> tokenEndpointAuthMethodsSupported)

Parameters:

tokenEndpointAuthMethodsSupported - List of Client Authentication methods supported by this Token Endpoint.

getUserinfoEndpoint

@Nullable
public java.lang.String getUserinfoEndpoint()

Description copied from interface: OpenIdProviderMetadata

userinfo_endpoint. RECOMMENDED. This URL MUST use the https scheme and MAY contain port, path, and query parameter components.

Specified by:

getUserinfoEndpoint in interface OpenIdProviderMetadata

Returns:

URL of the Open ID Provider's UserInfo Endpoint

setUserinfoEndpoint

public void setUserinfoEndpoint(@Nullable
                                java.lang.String userinfoEndpoint)

Parameters:

userinfoEndpoint - URL of the Open ID Provider's UserInfo Endpoint.

getResponseModesSupported

@Nullable
public java.util.List<java.lang.String> getResponseModesSupported()

Description copied from interface: OpenIdProviderMetadata

response_modes_supported. OPTIONAL

Specified by:

getResponseModesSupported in interface OpenIdProviderMetadata

Returns:

List of the OAuth 2.0 response_mode values that this Open ID Provider supports.

setResponseModesSupported

public void setResponseModesSupported(@Nullable
                                      java.util.List<java.lang.String> responseModesSupported)

Parameters:

responseModesSupported - List of the OAuth 2.0 response_mode values that this Open ID Provider supports.

getGrantTypesSupported

@Nullable
public java.util.List<java.lang.String> getGrantTypesSupported()

Description copied from interface: OpenIdProviderMetadata

grant_types_supported. OPTIONAL

Specified by:

getGrantTypesSupported in interface OpenIdProviderMetadata

Returns:

List of the OAuth 2.0 Grant Type values that this Open ID Provider supports.

getDefaultGrantTypesSupported

@Nonnull
public java.util.List<java.lang.String> getDefaultGrantTypesSupported()

As specified in Open ID Discovery Spec, if omitted, the default value is ["authorization_code", "implicit"].

Returns:

Default Grant Types if grantTypesSupported is ommited.

getAcrValuesSupported

@Nullable
public java.util.List<java.lang.String> getAcrValuesSupported()

Description copied from interface: OpenIdProviderMetadata

acr_values_supported. OPTIONAL.

Specified by:

getAcrValuesSupported in interface OpenIdProviderMetadata

Returns:

List of the Authentication Context Class References that this OP supports.

setAcrValuesSupported

public void setAcrValuesSupported(@Nullable
                                  java.util.List<java.lang.String> acrValuesSupported)

Parameters:

acrValuesSupported - List of the Authentication Context Class References that this OP supports.

setGrantTypesSupported

public void setGrantTypesSupported(@Nullable
                                   java.util.List<java.lang.String> grantTypesSupported)

Parameters:

grantTypesSupported - List of the OAuth 2.0 Grant Type values that this Open ID Provider supports.

getRegistrationEndpoint

@Nullable
public java.lang.String getRegistrationEndpoint()

Description copied from interface: OpenIdProviderMetadata

registration_endpoint. RECOMMENDED

Specified by:

getRegistrationEndpoint in interface OpenIdProviderMetadata

Returns:

URL of the Open ID Provider's Dynamic Client Registration Endpoint

setRegistrationEndpoint

public void setRegistrationEndpoint(@Nullable
                                    java.lang.String registrationEndpoint)

Parameters:

registrationEndpoint - URL of the Open ID Provider's Dynamic Client Registration Endpoint.

getClaimsSupported

@Nullable
public java.util.List<java.lang.String> getClaimsSupported()

Description copied from interface: OpenIdProviderMetadata

claims_supported RECOMMENDED.

Specified by:

getClaimsSupported in interface OpenIdProviderMetadata

Returns:

List of the Claim Names of the Claims that the OpenID Provider MAY be able to supply values for.

getServiceDocumentation

@Nullable
public java.lang.String getServiceDocumentation()

Description copied from interface: OpenIdProviderMetadata

service_documentation OPTIONAL.

Specified by:

getServiceDocumentation in interface OpenIdProviderMetadata

Returns:

URL of a page containing human-readable information that developers might want or need to know when using the OpenID Provider.

setServiceDocumentation

public void setServiceDocumentation(@Nullable
                                    java.lang.String serviceDocumentation)

Parameters:

serviceDocumentation - URL of a page containing human-readable information that developers might want or need to know when using the OpenID Provider.

getClaimsLocalesSupported

@Nullable
public java.util.List<java.lang.String> getClaimsLocalesSupported()

Description copied from interface: OpenIdProviderMetadata

claims_locales_supported OPTIONAL.

Specified by:

getClaimsLocalesSupported in interface OpenIdProviderMetadata

Returns:

Languages and scripts supported for values in Claims

setClaimsLocalesSupported

public void setClaimsLocalesSupported(@Nullable
                                      java.util.List<java.lang.String> claimsLocalesSupported)

Parameters:

claimsLocalesSupported - Languages and scripts supported for values in Claims.

getUriLocalesSupported

@Nullable
public java.util.List<java.lang.String> getUriLocalesSupported()

Description copied from interface: OpenIdProviderMetadata

ui_locales_supported OPTIONAL.

Specified by:

getUriLocalesSupported in interface OpenIdProviderMetadata

Returns:

Languages and scripts supported for the user interface

setUriLocalesSupported

public void setUriLocalesSupported(@Nullable
                                   java.util.List<java.lang.String> uriLocalesSupported)

Parameters:

uriLocalesSupported - Languages and scripts supported for the user interface.

getClaimsParameterSupported

@Nullable
public java.lang.Boolean getClaimsParameterSupported()

Description copied from interface: OpenIdProviderMetadata

claims_parameter_supported OPTIONAL.

Specified by:

getClaimsParameterSupported in interface OpenIdProviderMetadata

Returns:

Boolean value specifying whether the OP supports use of the claims parameter.

setClaimsParameterSupported

public void setClaimsParameterSupported(@Nullable
                                        java.lang.Boolean claimsParameterSupported)

Parameters:

claimsParameterSupported - Boolean value specifying whether the OP supports use of the claims parameter.

setClaimsSupported

public void setClaimsSupported(@Nullable
                               java.util.List<java.lang.String> claimsSupported)

Parameters:

claimsSupported - List of the Claim Names of the Claims that the OpenID Provider MAY be able to supply values for.

getCodeChallengeMethodsSupported

@Nullable
public java.util.List<java.lang.String> getCodeChallengeMethodsSupported()

Description copied from interface: OpenIdProviderMetadata

code_challenge_methods_supported.

Specified by:

getCodeChallengeMethodsSupported in interface OpenIdProviderMetadata

Returns:

List of the supported transformation methods by the authorisation code verifier for Proof Key for Code Exchange (PKCE).

setCodeChallengeMethodsSupported

public void setCodeChallengeMethodsSupported(@Nullable
                                             java.util.List<java.lang.String> codeChallengeMethodsSupported)

Parameters:

codeChallengeMethodsSupported - List of the supported transformation methods by the authorisation code verifier for Proof Key for Code Exchange (PKCE).

getIntrospectionEndpoint

@Nullable
public java.lang.String getIntrospectionEndpoint()

Specified by:

getIntrospectionEndpoint in interface OpenIdProviderMetadata

Returns:

The fully qualified URL of the server's introspection endpoint defined by OAuth Token Introspection [RFC7662]

See Also:

OAuth 2.0 Token Introspection

setIntrospectionEndpoint

public void setIntrospectionEndpoint(@Nullable
                                     java.lang.String introspectionEndpoint)

Parameters:

introspectionEndpoint - The fully qualified URL of the server's introspection endpoint defined by OAuth Token Introspection [RFC7662].

getIntrospectionEndpointAuthMethodsSupported

@Nullable
public java.util.List<java.lang.String> getIntrospectionEndpointAuthMethodsSupported()

Specified by:

getIntrospectionEndpointAuthMethodsSupported in interface OpenIdProviderMetadata

Returns:

List of Client Authentication methods supported by Introspection Endpoint

setIntrospectionEndpointAuthMethodsSupported

public void setIntrospectionEndpointAuthMethodsSupported(@Nullable
                                                         java.util.List<java.lang.String> introspectionEndpointAuthMethodsSupported)

Parameters:

introspectionEndpointAuthMethodsSupported - List of Client Authentication methods supported by Introspection Endpoint.

getRevocationEndpoint

@Nullable
public java.lang.String getRevocationEndpoint()

Specified by:

getRevocationEndpoint in interface OpenIdProviderMetadata

Returns:

The fully qualified URL of the server's revocation endpoint defined by Oauth Token Revocation.

See Also:

OAuth 2.0 Token Revocation

setRevocationEndpoint

public void setRevocationEndpoint(@Nullable
                                  java.lang.String revocationEndpoint)

Parameters:

revocationEndpoint - The fully qualified URL of the server's revocation endpoint defined by Oauth Token Revocation.

getRevocationEndpointAuthMethodsSupported

@Nullable
public java.util.List<java.lang.String> getRevocationEndpointAuthMethodsSupported()

Specified by:

getRevocationEndpointAuthMethodsSupported in interface OpenIdProviderMetadata

Returns:

List of Client Authentication methods supported by Revocation Endpoint

setRevocationEndpointAuthMethodsSupported

public void setRevocationEndpointAuthMethodsSupported(@Nullable
                                                      java.util.List<java.lang.String> revocationEndpointAuthMethodsSupported)

Parameters:

revocationEndpointAuthMethodsSupported - List of Client Authentication methods supported by Revocation Endpoint.

setCheckSessionIframe

public void setCheckSessionIframe(@Nullable
                                  java.lang.String checkSessionIframe)

Parameters:

checkSessionIframe - URL of an OP iframe that supports cross-origin communications for session state information with the RP Client, using the HTML5 postMessage API.

getCheckSessionIframe

@Nullable
public java.lang.String getCheckSessionIframe()

Description copied from interface: OpenIdProviderMetadataSession

check_session_iframe. REQUIRED

Specified by:

getCheckSessionIframe in interface OpenIdProviderMetadataSession

Returns:

URL of an OP iframe that supports cross-origin communications for session state information with the RP Client, using the HTML5 postMessage API.

getEndSessionEndpoint

@Nullable
public java.lang.String getEndSessionEndpoint()

Description copied from interface: OpenIdProviderMetadataSession

end_session_endpoint. REQUIRED

Specified by:

getEndSessionEndpoint in interface OpenIdProviderMetadataSession

Returns:

URL at the OP to which an RP can perform a redirect to request that the End-User be logged out at the OP.

setEndSessionEndpoint

public void setEndSessionEndpoint(@Nullable
                                  java.lang.String endSessionEndpoint)

Parameters:

endSessionEndpoint - URL at the OP to which an RP can perform a redirect to request that the End-User be logged out at the OP.

getRequestParameterSupported

@Nullable
public java.lang.Boolean getRequestParameterSupported()

Description copied from interface: OpenIdProviderMetadata

request_parameter_supported OPTIONAL.

Specified by:

getRequestParameterSupported in interface OpenIdProviderMetadata

Returns:

Boolean value specifying whether the OP supports use of the request parameter, with true indicating support.

getDefaultRequestParameterSupported

@Nonnull
public java.lang.Boolean getDefaultRequestParameterSupported()

Returns:

As per spec, If requestParameterSupported omitted, the default value is false.

getRequestUriParameterSupported

@Nullable
public java.lang.Boolean getRequestUriParameterSupported()

Description copied from interface: OpenIdProviderMetadata

request_uri_parameter_supported OPTIONAL.

Specified by:

getRequestUriParameterSupported in interface OpenIdProviderMetadata

Returns:

Boolean value specifying whether the OP supports use of the request_uri parameter, with true indicating support.

getDefaultRequestUriParameterSupported

@Nonnull
public java.lang.Boolean getDefaultRequestUriParameterSupported()

Returns:

As per spec, If requestUriParameterSupported omitted, the default value is false.

setRequestUriParameterSupported

public void setRequestUriParameterSupported(@Nullable
                                            java.lang.Boolean requestUriParameterSupported)

Parameters:

requestUriParameterSupported - Boolean value specifying whether the OP requires any request_uri values used to be pre-registered using the request_uris registration parameter.

getOpPolicyUri

@Nullable
public java.lang.String getOpPolicyUri()

Description copied from interface: OpenIdProviderMetadata

op_policy_uri OPTIONAL.

Specified by:

getOpPolicyUri in interface OpenIdProviderMetadata

Returns:

URL that the OpenID Provider provides to the person registering the Client to read about the OP's requirements on how the Relying Party can use the data provided by the OP.

setOpPolicyUri

public void setOpPolicyUri(@Nullable
                           java.lang.String opPolicyUri)

Parameters:

opPolicyUri - URL that the OpenID Provider provides to the person registering the Client to read about the OP's requirements on how the Relying Party can use the data provided by the OP.

getOpTosUri

@Nullable
public java.lang.String getOpTosUri()

Description copied from interface: OpenIdProviderMetadata

op_tos_uri. OPTIONAL.

Specified by:

getOpTosUri in interface OpenIdProviderMetadata

Returns:

URL that the OpenID Provider provides to the person registering the Client to read about OpenID Provider's terms of service.

setOpTosUri

public void setOpTosUri(@Nullable
                        java.lang.String opTosUri)

Parameters:

opTosUri - URL that the OpenID Provider provides to the person registering the Client to read about OpenID Provider's terms of service.

setRequestParameterSupported

public void setRequestParameterSupported(@Nullable
                                         java.lang.Boolean requestParameterSupported)

Parameters:

requestParameterSupported - Boolean value specifying whether the OP supports use of the request parameter, with true indicating support.

getRequestObjectSigningAlgValuesSupported

@Nullable
public java.util.List<java.lang.String> getRequestObjectSigningAlgValuesSupported()

Description copied from interface: OpenIdProviderMetadata

request_object_signing_alg_values_supported. OPTIONAL

Specified by:

getRequestObjectSigningAlgValuesSupported in interface OpenIdProviderMetadata

Returns:

List of the JWS signing algorithms (alg values) supported by the OP for Request Objects.

getRequestObjectEncryptionAlgValuesSupported

@Nullable
public java.util.List<java.lang.String> getRequestObjectEncryptionAlgValuesSupported()

Description copied from interface: OpenIdProviderMetadata

request_object_encryption_alg_values_supported OPTIONAL.

Specified by:

getRequestObjectEncryptionAlgValuesSupported in interface OpenIdProviderMetadata

Returns:

list of the JWE encryption algorithms (alg values) supported by the OP for Request Objects.

setRequestObjectEncryptionAlgValuesSupported

public void setRequestObjectEncryptionAlgValuesSupported(@Nullable
                                                         java.util.List<java.lang.String> requestObjectEncryptionAlgValuesSupported)

Parameters:

requestObjectEncryptionAlgValuesSupported - List of the JWE encryption algorithms (alg values) supported by the OP for Request Objects.

getRequestObjectEncryptionEncValuesSupported

@Nullable
public java.util.List<java.lang.String> getRequestObjectEncryptionEncValuesSupported()

Description copied from interface: OpenIdProviderMetadata

request_object_encryption_enc_values_supported OPTIONAL.

Specified by:

getRequestObjectEncryptionEncValuesSupported in interface OpenIdProviderMetadata

Returns:

List of the JWE encryption algorithms (enc values) supported by the OP for Request Objects.

setRequestObjectEncryptionEncValuesSupported

public void setRequestObjectEncryptionEncValuesSupported(@Nullable
                                                         java.util.List<java.lang.String> requestObjectEncryptionEncValuesSupported)

Parameters:

requestObjectEncryptionEncValuesSupported - List of the JWE encryption algorithms (enc values) supported by the OP for Request Objects.

setRequestObjectSigningAlgValuesSupported

public void setRequestObjectSigningAlgValuesSupported(@Nullable
                                                      java.util.List<java.lang.String> requestObjectSigningAlgValuesSupported)

Parameters:

requestObjectSigningAlgValuesSupported - List of the JWS signing algorithms (alg values) supported by the OP for Request Objects.