OIDCProviderMetadata (Nimbus OAuth 2.0 SDK with OpenID Connect 1.0 extensions v5.29)

java.lang.Object
- com.nimbusds.openid.connect.sdk.op.OIDCProviderMetadata

```
public class OIDCProviderMetadata
extends Object
```
OpenID Connect provider metadata.
Related specifications:
- OpenID Connect Discovery 1.0, section 3.
- OpenID Connect Session Management 1.0, section 2.1 (draft 28).
- OpenID Connect Front-Channel Logout 1.0, section 3 (draft 02).
- OpenID Connect Back-Channel Logout 1.0, section 2.1 (draft 04).

Constructor Summary

Constructors
Constructor and Description
`OIDCProviderMetadata(Issuer issuer, List<SubjectType> subjectTypes, URI jwkSetURI)` Creates a new OpenID Connect provider metadata instance.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`applyDefaults()` Applies the OpenID Connect provider metadata defaults where no values have been specified.
`List<ACR>`	`getACRs()` Gets the supported Authentication Context Class References (ACRs).
`URI`	`getAuthorizationEndpointURI()` Gets the authorisation endpoint URI.
`URI`	`getCheckSessionIframeURI()` Gets the cross-origin check session iframe URI.
`List<String>`	`getClaims()` Gets the supported claims names.
`List<com.nimbusds.langtag.LangTag>`	`getClaimsLocales()` Gets the supported claims locales.
`List<ClaimType>`	`getClaimTypes()` Gets the supported claim types.
`List<CodeChallengeMethod>`	`getCodeChallengeMethods()` Gets the supported authorisation code challenge methods for PKCE.
`Object`	`getCustomParameter(String name)` Gets the specified custom (not registered) parameter.
`net.minidev.json.JSONObject`	`getCustomParameters()` Gets the custom (not registered) parameters.
`URI`	`getCustomURIParameter(String name)` Gets the specified custom (not registered) URI parameter.
`List<Display>`	`getDisplays()` Gets the supported displays.
`URI`	`getEndSessionEndpointURI()` Gets the logout endpoint URI.
`List<GrantType>`	`getGrantTypes()` Gets the supported OAuth 2.0 grant types.
`List<com.nimbusds.jose.JWEAlgorithm>`	`getIDTokenJWEAlgs()` Gets the supported JWE algorithms for ID tokens.
`List<com.nimbusds.jose.EncryptionMethod>`	`getIDTokenJWEEncs()` Gets the supported encryption methods for ID tokens.
`List<com.nimbusds.jose.JWSAlgorithm>`	`getIDTokenJWSAlgs()` Gets the supported JWS algorithms for ID tokens.
`URI`	`getIntrospectionEndpointURI()` Gets the token introspection endpoint URI.
`Issuer`	`getIssuer()` Gets the issuer identifier.
`URI`	`getJWKSetURI()` Gets the JSON Web Key (JWK) set URI.
`URI`	`getPolicyURI()` Gets the provider's policy regarding relying party use of data.
`static Set<String>`	`getRegisteredParameterNames()` Gets the registered OpenID Connect provider metadata parameter names.
`URI`	`getRegistrationEndpointURI()` Gets the client registration endpoint URI.
`List<com.nimbusds.jose.JWEAlgorithm>`	`getRequestObjectJWEAlgs()` Gets the supported JWE algorithms for OpenID Connect request objects.
`List<com.nimbusds.jose.EncryptionMethod>`	`getRequestObjectJWEEncs()` Gets the supported encryption methods for OpenID Connect request objects.
`List<com.nimbusds.jose.JWSAlgorithm>`	`getRequestObjectJWSAlgs()` Gets the supported JWS algorithms for OpenID Connect request objects.
`List<ResponseMode>`	`getResponseModes()` Gets the supported response mode values.
`List<ResponseType>`	`getResponseTypes()` Gets the supported response type values.
`URI`	`getRevocationEndpointURI()` Gets the token revocation endpoint URI.
`Scope`	`getScopes()` Gets the supported scope values.
`URI`	`getServiceDocsURI()` Gets the service documentation URI.
`List<SubjectType>`	`getSubjectTypes()` Gets the supported subject types.
`URI`	`getTermsOfServiceURI()` Gets the provider's terms of service.
`List<ClientAuthenticationMethod>`	`getTokenEndpointAuthMethods()` Gets the supported token endpoint authentication methods.
`List<com.nimbusds.jose.JWSAlgorithm>`	`getTokenEndpointJWSAlgs()` Gets the supported JWS algorithms for the `private_key_jwt` and `client_secret_jwt` token endpoint authentication methods.
`URI`	`getTokenEndpointURI()` Gets the token endpoint URI.
`List<com.nimbusds.langtag.LangTag>`	`getUILocales()` Gets the supported UI locales.
`URI`	`getUserInfoEndpointURI()` Gets the UserInfo endpoint URI.
`List<com.nimbusds.jose.JWEAlgorithm>`	`getUserInfoJWEAlgs()` Gets the supported JWE algorithms for UserInfo JWTs.
`List<com.nimbusds.jose.EncryptionMethod>`	`getUserInfoJWEEncs()` Gets the supported encryption methods for UserInfo JWTs.
`List<com.nimbusds.jose.JWSAlgorithm>`	`getUserInfoJWSAlgs()` Gets the supported JWS algorithms for UserInfo JWTs.
`static OIDCProviderMetadata`	`parse(net.minidev.json.JSONObject jsonObject)` Parses an OpenID Connect provider metadata from the specified JSON object.
`static OIDCProviderMetadata`	`parse(String s)` Parses an OpenID Connect provider metadata from the specified JSON object string.
`boolean`	`requiresRequestURIRegistration()` Gets the requirement for the `request_uri` parameter pre-registration.
`static OIDCProviderMetadata`	`resolve(Issuer issuer)` Resolves OpenID Provider metadata from the specified issuer identifier.
`static OIDCProviderMetadata`	`resolve(Issuer issuer, int connectTimeout, int readTimeout)` Resolves OpenID Provider metadata from the specified issuer identifier.
`void`	`setACRs(List<ACR> acrValues)` Sets the supported Authentication Context Class References (ACRs).
`void`	`setAuthorizationEndpointURI(URI authzEndpoint)` Sets the authorisation endpoint URI.
`void`	`setCheckSessionIframeURI(URI checkSessionIframe)` Sets the cross-origin check session iframe URI.
`void`	`setClaimLocales(List<com.nimbusds.langtag.LangTag> claimsLocales)` Sets the supported claims locales.
`void`	`setClaims(List<String> claims)` Sets the supported claims names.
`void`	`setClaimTypes(List<ClaimType> claimTypes)` Sets the supported claim types.
`void`	`setCodeChallengeMethods(List<CodeChallengeMethod> codeChallengeMethods)` Gets the supported authorisation code challenge methods for PKCE.
`void`	`setCustomParameter(String name, Object value)` Sets the specified custom (not registered) parameter.
`void`	`setDisplays(List<Display> displays)` Sets the supported displays.
`void`	`setEndSessionEndpointURI(URI endSessionEndpoint)` Sets the logout endpoint URI.
`void`	`setGrantTypes(List<GrantType> gts)` Sets the supported OAuth 2.0 grant types.
`void`	`setIDTokenJWEAlgs(List<com.nimbusds.jose.JWEAlgorithm> idTokenJWEAlgs)` Sets the supported JWE algorithms for ID tokens.
`void`	`setIDTokenJWEEncs(List<com.nimbusds.jose.EncryptionMethod> idTokenJWEEncs)` Sets the supported encryption methods for ID tokens.
`void`	`setIDTokenJWSAlgs(List<com.nimbusds.jose.JWSAlgorithm> idTokenJWSAlgs)` Sets the supported JWS algorithms for ID tokens.
`void`	`setIntrospectionEndpointURI(URI introspectionEndpoint)` Sets the token introspection endpoint URI.
`void`	`setPolicyURI(URI policyURI)` Sets the provider's policy regarding relying party use of data.
`void`	`setRegistrationEndpointURI(URI regEndpoint)` Sets the client registration endpoint URI.
`void`	`setRequestObjectJWEAlgs(List<com.nimbusds.jose.JWEAlgorithm> requestObjectJWEAlgs)` Sets the supported JWE algorithms for OpenID Connect request objects.
`void`	`setRequestObjectJWEEncs(List<com.nimbusds.jose.EncryptionMethod> requestObjectJWEEncs)` Sets the supported encryption methods for OpenID Connect request objects.
`void`	`setRequestObjectJWSAlgs(List<com.nimbusds.jose.JWSAlgorithm> requestObjectJWSAlgs)` Sets the supported JWS algorithms for OpenID Connect request objects.
`void`	`setRequiresRequestURIRegistration(boolean requireRequestURIReg)` Sets the requirement for the `request_uri` parameter pre-registration.
`void`	`setResponseModes(List<ResponseMode> rms)` Sets the supported response mode values.
`void`	`setResponseTypes(List<ResponseType> rts)` Sets the supported response type values.
`void`	`setRevocationEndpointURI(URI revocationEndpoint)` Sets the token revocation endpoint URI.
`void`	`setScopes(Scope scope)` Sets the supported scope values.
`void`	`setServiceDocsURI(URI serviceDocsURI)` Sets the service documentation URI.
`void`	`setSupportsBackChannelLogout(boolean backChannelLogoutSupported)` Sets the support for back-channel logout.
`void`	`setSupportsBackChannelLogoutSession(boolean backChannelLogoutSessionSupported)` Sets the support for back-channel logout with a session ID.
`void`	`setSupportsClaimsParams(boolean claimsParamSupported)` Sets the support for the `claims` authorisation request parameter.
`void`	`setSupportsFrontChannelLogout(boolean frontChannelLogoutSupported)` Sets the support for front-channel logout.
`void`	`setSupportsFrontChannelLogoutSession(boolean frontChannelLogoutSessionSupported)` Sets the support for front-channel logout with a session ID.
`void`	`setSupportsRequestParam(boolean requestParamSupported)` Sets the support for the `request` authorisation request parameter.
`void`	`setSupportsRequestURIParam(boolean requestURIParamSupported)` Sets the support for the `request_uri` authorisation request parameter.
`void`	`setTermsOfServiceURI(URI tosURI)` Sets the provider's terms of service.
`void`	`setTokenEndpointAuthMethods(List<ClientAuthenticationMethod> tokenEndpointAuthMethods)` Sets the supported token endpoint authentication methods.
`void`	`setTokenEndpointJWSAlgs(List<com.nimbusds.jose.JWSAlgorithm> tokenEndpointJWSAlgs)` Sets the supported JWS algorithms for the `private_key_jwt` and `client_secret_jwt` token endpoint authentication methods.
`void`	`setTokenEndpointURI(URI tokenEndpoint)` Sts the token endpoint URI.
`void`	`setUILocales(List<com.nimbusds.langtag.LangTag> uiLocales)` Sets the supported UI locales.
`void`	`setUserInfoEndpointURI(URI userInfoEndpoint)` Sets the UserInfo endpoint URI.
`void`	`setUserInfoJWEAlgs(List<com.nimbusds.jose.JWEAlgorithm> userInfoJWEAlgs)` Sets the supported JWE algorithms for UserInfo JWTs.
`void`	`setUserInfoJWEEncs(List<com.nimbusds.jose.EncryptionMethod> userInfoJWEEncs)` Sets the supported encryption methods for UserInfo JWTs.
`void`	`setUserInfoJWSAlgs(List<com.nimbusds.jose.JWSAlgorithm> userInfoJWSAlgs)` Sets the supported JWS algorithms for UserInfo JWTs.
`boolean`	`supportsBackChannelLogout()` Gets the support for back-channel logout.
`boolean`	`supportsBackChannelLogoutSession()` Gets the support for back-channel logout with a session ID.
`boolean`	`supportsClaimsParam()` Gets the support for the `claims` authorisation request parameter.
`boolean`	`supportsFrontChannelLogout()` Gets the support for front-channel logout.
`boolean`	`supportsFrontChannelLogoutSession()` Gets the support for front-channel logout with a session ID.
`boolean`	`supportsRequestParam()` Gets the support for the `request` authorisation request parameter.
`boolean`	`supportsRequestURIParam()` Gets the support for the `request_uri` authorisation request parameter.
`net.minidev.json.JSONObject`	`toJSONObject()` Returns the JSON object representation of this OpenID Connect provider metadata.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - OIDCProviderMetadata
```
public OIDCProviderMetadata(Issuer issuer,
                            List<SubjectType> subjectTypes,
                            URI jwkSetURI)
```
    Creates a new OpenID Connect provider metadata instance.
    
    Parameters:
    
    issuer - The issuer identifier. Must be an URI using the https scheme with no query or fragment component. Must not be null.
    
    subjectTypes - The supported subject types. At least one must be specified. Must not be null.
