Class DefaultOpenIdProviderMetadata
- java.lang.Object
-
- io.micronaut.security.oauth2.client.DefaultOpenIdProviderMetadata
-
- All Implemented Interfaces:
OpenIdProviderMetadata
@Introspected public class DefaultOpenIdProviderMetadata extends java.lang.Object implements OpenIdProviderMetadata
- Since:
- 1.2.0
- Author:
- Sergio del Amo
- See Also:
- OpenID connect Discovery Spec
-
-
Constructor Summary
Constructors Constructor Description DefaultOpenIdProviderMetadata()Empty Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.List<java.lang.String>getAcrValuesSupported()acr_values_supported.java.lang.StringgetAuthorizationEndpoint()authorization_endpoint.java.lang.StringgetCheckSessionIframe()check_session_iframe.java.util.List<java.lang.String>getClaimsLocalesSupported()claims_locales_supported OPTIONAL.java.lang.BooleangetClaimsParameterSupported()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.BooleangetDefaultRequestParameterSupported()java.lang.BooleangetDefaultRequestUriParameterSupported()java.lang.BooleangetDefaultRequireRequestUriRegistration()java.util.List<java.lang.String>getDefaultResponseTypesSupported()java.util.List<java.lang.String>getDisplayValuesSupported()display_values_supported OPTIONAL.java.lang.StringgetEndSessionEndpoint()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.StringgetIntrospectionEndpoint()java.util.List<java.lang.String>getIntrospectionEndpointAuthMethodsSupported()java.lang.StringgetIssuer()issuer.java.lang.StringgetJwksUri()jwks_uri.java.lang.StringgetOpPolicyUri()op_policy_uri OPTIONAL.java.lang.StringgetOpTosUri()op_tos_uri.java.lang.StringgetRegistrationEndpoint()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.BooleangetRequestParameterSupported()request_parameter_supported OPTIONAL.java.lang.BooleangetRequestUriParameterSupported()request_uri_parameter_supported OPTIONAL.java.lang.BooleangetRequireRequestUriRegistration()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.StringgetRevocationEndpoint()java.util.List<java.lang.String>getRevocationEndpointAuthMethodsSupported()java.util.List<java.lang.String>getScopesSupported()scopes_supported.java.lang.StringgetServiceDocumentation()service_documentation OPTIONAL.java.util.List<java.lang.String>getSubjectTypesSupported()subject_types_supported.java.lang.StringgetTokenEndpoint()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.StringgetUserinfoEndpoint()userinfo_endpoint.voidsetAcrValuesSupported(java.util.List<java.lang.String> acrValuesSupported)voidsetAuthorizationEndpoint(java.lang.String authorizationEndpoint)voidsetCheckSessionIframe(java.lang.String checkSessionIframe)voidsetClaimsLocalesSupported(java.util.List<java.lang.String> claimsLocalesSupported)voidsetClaimsParameterSupported(java.lang.Boolean claimsParameterSupported)voidsetClaimsSupported(java.util.List<java.lang.String> claimsSupported)voidsetClaimTypesSupported(java.util.List<java.lang.String> claimTypesSupported)voidsetCodeChallengeMethodsSupported(java.util.List<java.lang.String> codeChallengeMethodsSupported)voidsetDisplayValuesSupported(java.util.List<java.lang.String> displayValuesSupported)voidsetEndSessionEndpoint(java.lang.String endSessionEndpoint)voidsetGrantTypesSupported(java.util.List<java.lang.String> grantTypesSupported)voidsetIdTokenEncryptionEncValuesSupported(java.util.List<java.lang.String> idTokenEncryptionEncValuesSupported)voidsetIdTokenSigningAlgValuesSupported(java.util.List<java.lang.String> idTokenSigningAlgValuesSupported)voidsetIntrospectionEndpoint(java.lang.String introspectionEndpoint)voidsetIntrospectionEndpointAuthMethodsSupported(java.util.List<java.lang.String> introspectionEndpointAuthMethodsSupported)voidsetIssuer(java.lang.String issuer)voidsetJwksUri(java.lang.String jwksUri)voidsetOpPolicyUri(java.lang.String opPolicyUri)voidsetOpTosUri(java.lang.String opTosUri)voidsetRegistrationEndpoint(java.lang.String registrationEndpoint)voidsetRequestObjectEncryptionAlgValuesSupported(java.util.List<java.lang.String> requestObjectEncryptionAlgValuesSupported)voidsetRequestObjectEncryptionEncValuesSupported(java.util.List<java.lang.String> requestObjectEncryptionEncValuesSupported)voidsetRequestObjectSigningAlgValuesSupported(java.util.List<java.lang.String> requestObjectSigningAlgValuesSupported)voidsetRequestParameterSupported(java.lang.Boolean requestParameterSupported)voidsetRequestUriParameterSupported(java.lang.Boolean requestUriParameterSupported)voidsetRequireRequestUriRegistration(java.lang.Boolean requireRequestUriRegistration)voidsetResponseModesSupported(java.util.List<java.lang.String> responseModesSupported)voidsetResponseTypesSupported(java.util.List<java.lang.String> responseTypesSupported)voidsetRevocationEndpoint(java.lang.String revocationEndpoint)voidsetRevocationEndpointAuthMethodsSupported(java.util.List<java.lang.String> revocationEndpointAuthMethodsSupported)voidsetScopesSupported(java.util.List<java.lang.String> scopesSupported)voidsetServiceDocumentation(java.lang.String serviceDocumentation)voidsetSubjectTypesSupported(java.util.List<java.lang.String> subjectTypesSupported)voidsetTokenEndpoint(java.lang.String tokenEndpoint)voidsetTokenEndpointAuthMethodsSupported(java.util.List<java.lang.String> tokenEndpointAuthMethodsSupported)voidsetTokenEndpointAuthSigningAlgValuesSupported(java.util.List<java.lang.String> tokenEndpointAuthSigningAlgValuesSupported)voidsetUriLocalesSupported(java.util.List<java.lang.String> uriLocalesSupported)voidsetUserinfoEncryptionAlgValuesSupported(java.util.List<java.lang.String> userinfoEncryptionAlgValuesSupported)voidsetUserinfoEncryptionEncValuesSupported(java.util.List<java.lang.String> userinfoEncryptionEncValuesSupported)voidsetUserinfoEndpoint(java.lang.String userinfoEndpoint)
-
-
-
Method Detail
-
getRequireRequestUriRegistration
@Nullable public java.lang.Boolean getRequireRequestUriRegistration()
Description copied from interface:OpenIdProviderMetadatarequire_request_uri_registration OPTIONAL.- Specified by:
getRequireRequestUriRegistrationin interfaceOpenIdProviderMetadata- 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:OpenIdProviderMetadataauthorization_endpoint. REQUIRED.- Specified by:
getAuthorizationEndpointin interfaceOpenIdProviderMetadata- 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:OpenIdProviderMetadataid_token_signing_alg_values_supported REQUIRED.- Specified by:
getIdTokenSigningAlgValuesSupportedin interfaceOpenIdProviderMetadata- 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:OpenIdProviderMetadataid_token_encryption_enc_values_supported OPTIONAL.- Specified by:
getIdTokenEncryptionEncValuesSupportedin interfaceOpenIdProviderMetadata- 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:OpenIdProviderMetadatauserinfo_encryption_alg_values_supported. OPTIONAL.- Specified by:
getUserInfoEncryptionAlgValuesSupportedin interfaceOpenIdProviderMetadata- 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:OpenIdProviderMetadatauserinfo_encryption_enc_values_supported OPTIONAL.- Specified by:
getUserinfoEncryptionEncValuesSupportedin interfaceOpenIdProviderMetadata- 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:OpenIdProviderMetadataissuer. REQUIRED.- Specified by:
getIssuerin interfaceOpenIdProviderMetadata- 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:OpenIdProviderMetadatajwks_uri. REQUIRED- Specified by:
getJwksUriin interfaceOpenIdProviderMetadata- 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:
getResponseTypesSupportedin interfaceOpenIdProviderMetadata- 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:OpenIdProviderMetadatascopes_supported. RECOMMENDED.- Specified by:
getScopesSupportedin interfaceOpenIdProviderMetadata- 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:OpenIdProviderMetadatasubject_types_supported. REQUIRED- Specified by:
getSubjectTypesSupportedin interfaceOpenIdProviderMetadata- 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
@Nonnull public java.lang.String getTokenEndpoint()
Description copied from interface:OpenIdProviderMetadatatoken_endpoint. This is REQUIRED unless only the Implicit Flow is used.- Specified by:
getTokenEndpointin interfaceOpenIdProviderMetadata- 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:OpenIdProviderMetadatatoken_endpoint_auth_methods_supported OPTIONAL.- Specified by:
getTokenEndpointAuthMethodsSupportedin interfaceOpenIdProviderMetadata- 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:OpenIdProviderMetadatatoken_endpoint_auth_signing_alg_values_supported OPTIONAL.- Specified by:
getTokenEndpointAuthSigningAlgValuesSupportedin interfaceOpenIdProviderMetadata- 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:OpenIdProviderMetadatadisplay_values_supported OPTIONAL.- Specified by:
getDisplayValuesSupportedin interfaceOpenIdProviderMetadata- 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:OpenIdProviderMetadataclaim_types_supported OPTIONAL.- Specified by:
getClaimTypesSupportedin interfaceOpenIdProviderMetadata- 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:OpenIdProviderMetadatauserinfo_endpoint. RECOMMENDED. This URL MUST use the https scheme and MAY contain port, path, and query parameter components.- Specified by:
getUserinfoEndpointin interfaceOpenIdProviderMetadata- 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:OpenIdProviderMetadataresponse_modes_supported. OPTIONAL- Specified by:
getResponseModesSupportedin interfaceOpenIdProviderMetadata- 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:OpenIdProviderMetadatagrant_types_supported. OPTIONAL- Specified by:
getGrantTypesSupportedin interfaceOpenIdProviderMetadata- 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:OpenIdProviderMetadataacr_values_supported. OPTIONAL.- Specified by:
getAcrValuesSupportedin interfaceOpenIdProviderMetadata- 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:OpenIdProviderMetadataregistration_endpoint. RECOMMENDED- Specified by:
getRegistrationEndpointin interfaceOpenIdProviderMetadata- 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:OpenIdProviderMetadataclaims_supported RECOMMENDED.- Specified by:
getClaimsSupportedin interfaceOpenIdProviderMetadata- 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:OpenIdProviderMetadataservice_documentation OPTIONAL.- Specified by:
getServiceDocumentationin interfaceOpenIdProviderMetadata- 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:OpenIdProviderMetadataclaims_locales_supported OPTIONAL.- Specified by:
getClaimsLocalesSupportedin interfaceOpenIdProviderMetadata- 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:OpenIdProviderMetadataui_locales_supported OPTIONAL.- Specified by:
getUriLocalesSupportedin interfaceOpenIdProviderMetadata- 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:OpenIdProviderMetadataclaims_parameter_supported OPTIONAL.- Specified by:
getClaimsParameterSupportedin interfaceOpenIdProviderMetadata- 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:OpenIdProviderMetadatacode_challenge_methods_supported.- Specified by:
getCodeChallengeMethodsSupportedin interfaceOpenIdProviderMetadata- 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:
getIntrospectionEndpointin interfaceOpenIdProviderMetadata- 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:
getIntrospectionEndpointAuthMethodsSupportedin interfaceOpenIdProviderMetadata- 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:
getRevocationEndpointin interfaceOpenIdProviderMetadata- 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:
getRevocationEndpointAuthMethodsSupportedin interfaceOpenIdProviderMetadata- 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:OpenIdProviderMetadatacheck_session_iframe. REQUIRED- Specified by:
getCheckSessionIframein interfaceOpenIdProviderMetadata- 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:OpenIdProviderMetadataend_session_endpoint. REQUIRED- Specified by:
getEndSessionEndpointin interfaceOpenIdProviderMetadata- 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:OpenIdProviderMetadatarequest_parameter_supported OPTIONAL.- Specified by:
getRequestParameterSupportedin interfaceOpenIdProviderMetadata- 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:OpenIdProviderMetadatarequest_uri_parameter_supported OPTIONAL.- Specified by:
getRequestUriParameterSupportedin interfaceOpenIdProviderMetadata- 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:OpenIdProviderMetadataop_policy_uri OPTIONAL.- Specified by:
getOpPolicyUriin interfaceOpenIdProviderMetadata- 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:OpenIdProviderMetadataop_tos_uri. OPTIONAL.- Specified by:
getOpTosUriin interfaceOpenIdProviderMetadata- 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:OpenIdProviderMetadatarequest_object_signing_alg_values_supported. OPTIONAL- Specified by:
getRequestObjectSigningAlgValuesSupportedin interfaceOpenIdProviderMetadata- 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:OpenIdProviderMetadatarequest_object_encryption_alg_values_supported OPTIONAL.- Specified by:
getRequestObjectEncryptionAlgValuesSupportedin interfaceOpenIdProviderMetadata- 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:OpenIdProviderMetadatarequest_object_encryption_enc_values_supported OPTIONAL.- Specified by:
getRequestObjectEncryptionEncValuesSupportedin interfaceOpenIdProviderMetadata- 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.
-
-