- Method Detail
  - getRegisteredParameterNames
```
public static Set<String> getRegisteredParameterNames()
```
    Gets the registered OpenID Connect provider metadata parameter names.
    
    Returns:
    
    The registered OpenID Connect provider metadata parameter names, as an unmodifiable set.
  - getIssuer
```
public Issuer getIssuer()
```
    Gets the issuer identifier. Corresponds to the issuer metadata field.
    
    Returns:
    
    The issuer identifier.
  - getAuthorizationEndpointURI
```
public URI getAuthorizationEndpointURI()
```
    Gets the authorisation endpoint URI. Corresponds the authorization_endpoint metadata field.
    
    Returns:
    
    The authorisation endpoint URI, null if not specified.
  - setAuthorizationEndpointURI
```
public void setAuthorizationEndpointURI(URI authzEndpoint)
```
    Sets the authorisation endpoint URI. Corresponds the authorization_endpoint metadata field.
    
    Parameters:
    
    authzEndpoint - The authorisation endpoint URI, null if not specified.
  - getTokenEndpointURI
```
public URI getTokenEndpointURI()
```
    Gets the token endpoint URI. Corresponds the token_endpoint metadata field.
    
    Returns:
    
    The token endpoint URI, null if not specified.
  - setTokenEndpointURI
```
public void setTokenEndpointURI(URI tokenEndpoint)
```
    Sts the token endpoint URI. Corresponds the token_endpoint metadata field.
    
    Parameters:
    
    tokenEndpoint - The token endpoint URI, null if not specified.
  - getUserInfoEndpointURI
```
public URI getUserInfoEndpointURI()
```
    Gets the UserInfo endpoint URI. Corresponds the userinfo_endpoint metadata field.
    
    Returns:
    
    The UserInfo endpoint URI, null if not specified.
  - setUserInfoEndpointURI
```
public void setUserInfoEndpointURI(URI userInfoEndpoint)
```
    Sets the UserInfo endpoint URI. Corresponds the userinfo_endpoint metadata field.
    
    Parameters:
    
    userInfoEndpoint - The UserInfo endpoint URI, null if not specified.
  - getRegistrationEndpointURI
```
public URI getRegistrationEndpointURI()
```
    Gets the client registration endpoint URI. Corresponds to the registration_endpoint metadata field.
    
    Returns:
    
    The client registration endpoint URI, null if not specified.
  - setRegistrationEndpointURI
```
public void setRegistrationEndpointURI(URI regEndpoint)
```
    Sets the client registration endpoint URI. Corresponds to the registration_endpoint metadata field.
    
    Parameters:
    
    regEndpoint - The client registration endpoint URI, null if not specified.
  - getIntrospectionEndpointURI
```
public URI getIntrospectionEndpointURI()
```
    Gets the token introspection endpoint URI. Corresponds to the introspection_endpoint metadata field.
    
    Returns:
    
    The token introspection endpoint URI, null if not specified.
  - setIntrospectionEndpointURI
```
public void setIntrospectionEndpointURI(URI introspectionEndpoint)
```
    Sets the token introspection endpoint URI. Corresponds to the introspection_endpoint metadata field.
    
    Parameters:
    
    introspectionEndpoint - The token introspection endpoint URI, null if not specified.
  - getRevocationEndpointURI
```
public URI getRevocationEndpointURI()
```
    Gets the token revocation endpoint URI. Corresponds to the revocation_endpoint metadata field.
    
    Returns:
    
    The token revocation endpoint URI, null if not specified.
  - setRevocationEndpointURI
```
public void setRevocationEndpointURI(URI revocationEndpoint)
```
    Sets the token revocation endpoint URI. Corresponds to the revocation_endpoint metadata field.
    
    Parameters:
    
    revocationEndpoint - The token revocation endpoint URI, null if not specified.
  - getCheckSessionIframeURI
```
public URI getCheckSessionIframeURI()
```
    Gets the cross-origin check session iframe URI. Corresponds to the check_session_iframe metadata field.
    
    Returns:
    
    The check session iframe URI, null if not specified.
  - setCheckSessionIframeURI
```
public void setCheckSessionIframeURI(URI checkSessionIframe)
```
    Sets the cross-origin check session iframe URI. Corresponds to the check_session_iframe metadata field.
    
    Parameters:
    
    checkSessionIframe - The check session iframe URI, null if not specified.
  - getEndSessionEndpointURI
```
public URI getEndSessionEndpointURI()
```
    Gets the logout endpoint URI. Corresponds to the end_session_endpoint metadata field.
    
    Returns:
    
    The logoout endpoint URI, null if not specified.
  - setEndSessionEndpointURI
```
public void setEndSessionEndpointURI(URI endSessionEndpoint)
```
    Sets the logout endpoint URI. Corresponds to the end_session_endpoint metadata field.
    
    Parameters:
    
    endSessionEndpoint - The logoout endpoint URI, null if not specified.
  - getJWKSetURI
```
public URI getJWKSetURI()
```
    Gets the JSON Web Key (JWK) set URI. Corresponds to the jwks_uri metadata field.
    
    Returns:
    
    The JWK set URI.
  - getScopes
```
public Scope getScopes()
```
    Gets the supported scope values. Corresponds to the scopes_supported metadata field.
    
    Returns:
    
    The supported scope values, null if not specified.
  - setScopes
```
public void setScopes(Scope scope)
```
    Sets the supported scope values. Corresponds to the scopes_supported metadata field.
    
    Parameters:
    
    scope - The supported scope values, null if not specified.
  - getResponseTypes
```
public List<ResponseType> getResponseTypes()
```
    Gets the supported response type values. Corresponds to the response_types_supported metadata field.
    
    Returns:
    
    The supported response type values, null if not specified.
  - setResponseTypes
```
public void setResponseTypes(List<ResponseType> rts)
```
    Sets the supported response type values. Corresponds to the response_types_supported metadata field.
    
    Parameters:
    
    rts - The supported response type values, null if not specified.
  - getResponseModes
```
public List<ResponseMode> getResponseModes()
```
    Gets the supported response mode values. Corresponds to the response_modes_supported.
    
    Returns:
    
    The supported response mode values, null if not specified.
  - setResponseModes
```
public void setResponseModes(List<ResponseMode> rms)
```
    Sets the supported response mode values. Corresponds to the response_modes_supported.
    
    Parameters:
    
    rms - The supported response mode values, null if not specified.
  - getGrantTypes
```
public List<GrantType> getGrantTypes()
```
    Gets the supported OAuth 2.0 grant types. Corresponds to the grant_types_supported metadata field.
    
    Returns:
    
    The supported grant types, null if not specified.
  - setGrantTypes
```
public void setGrantTypes(List<GrantType> gts)
```
    Sets the supported OAuth 2.0 grant types. Corresponds to the grant_types_supported metadata field.
    
    Parameters:
    
    gts - The supported grant types, null if not specified.
  - getCodeChallengeMethods
```
public List<CodeChallengeMethod> getCodeChallengeMethods()
```
    Gets the supported authorisation code challenge methods for PKCE. Corresponds to the code_challenge_methods_supported metadata field.
    
    Returns:
    
    The supported code challenge methods, null if not specified.
  - setCodeChallengeMethods
```
public void setCodeChallengeMethods(List<CodeChallengeMethod> codeChallengeMethods)
```
    Gets the supported authorisation code challenge methods for PKCE. Corresponds to the code_challenge_methods_supported metadata field.
    
    Parameters:
    
    codeChallengeMethods - The supported code challenge methods, null if not specified.
  - getACRs
```
public List<ACR> getACRs()
```
    Gets the supported Authentication Context Class References (ACRs). Corresponds to the acr_values_supported metadata field.
    
    Returns:
    
    The supported ACRs, null if not specified.
  - setACRs
```
public void setACRs(List<ACR> acrValues)
```
    Sets the supported Authentication Context Class References (ACRs). Corresponds to the acr_values_supported metadata field.
    
    Parameters:
    
    acrValues - The supported ACRs, null if not specified.
  - getSubjectTypes
```
public List<SubjectType> getSubjectTypes()
```
    Gets the supported subject types. Corresponds to the subject_types_supported metadata field.
    
    Returns:
    
    The supported subject types.
  - getTokenEndpointAuthMethods
```
public List<ClientAuthenticationMethod> getTokenEndpointAuthMethods()
```
    Gets the supported token endpoint authentication methods. Corresponds to the token_endpoint_auth_methods_supported metadata field.
    
    Returns:
    
    The supported token endpoint authentication methods, null if not specified.
  - setTokenEndpointAuthMethods
```
public void setTokenEndpointAuthMethods(List<ClientAuthenticationMethod> tokenEndpointAuthMethods)
```
    Sets the supported token endpoint authentication methods. Corresponds to the token_endpoint_auth_methods_supported metadata field.
    
    Parameters:
    
    tokenEndpointAuthMethods - The supported token endpoint authentication methods, null if not specified.
  - getTokenEndpointJWSAlgs
```
public List<com.nimbusds.jose.JWSAlgorithm> getTokenEndpointJWSAlgs()
```
    Gets the supported JWS algorithms for the private_key_jwt and client_secret_jwt token endpoint authentication methods. Corresponds to the token_endpoint_auth_signing_alg_values_supported metadata field.
    
    Returns:
    
    The supported JWS algorithms, null if not specified.
  - setTokenEndpointJWSAlgs
```
public void setTokenEndpointJWSAlgs(List<com.nimbusds.jose.JWSAlgorithm> tokenEndpointJWSAlgs)
```
    Sets the supported JWS algorithms for the private_key_jwt and client_secret_jwt token endpoint authentication methods. Corresponds to the token_endpoint_auth_signing_alg_values_supported metadata field.
    
    Parameters:
    
    tokenEndpointJWSAlgs - The supported JWS algorithms, null if not specified. Must not contain the none algorithm.
  - getRequestObjectJWSAlgs
```
public List<com.nimbusds.jose.JWSAlgorithm> getRequestObjectJWSAlgs()
```
    Gets the supported JWS algorithms for OpenID Connect request objects. Corresponds to the request_object_signing_alg_values_supported metadata field.
    
    Returns:
    
    The supported JWS algorithms, null if not specified.
  - setRequestObjectJWSAlgs
```
public void setRequestObjectJWSAlgs(List<com.nimbusds.jose.JWSAlgorithm> requestObjectJWSAlgs)
```
    Sets the supported JWS algorithms for OpenID Connect request objects. Corresponds to the request_object_signing_alg_values_supported metadata field.
    
    Parameters:
    
    requestObjectJWSAlgs - The supported JWS algorithms, null if not specified.
  - getRequestObjectJWEAlgs
```
public List<com.nimbusds.jose.JWEAlgorithm> getRequestObjectJWEAlgs()
```
    Gets the supported JWE algorithms for OpenID Connect request objects. Corresponds to the request_object_encryption_alg_values_supported metadata field.
    
    Returns:
    
    The supported JWE algorithms, null if not specified.
  - setRequestObjectJWEAlgs
```
public void setRequestObjectJWEAlgs(List<com.nimbusds.jose.JWEAlgorithm> requestObjectJWEAlgs)
```
    Sets the supported JWE algorithms for OpenID Connect request objects. Corresponds to the request_object_encryption_alg_values_supported metadata field.
    
    Parameters:
    
    requestObjectJWEAlgs - The supported JWE algorithms, null if not specified.
  - getRequestObjectJWEEncs
```
public List<com.nimbusds.jose.EncryptionMethod> getRequestObjectJWEEncs()
```
    Gets the supported encryption methods for OpenID Connect request objects. Corresponds to the request_object_encryption_enc_values_supported metadata field.
    
    Returns:
    
    The supported encryption methods, null if not specified.
  - setRequestObjectJWEEncs
```
public void setRequestObjectJWEEncs(List<com.nimbusds.jose.EncryptionMethod> requestObjectJWEEncs)
```
    Sets the supported encryption methods for OpenID Connect request objects. Corresponds to the request_object_encryption_enc_values_supported metadata field.
    
    Parameters:
    
    requestObjectJWEEncs - The supported encryption methods, null if not specified.
  - getIDTokenJWSAlgs
```
public List<com.nimbusds.jose.JWSAlgorithm> getIDTokenJWSAlgs()
```
    Gets the supported JWS algorithms for ID tokens. Corresponds to the id_token_signing_alg_values_supported metadata field.
    
    Returns:
    
    The supported JWS algorithms, null if not specified.
  - setIDTokenJWSAlgs
```
public void setIDTokenJWSAlgs(List<com.nimbusds.jose.JWSAlgorithm> idTokenJWSAlgs)
```
    Sets the supported JWS algorithms for ID tokens. Corresponds to the id_token_signing_alg_values_supported metadata field.
    
    Parameters:
    
    idTokenJWSAlgs - The supported JWS algorithms, null if not specified.
  - getIDTokenJWEAlgs
```
public List<com.nimbusds.jose.JWEAlgorithm> getIDTokenJWEAlgs()
```
    Gets the supported JWE algorithms for ID tokens. Corresponds to the id_token_encryption_alg_values_supported metadata field.
    
    Returns:
    
    The supported JWE algorithms, null if not specified.
  - setIDTokenJWEAlgs
```
public void setIDTokenJWEAlgs(List<com.nimbusds.jose.JWEAlgorithm> idTokenJWEAlgs)
```
    Sets the supported JWE algorithms for ID tokens. Corresponds to the id_token_encryption_alg_values_supported metadata field.
    
    Parameters:
    
    idTokenJWEAlgs - The supported JWE algorithms, null if not specified.
  - getIDTokenJWEEncs
```
public List<com.nimbusds.jose.EncryptionMethod> getIDTokenJWEEncs()
```
    Gets the supported encryption methods for ID tokens. Corresponds to the id_token_encryption_enc_values_supported metadata field.
    
    Returns:
    
    The supported encryption methods, null if not specified.
  - setIDTokenJWEEncs
```
public void setIDTokenJWEEncs(List<com.nimbusds.jose.EncryptionMethod> idTokenJWEEncs)
```
    Sets the supported encryption methods for ID tokens. Corresponds to the id_token_encryption_enc_values_supported metadata field.
    
    Parameters:
    
    idTokenJWEEncs - The supported encryption methods, null if not specified.
  - getUserInfoJWSAlgs
```
public List<com.nimbusds.jose.JWSAlgorithm> getUserInfoJWSAlgs()
```
    Gets the supported JWS algorithms for UserInfo JWTs. Corresponds to the userinfo_signing_alg_values_supported metadata field.
    
    Returns:
    
    The supported JWS algorithms, null if not specified.
  - setUserInfoJWSAlgs
```
public void setUserInfoJWSAlgs(List<com.nimbusds.jose.JWSAlgorithm> userInfoJWSAlgs)
```
    Sets the supported JWS algorithms for UserInfo JWTs. Corresponds to the userinfo_signing_alg_values_supported metadata field.
    
    Parameters:
    
    userInfoJWSAlgs - The supported JWS algorithms, null if not specified.
  - getUserInfoJWEAlgs
```
public List<com.nimbusds.jose.JWEAlgorithm> getUserInfoJWEAlgs()
```
    Gets the supported JWE algorithms for UserInfo JWTs. Corresponds to the userinfo_encryption_alg_values_supported metadata field.
    
    Returns:
    
    The supported JWE algorithms, null if not specified.
  - setUserInfoJWEAlgs
```
public void setUserInfoJWEAlgs(List<com.nimbusds.jose.JWEAlgorithm> userInfoJWEAlgs)
```
    Sets the supported JWE algorithms for UserInfo JWTs. Corresponds to the userinfo_encryption_alg_values_supported metadata field.
    
    Parameters:
    
    userInfoJWEAlgs - The supported JWE algorithms, null if not specified.
  - getUserInfoJWEEncs
```
public List<com.nimbusds.jose.EncryptionMethod> getUserInfoJWEEncs()
```
    Gets the supported encryption methods for UserInfo JWTs. Corresponds to the userinfo_encryption_enc_values_supported metadata field.
    
    Returns:
    
    The supported encryption methods, null if not specified.
  - setUserInfoJWEEncs
```
public void setUserInfoJWEEncs(List<com.nimbusds.jose.EncryptionMethod> userInfoJWEEncs)
```
    Sets the supported encryption methods for UserInfo JWTs. Corresponds to the userinfo_encryption_enc_values_supported metadata field.
    
    Parameters:
    
    userInfoJWEEncs - The supported encryption methods, null if not specified.
  - getDisplays
```
public List<Display> getDisplays()
```
    Gets the supported displays. Corresponds to the display_values_supported metadata field.
    
    Returns:
    
    The supported displays, null if not specified.
  - setDisplays
```
public void setDisplays(List<Display> displays)
```
    Sets the supported displays. Corresponds to the display_values_supported metadata field.
    
    Parameters:
    
    displays - The supported displays, null if not specified.
  - getClaimTypes
```
public List<ClaimType> getClaimTypes()
```
    Gets the supported claim types. Corresponds to the claim_types_supported metadata field.
    
    Returns:
    
    The supported claim types, null if not specified.
  - setClaimTypes
```
public void setClaimTypes(List<ClaimType> claimTypes)
```
    Sets the supported claim types. Corresponds to the claim_types_supported metadata field.
    
    Parameters:
    
    claimTypes - The supported claim types, null if not specified.
  - getClaims
```
public List<String> getClaims()
```
    Gets the supported claims names. Corresponds to the claims_supported metadata field.
    
    Returns:
    
    The supported claims names, null if not specified.
  - setClaims
```
public void setClaims(List<String> claims)
```
    Sets the supported claims names. Corresponds to the claims_supported metadata field.
    
    Parameters:
    
    claims - The supported claims names, null if not specified.
  - getClaimsLocales
```
public List<com.nimbusds.langtag.LangTag> getClaimsLocales()
```
    Gets the supported claims locales. Corresponds to the claims_locales_supported metadata field.
    
    Returns:
    
    The supported claims locales, null if not specified.
  - setClaimLocales
```
public void setClaimLocales(List<com.nimbusds.langtag.LangTag> claimsLocales)
```
    Sets the supported claims locales. Corresponds to the claims_locales_supported metadata field.
    
    Parameters:
    
    claimsLocales - The supported claims locales, null if not specified.
  - getUILocales
```
public List<com.nimbusds.langtag.LangTag> getUILocales()
```
    Gets the supported UI locales. Corresponds to the ui_locales_supported metadata field.
    
    Returns:
    
    The supported UI locales, null if not specified.
  - setUILocales
```
public void setUILocales(List<com.nimbusds.langtag.LangTag> uiLocales)
```
    Sets the supported UI locales. Corresponds to the ui_locales_supported metadata field.
    
    Parameters:
    
    uiLocales - The supported UI locales, null if not specified.
  - getServiceDocsURI
```
public URI getServiceDocsURI()
```
    Gets the service documentation URI. Corresponds to the service_documentation metadata field.
    
    Returns:
    
    The service documentation URI, null if not specified.
  - setServiceDocsURI
```
public void setServiceDocsURI(URI serviceDocsURI)
```
    Sets the service documentation URI. Corresponds to the service_documentation metadata field.
    
    Parameters:
    
    serviceDocsURI - The service documentation URI, null if not specified.
  - getPolicyURI
```
public URI getPolicyURI()
```
    Gets the provider's policy regarding relying party use of data. Corresponds to the op_policy_uri metadata field.
    
    Returns:
    
    The policy URI, null if not specified.
  - setPolicyURI
```
public void setPolicyURI(URI policyURI)
```
    Sets the provider's policy regarding relying party use of data. Corresponds to the op_policy_uri metadata field.
    
    Parameters:
    
    policyURI - The policy URI, null if not specified.
  - getTermsOfServiceURI
```
public URI getTermsOfServiceURI()
```
    Gets the provider's terms of service. Corresponds to the op_tos_uri metadata field.
    
    Returns:
    
    The terms of service URI, null if not specified.
  - setTermsOfServiceURI
```
public void setTermsOfServiceURI(URI tosURI)
```
    Sets the provider's terms of service. Corresponds to the op_tos_uri metadata field.
    
    Parameters:
    
    tosURI - The terms of service URI, null if not specified.
  - supportsClaimsParam
```
public boolean supportsClaimsParam()
```
    Gets the support for the claims authorisation request parameter. Corresponds to the claims_parameter_supported metadata field.
    
    Returns:
    
    true if the claim parameter is supported, else false.
  - setSupportsClaimsParams
```
public void setSupportsClaimsParams(boolean claimsParamSupported)
```
    Sets the support for the claims authorisation request parameter. Corresponds to the claims_parameter_supported metadata field.
    
    Parameters:
    
    claimsParamSupported - true if the claim parameter is supported, else false.
  - supportsRequestParam
```
public boolean supportsRequestParam()
```
    Gets the support for the request authorisation request parameter. Corresponds to the request_parameter_supported metadata field.
    
    Returns:
    
    true if the reqeust parameter is supported, else false.
  - setSupportsRequestParam
```
public void setSupportsRequestParam(boolean requestParamSupported)
```
    Sets the support for the request authorisation request parameter. Corresponds to the request_parameter_supported metadata field.
    
    Parameters:
    
    requestParamSupported - true if the reqeust parameter is supported, else false.
  - supportsRequestURIParam
```
public boolean supportsRequestURIParam()
```
    Gets the support for the request_uri authorisation request parameter. Corresponds the request_uri_parameter_supported metadata field.
    
    Returns:
    
    true if the request_uri parameter is supported, else false.
  - setSupportsRequestURIParam
```
public void setSupportsRequestURIParam(boolean requestURIParamSupported)
```
    Sets the support for the request_uri authorisation request parameter. Corresponds the request_uri_parameter_supported metadata field.
    
    Parameters:
    
    requestURIParamSupported - true if the request_uri parameter is supported, else false.
  - requiresRequestURIRegistration
```
public boolean requiresRequestURIRegistration()
```
    Gets the requirement for the request_uri parameter pre-registration. Corresponds to the require_request_uri_registration metadata field.
    
    Returns:
    
    true if the request_uri parameter values must be pre-registered, else false.
  - setRequiresRequestURIRegistration
```
public void setRequiresRequestURIRegistration(boolean requireRequestURIReg)
```
    Sets the requirement for the request_uri parameter pre-registration. Corresponds to the require_request_uri_registration metadata field.
    
    Parameters:
    
    requireRequestURIReg - true if the request_uri parameter values must be pre-registered, else false.
  - supportsFrontChannelLogout
```
public boolean supportsFrontChannelLogout()
```
    Gets the support for front-channel logout. Corresponds to the frontchannel_logout_supported metadata field.
    
    Returns:
    
    true if front-channel logout is supported, else false.
  - setSupportsFrontChannelLogout
```
public void setSupportsFrontChannelLogout(boolean frontChannelLogoutSupported)
```
    Sets the support for front-channel logout. Corresponds to the frontchannel_logout_supported metadata field.
    
    Parameters:
    
    frontChannelLogoutSupported - true if front-channel logout is supported, else false.
  - supportsFrontChannelLogoutSession
```
public boolean supportsFrontChannelLogoutSession()
```
    Gets the support for front-channel logout with a session ID. Corresponds to the frontchannel_logout_session_supported metadata field.
    
    Returns:
    
    true if front-channel logout with a session ID is supported, else false.
  - setSupportsFrontChannelLogoutSession
```
public void setSupportsFrontChannelLogoutSession(boolean frontChannelLogoutSessionSupported)
```
    Sets the support for front-channel logout with a session ID. Corresponds to the frontchannel_logout_session_supported metadata field.
    
    Parameters:
    
    frontChannelLogoutSessionSupported - true if front-channel logout with a session ID is supported, else false.
  - supportsBackChannelLogout
```
public boolean supportsBackChannelLogout()
```
    Gets the support for back-channel logout. Corresponds to the backchannel_logout_supported metadata field.
    
    Returns:
    
    true if back-channel logout is supported, else false.
  - setSupportsBackChannelLogout
```
public void setSupportsBackChannelLogout(boolean backChannelLogoutSupported)
```
    Sets the support for back-channel logout. Corresponds to the backchannel_logout_supported metadata field.
    
    Parameters:
    
    backChannelLogoutSupported - true if back-channel logout is supported, else false.
  - supportsBackChannelLogoutSession
```
public boolean supportsBackChannelLogoutSession()
```
    Gets the support for back-channel logout with a session ID. Corresponds to the backchannel_logout_session_supported metadata field.
    
    Returns:
    
    true if back-channel logout with a session ID is supported, else false.
  - setSupportsBackChannelLogoutSession
```
public void setSupportsBackChannelLogoutSession(boolean backChannelLogoutSessionSupported)
```
    Sets the support for back-channel logout with a session ID. Corresponds to the backchannel_logout_session_supported metadata field.
    
    Parameters:
    
    backChannelLogoutSessionSupported - true if back-channel logout with a session ID is supported, else false.
  - getCustomParameter
```
public Object getCustomParameter(String name)
```
    Gets the specified custom (not registered) parameter.
    
    Parameters:
    
    name - The parameter name. Must not be null.
    
    Returns:
    
    The parameter value, null if not specified.
  - getCustomURIParameter
```
public URI getCustomURIParameter(String name)
```
    Gets the specified custom (not registered) URI parameter.
    
    Parameters:
    
    name - The parameter name. Must not be null.
    
    Returns:
    
    The parameter URI value, null if not specified.
  - setCustomParameter
```
public void setCustomParameter(String name,
                               Object value)
```
    Sets the specified custom (not registered) parameter.
    
    Parameters:
    
    name - The parameter name. Must not be null.
    
    value - The parameter value, null if not specified.
  - getCustomParameters
```
public net.minidev.json.JSONObject getCustomParameters()
```
    Gets the custom (not registered) parameters.
    
    Returns:
    
    The custom parameters, empty JSON object if none.
  - applyDefaults
```
public void applyDefaults()
```
    Applies the OpenID Connect provider metadata defaults where no values have been specified.
    - The response modes default to ["query", "fragment"].
    - The grant types default to ["authorization_code", "implicit"].
    - The token endpoint authentication methods default to ["client_secret_basic"].
    - The claim types default to ["normal].
  - toJSONObject
```
public net.minidev.json.JSONObject toJSONObject()
```
    Returns the JSON object representation of this OpenID Connect provider metadata.
    
    Returns:
    
    The JSON object representation.
  - parse
```
public static OIDCProviderMetadata parse(net.minidev.json.JSONObject jsonObject)
                                  throws ParseException
```
    Parses an OpenID Connect provider metadata from the specified JSON object.
    
    Parameters:
    
    jsonObject - The JSON object to parse. Must not be null.
    
    Returns:
    
    The OpenID Connect provider metadata.
    
    Throws:
    
    ParseException - If the JSON object couldn't be parsed to an OpenID Connect provider metadata.
  - parse
```
public static OIDCProviderMetadata parse(String s)
                                  throws ParseException
```
    Parses an OpenID Connect provider metadata from the specified JSON object string.
    
    Parameters:
    
    s - The JSON object sting to parse. Must not be null.
    
    Returns:
    
    The OpenID Connect provider metadata.
    
    Throws:
    
    ParseException - If the JSON object string couldn't be parsed to an OpenID Connect provider metadata.
  - resolve
```
public static OIDCProviderMetadata resolve(Issuer issuer)
                                    throws GeneralException,
                                           IOException
```
    Resolves OpenID Provider metadata from the specified issuer identifier. The metadata is downloaded by HTTP GET from [issuer-url]/.well-known/openid-configuration.
    
    Parameters:
    
    issuer - The OpenID Provider issuer identifier. Must represent a valid HTTPS or HTTP URL. Must not be null.
    
    Returns:
    
    The OpenID Provider metadata.
    
    Throws:
    
    GeneralException - If the issuer identifier or the downloaded metadata are invalid.
    
    IOException - On a HTTP exception.
  - resolve
```
public static OIDCProviderMetadata resolve(Issuer issuer,
                                           int connectTimeout,
                                           int readTimeout)
                                    throws GeneralException,
                                           IOException
```
    Resolves OpenID Provider metadata from the specified issuer identifier. The metadata is downloaded by HTTP GET from [issuer-url]/.well-known/openid-configuration, using the specified HTTP timeouts.
    
    Parameters:
    
    issuer - The OpenID Provider issuer identifier. Must represent a valid HTTPS or HTTP URL. Must not be null.
    
    connectTimeout - The HTTP connect timeout, in milliseconds. Zero implies no timeout. Must not be negative.
    
    readTimeout - The HTTP response read timeout, in milliseconds. Zero implies no timeout. Must not be negative.
    
    Returns:
    
    The OpenID Provider metadata.
    
    Throws:
    
    GeneralException - If the issuer identifier or the downloaded metadata are invalid.
    
    IOException - On a HTTP exception.

Class OIDCProviderMetadata

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OIDCProviderMetadata

Method Detail

getRegisteredParameterNames

getIssuer

getAuthorizationEndpointURI

setAuthorizationEndpointURI

getTokenEndpointURI

setTokenEndpointURI

getUserInfoEndpointURI

setUserInfoEndpointURI

getRegistrationEndpointURI

setRegistrationEndpointURI

getIntrospectionEndpointURI

setIntrospectionEndpointURI

getRevocationEndpointURI

setRevocationEndpointURI

getCheckSessionIframeURI

setCheckSessionIframeURI

getEndSessionEndpointURI

setEndSessionEndpointURI

getJWKSetURI

getScopes

setScopes

getResponseTypes

setResponseTypes

getResponseModes

setResponseModes

getGrantTypes

setGrantTypes

getCodeChallengeMethods

setCodeChallengeMethods

getACRs

setACRs

getSubjectTypes

getTokenEndpointAuthMethods

setTokenEndpointAuthMethods

getTokenEndpointJWSAlgs

setTokenEndpointJWSAlgs

getRequestObjectJWSAlgs

setRequestObjectJWSAlgs

getRequestObjectJWEAlgs

setRequestObjectJWEAlgs

getRequestObjectJWEEncs

setRequestObjectJWEEncs

getIDTokenJWSAlgs

setIDTokenJWSAlgs

getIDTokenJWEAlgs

setIDTokenJWEAlgs

getIDTokenJWEEncs

setIDTokenJWEEncs

getUserInfoJWSAlgs

setUserInfoJWSAlgs

getUserInfoJWEAlgs

setUserInfoJWEAlgs

getUserInfoJWEEncs

setUserInfoJWEEncs

getDisplays

setDisplays

getClaimTypes

setClaimTypes

getClaims

setClaims

getClaimsLocales

setClaimLocales

getUILocales

setUILocales

getServiceDocsURI

setServiceDocsURI

getPolicyURI

setPolicyURI

getTermsOfServiceURI

setTermsOfServiceURI

supportsClaimsParam

setSupportsClaimsParams

supportsRequestParam