com.nimbusds.openid.connect.sdk.rp

Class OIDCClientMetadata

java.lang.Object

com.nimbusds.oauth2.sdk.client.ClientMetadata

com.nimbusds.openid.connect.sdk.rp.OIDCClientMetadata

public class OIDCClientMetadata
extends ClientMetadata

OpenID Connect client metadata.

Related specifications:

• OpenID Connect Dynamic Client Registration 1.0, section 2.
• OpenID Connect Session Management 1.0, section 5.1.1. <
• OAuth 2.0 Dynamic Client Registration Protocol (draft-ietf-oauth-dyn-reg-20), section 2.

Constructor Summary

Constructors

Constructor and Description
OIDCClientMetadata() Creates a new OpenID Connect client metadata instance.
OIDCClientMetadata(ClientMetadata metadata) Creates a new OpenID Connect client metadata instance from the specified base OAuth 2.0 client metadata.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyDefaults() Applies the client metadata defaults where no values have been specified.
ApplicationType	getApplicationType() Gets the client application type.
List<ACR>	getDefaultACRs() Gets the default Authentication Context Class Reference (ACR) values.
int	getDefaultMaxAge() Gets the default maximum authentication age.
com.nimbusds.jose.JWEAlgorithm	getIDTokenJWEAlg() Gets the JSON Web Encryption (JWE) algorithm required for the ID Tokens issued to this client.
com.nimbusds.jose.EncryptionMethod	getIDTokenJWEEnc() Gets the JSON Web Encryption (JWE) method required for the ID Tokens issued to this client.
com.nimbusds.jose.JWSAlgorithm	getIDTokenJWSAlg() Gets the JSON Web Signature (JWS) algorithm required for the ID Tokens issued to this client.
URI	getInitiateLoginURI() Gets the HTTPS URI that the authorisation server can call to initiate a login at the client.
Set<URI>	getPostLogoutRedirectionURIs() Gets the post logout redirection URIs.
static Set<String>	getRegisteredParameterNames() Gets the registered OpenID Connect client metadata parameter names.
com.nimbusds.jose.JWEAlgorithm	getRequestObjectJWEAlg() Gets the JSON Web Encryption (JWE) algorithm required for the OpenID Connect request objects sent by this client.
com.nimbusds.jose.EncryptionMethod	getRequestObjectJWEEnc() Gets the JSON Web Encryption (JWE) method required for the OpenID Connect request objects sent by this client.
com.nimbusds.jose.JWSAlgorithm	getRequestObjectJWSAlg() Gets the JSON Web Signature (JWS) algorithm required for the OpenID Connect request objects sent by this client.
Set<URI>	getRequestObjectURIs() Gets the pre-registered OpenID Connect request object URIs.
URI	getSectorIDURI() Gets the sector identifier URI.
SubjectType	getSubjectType() Gets the subject identifier type for responses to this client.
com.nimbusds.jose.JWSAlgorithm	getTokenEndpointAuthJWSAlg() Gets the JSON Web Signature (JWS) algorithm required for private_key_jwt and client_secret_jwt authentication at the Token endpoint.
com.nimbusds.jose.JWEAlgorithm	getUserInfoJWEAlg() Gets the JSON Web Encryption (JWE) algorithm required for the UserInfo responses to this client.
com.nimbusds.jose.EncryptionMethod	getUserInfoJWEEnc() Gets the JSON Web Encryption (JWE) method required for the UserInfo responses to this client.
com.nimbusds.jose.JWSAlgorithm	getUserInfoJWSAlg() Gets the JSON Web Signature (JWS) algorithm required for the UserInfo responses to this client.
static OIDCClientMetadata	parse(net.minidev.json.JSONObject jsonObject) Parses an OpenID Connect client metadata instance from the specified JSON object.
boolean	requiresAuthTime() Gets the default requirement for the auth_time claim in the ID Token.
void	requiresAuthTime(boolean requiresAuthTime) Sets the default requirement for the auth_time claim in the ID Token.
void	setApplicationType(ApplicationType applicationType) Sets the client application type.
void	setDefaultACRs(List<ACR> defaultACRs) Sets the default Authentication Context Class Reference (ACR) values.
void	setDefaultMaxAge(int defaultMaxAge) Sets the default maximum authentication age.
void	setIDTokenJWEAlg(com.nimbusds.jose.JWEAlgorithm idTokenJWEAlg) Sets the JSON Web Encryption (JWE) algorithm required for the ID Tokens issued to this client.
void	setIDTokenJWEEnc(com.nimbusds.jose.EncryptionMethod idTokenJWEEnc) Sets the JSON Web Encryption (JWE) method required for the ID Tokens issued to this client.
void	setIDTokenJWSAlg(com.nimbusds.jose.JWSAlgorithm idTokenJWSAlg) Sets the JSON Web Signature (JWS) algorithm required for the ID Tokens issued to this client.
void	setInitiateLoginURI(URI loginURI) Sets the HTTPS URI that the authorisation server can call to initiate a login at the client.
void	setPostLogoutRedirectionURIs(Set<URI> logoutURIs) Sets the post logout redirection URIs.
void	setRequestObjectJWEAlg(com.nimbusds.jose.JWEAlgorithm requestObjectJWEAlg) Sets the JSON Web Encryption (JWE) algorithm required for the OpenID Connect request objects sent by this client.
void	setRequestObjectJWEEnc(com.nimbusds.jose.EncryptionMethod requestObjectJWEEnc) Sets the JSON Web Encryption (JWE) method required for the OpenID Connect request objects sent by this client.
void	setRequestObjectJWSAlg(com.nimbusds.jose.JWSAlgorithm requestObjectJWSAlg) Sets the JSON Web Signature (JWS) algorithm required for the OpenID Connect request objects sent by this client.
void	setRequestObjectURIs(Set<URI> requestObjectURIs) Sets the pre-registered OpenID Connect request object URIs.
void	setSectorIDURI(URI sectorIDURI) Sets the sector identifier URI.
void	setSubjectType(SubjectType subjectType) Sets the subject identifier type for responses to this client.
void	setTokenEndpointAuthJWSAlg(com.nimbusds.jose.JWSAlgorithm authJWSAlg) Sets the JSON Web Signature (JWS) algorithm required for private_key_jwt and client_secret_jwt authentication at the Token endpoint.
void	setUserInfoJWEAlg(com.nimbusds.jose.JWEAlgorithm userInfoJWEAlg) Sets the JSON Web Encryption (JWE) algorithm required for the UserInfo responses to this client.
void	setUserInfoJWEEnc(com.nimbusds.jose.EncryptionMethod userInfoJWEEnc) Sets the JSON Web Encryption (JWE) method required for the UserInfo responses to this client.
void	setUserInfoJWSAlg(com.nimbusds.jose.JWSAlgorithm userInfoJWSAlg) Sets the JSON Web Signature (JWS) algorithm required for the UserInfo responses to this client.
net.minidev.json.JSONObject	toJSONObject() Returns the JSON object representation of this client metadata, including any custom fields.

Methods inherited from class com.nimbusds.oauth2.sdk.client.ClientMetadata

getContacts, getCustomField, getCustomFields, getGrantTypes, getJWKSet, getJWKSetURI, getLogoURI, getLogoURI, getLogoURIEntries, getName, getName, getNameEntries, getPolicyURI, getPolicyURI, getPolicyURIEntries, getRedirectionURIs, getRedirectionURIStrings, getResponseTypes, getScope, getSoftwareID, getSoftwareVersion, getTermsOfServiceURI, getTermsOfServiceURI, getTermsOfServiceURIEntries, getTokenEndpointAuthMethod, getURI, getURI, getURIEntries, setContacts, setCustomField, setCustomFields, setGrantTypes, setJWKSet, setJWKSetURI, setLogoURI, setLogoURI, setName, setName, setPolicyURI, setPolicyURI, setRedirectionURI, setRedirectionURIs, setResponseTypes, setScope, setSoftwareID, setSoftwareVersion, setTermsOfServiceURI, setTermsOfServiceURI, setTokenEndpointAuthMethod, setURI, setURI, toJSONObject

Methods inherited from class java.lang.Object

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

Constructor Detail

OIDCClientMetadata

public OIDCClientMetadata()

Creates a new OpenID Connect client metadata instance.

OIDCClientMetadata

public OIDCClientMetadata(ClientMetadata metadata)

Creates a new OpenID Connect client metadata instance from the specified base OAuth 2.0 client metadata.

Parameters:

metadata - The base OAuth 2.0 client metadata. Must not be null.

Method Detail

getRegisteredParameterNames

public static Set<String> getRegisteredParameterNames()

Gets the registered OpenID Connect client metadata parameter names.

Returns:

The registered OpenID Connect parameter names, as an unmodifiable set.

getApplicationType

public ApplicationType getApplicationType()

Gets the client application type. Corresponds to the application_type client metadata field.

Returns:

The client application type, null if not specified.

setApplicationType

public void setApplicationType(ApplicationType applicationType)

Sets the client application type. Corresponds to the application_type client metadata field.

Parameters:

applicationType - The client application type, null if not specified.

getSubjectType

public SubjectType getSubjectType()

Gets the subject identifier type for responses to this client. Corresponds to the subject_type client metadata field.

Returns:

The subject identifier type, null if not specified.

setSubjectType

public void setSubjectType(SubjectType subjectType)

Sets the subject identifier type for responses to this client. Corresponds to the subject_type client metadata field.

Parameters:

subjectType - The subject identifier type, null if not specified.

getSectorIDURI

public URI getSectorIDURI()

Gets the sector identifier URI. Corresponds to the sector_identifier_uri client metadata field.

Returns:

The sector identifier URI, null if not specified.

setSectorIDURI

public void setSectorIDURI(URI sectorIDURI)

Sets the sector identifier URI. Corresponds to the sector_identifier_uri client metadata field.

Parameters:

sectorIDURI - The sector identifier URI, null if not specified.

getRequestObjectURIs

public Set<URI> getRequestObjectURIs()

Gets the pre-registered OpenID Connect request object URIs. Corresponds to the request_uris client metadata field.

Returns:

The request object URIs, null if not specified.

setRequestObjectURIs

public void setRequestObjectURIs(Set<URI> requestObjectURIs)

Sets the pre-registered OpenID Connect request object URIs. Corresponds to the request_uris client metadata field.

Parameters:

requestObjectURIs - The request object URIs, null if not specified.

getRequestObjectJWSAlg

public com.nimbusds.jose.JWSAlgorithm getRequestObjectJWSAlg()

Gets the JSON Web Signature (JWS) algorithm required for the OpenID Connect request objects sent by this client. Corresponds to the request_object_signing_alg client metadata field.

Returns:

The JWS algorithm, null if not specified.

setRequestObjectJWSAlg

public void setRequestObjectJWSAlg(com.nimbusds.jose.JWSAlgorithm requestObjectJWSAlg)

Sets the JSON Web Signature (JWS) algorithm required for the OpenID Connect request objects sent by this client. Corresponds to the request_object_signing_alg client metadata field.

Parameters:

requestObjectJWSAlg - The JWS algorithm, null if not specified.

getRequestObjectJWEAlg

public com.nimbusds.jose.JWEAlgorithm getRequestObjectJWEAlg()

Gets the JSON Web Encryption (JWE) algorithm required for the OpenID Connect request objects sent by this client. Corresponds to the request_object_encryption_alg client metadata field.

Returns:

The JWE algorithm, null if not specified.

setRequestObjectJWEAlg

public void setRequestObjectJWEAlg(com.nimbusds.jose.JWEAlgorithm requestObjectJWEAlg)

Sets the JSON Web Encryption (JWE) algorithm required for the OpenID Connect request objects sent by this client. Corresponds to the request_object_encryption_alg client metadata field.

Parameters:

requestObjectJWEAlg - The JWE algorithm, null if not specified.

getRequestObjectJWEEnc

public com.nimbusds.jose.EncryptionMethod getRequestObjectJWEEnc()

Gets the JSON Web Encryption (JWE) method required for the OpenID Connect request objects sent by this client. Corresponds to the request_object_encryption_enc client metadata field.

Returns:

The JWE method, null if not specified.

setRequestObjectJWEEnc

public void setRequestObjectJWEEnc(com.nimbusds.jose.EncryptionMethod requestObjectJWEEnc)

Sets the JSON Web Encryption (JWE) method required for the OpenID Connect request objects sent by this client. Corresponds to the request_object_encryption_enc client metadata field.

Parameters:

requestObjectJWEEnc - The JWE method, null if not specified.

getTokenEndpointAuthJWSAlg

public com.nimbusds.jose.JWSAlgorithm getTokenEndpointAuthJWSAlg()

Gets the JSON Web Signature (JWS) algorithm required for private_key_jwt and client_secret_jwt authentication at the Token endpoint. Corresponds to the token_endpoint_auth_signing_alg client metadata field.

Returns:

The JWS algorithm, null if not specified.

setTokenEndpointAuthJWSAlg

public void setTokenEndpointAuthJWSAlg(com.nimbusds.jose.JWSAlgorithm authJWSAlg)

Sets the JSON Web Signature (JWS) algorithm required for private_key_jwt and client_secret_jwt authentication at the Token endpoint. Corresponds to the token_endpoint_auth_signing_alg client metadata field.

Parameters:

authJWSAlg - The JWS algorithm, null if not specified.

getIDTokenJWSAlg

public com.nimbusds.jose.JWSAlgorithm getIDTokenJWSAlg()

Gets the JSON Web Signature (JWS) algorithm required for the ID Tokens issued to this client. Corresponds to the id_token_signed_response_alg client metadata field.

Returns:

The JWS algorithm, null if not specified.

setIDTokenJWSAlg

public void setIDTokenJWSAlg(com.nimbusds.jose.JWSAlgorithm idTokenJWSAlg)

Sets the JSON Web Signature (JWS) algorithm required for the ID Tokens issued to this client. Corresponds to the id_token_signed_response_alg client metadata field.

Parameters:

idTokenJWSAlg - The JWS algorithm, null if not specified.

getIDTokenJWEAlg

public com.nimbusds.jose.JWEAlgorithm getIDTokenJWEAlg()

Gets the JSON Web Encryption (JWE) algorithm required for the ID Tokens issued to this client. Corresponds to the id_token_encrypted_response_alg client metadata field.

Returns:

The JWE algorithm, null if not specified.

setIDTokenJWEAlg

public void setIDTokenJWEAlg(com.nimbusds.jose.JWEAlgorithm idTokenJWEAlg)

Sets the JSON Web Encryption (JWE) algorithm required for the ID Tokens issued to this client. Corresponds to the id_token_encrypted_response_alg client metadata field.

Parameters:

idTokenJWEAlg - The JWE algorithm, null if not specified.

getIDTokenJWEEnc

public com.nimbusds.jose.EncryptionMethod getIDTokenJWEEnc()

Gets the JSON Web Encryption (JWE) method required for the ID Tokens issued to this client. Corresponds to the id_token_encrypted_response_enc client metadata field.

Returns:

The JWE method, null if not specified.

setIDTokenJWEEnc

public void setIDTokenJWEEnc(com.nimbusds.jose.EncryptionMethod idTokenJWEEnc)

Sets the JSON Web Encryption (JWE) method required for the ID Tokens issued to this client. Corresponds to the id_token_encrypted_response_enc client metadata field.

Parameters:

idTokenJWEEnc - The JWE method, null if not specified.

getUserInfoJWSAlg

public com.nimbusds.jose.JWSAlgorithm getUserInfoJWSAlg()

Gets the JSON Web Signature (JWS) algorithm required for the UserInfo responses to this client. Corresponds to the userinfo_signed_response_alg client metadata field.

Returns:

The JWS algorithm, null if not specified.

setUserInfoJWSAlg

public void setUserInfoJWSAlg(com.nimbusds.jose.JWSAlgorithm userInfoJWSAlg)

Sets the JSON Web Signature (JWS) algorithm required for the UserInfo responses to this client. Corresponds to the userinfo_signed_response_alg client metadata field.

Parameters:

userInfoJWSAlg - The JWS algorithm, null if not specified.

getUserInfoJWEAlg

public com.nimbusds.jose.JWEAlgorithm getUserInfoJWEAlg()

Gets the JSON Web Encryption (JWE) algorithm required for the UserInfo responses to this client. Corresponds to the userinfo_encrypted_response_alg client metadata field.

Returns:

The JWE algorithm, null if not specified.

setUserInfoJWEAlg

public void setUserInfoJWEAlg(com.nimbusds.jose.JWEAlgorithm userInfoJWEAlg)

Sets the JSON Web Encryption (JWE) algorithm required for the UserInfo responses to this client. Corresponds to the userinfo_encrypted_response_alg client metadata field.

Parameters:

userInfoJWEAlg - The JWE algorithm, null if not specified.

getUserInfoJWEEnc

public com.nimbusds.jose.EncryptionMethod getUserInfoJWEEnc()

Gets the JSON Web Encryption (JWE) method required for the UserInfo responses to this client. Corresponds to the userinfo_encrypted_response_enc client metadata field.

Returns:

The JWE method, null if not specified.

setUserInfoJWEEnc

public void setUserInfoJWEEnc(com.nimbusds.jose.EncryptionMethod userInfoJWEEnc)

Sets the JSON Web Encryption (JWE) method required for the UserInfo responses to this client. Corresponds to the userinfo_encrypted_response_enc client metadata field.

Parameters:

userInfoJWEEnc - The JWE method, null if not specified.

getDefaultMaxAge

public int getDefaultMaxAge()

Gets the default maximum authentication age. Corresponds to the default_max_age client metadata field.

Returns:

The default max authentication age, in seconds. If not specified 0.

setDefaultMaxAge

public void setDefaultMaxAge(int defaultMaxAge)

Sets the default maximum authentication age. Corresponds to the default_max_age client metadata field.

Parameters:

defaultMaxAge - The default max authentication age, in seconds. If not specified 0.

requiresAuthTime

public boolean requiresAuthTime()

Gets the default requirement for the auth_time claim in the ID Token. Corresponds to the require_auth_time client metadata field.

Returns:

If true the auth_Time claim in the ID Token is required by default.

requiresAuthTime

public void requiresAuthTime(boolean requiresAuthTime)

Sets the default requirement for the auth_time claim in the ID Token. Corresponds to the require_auth_time client metadata field.

Parameters:

requiresAuthTime - If true the auth_Time claim in the ID Token is required by default.

getDefaultACRs

public List<ACR> getDefaultACRs()

Gets the default Authentication Context Class Reference (ACR) values. Corresponds to the default_acr_values client metadata field.

Returns:

The default ACR values, by order of preference, null if not specified.

setDefaultACRs

public void setDefaultACRs(List<ACR> defaultACRs)

Sets the default Authentication Context Class Reference (ACR) values. Corresponds to the default_acr_values client metadata field.

Parameters:

defaultACRs - The default ACRs, by order of preference, null if not specified.

getInitiateLoginURI

public URI getInitiateLoginURI()

Gets the HTTPS URI that the authorisation server can call to initiate a login at the client. Corresponds to the initiate_login_uri client metadata field.

Returns:

The login URI, null if not specified.

setInitiateLoginURI

public void setInitiateLoginURI(URI loginURI)

Sets the HTTPS URI that the authorisation server can call to initiate a login at the client. Corresponds to the initiate_login_uri client metadata field.

Parameters:

loginURI - The login URI, null if not specified.

getPostLogoutRedirectionURIs

public Set<URI> getPostLogoutRedirectionURIs()

Gets the post logout redirection URIs. Corresponds to the post_logout_redirect_uris client metadata field.

Returns:

The logout redirection URIs, null if not specified.

setPostLogoutRedirectionURIs

public void setPostLogoutRedirectionURIs(Set<URI> logoutURIs)

Sets the post logout redirection URIs. Corresponds to the post_logout_redirect_uris client metadata field.

Parameters:

logoutURIs - The logout redirection URIs, null if not specified.

applyDefaults

public void applyDefaults()

Applies the client metadata defaults where no values have been specified.

• The response types default to ["code"].
• The grant types default to "authorization_code".
• The client authentication method defaults to "client_secret_basic".
• The application type defaults to ApplicationType.WEB.
• The ID token JWS algorithm defaults to "RS256".

Overrides:

applyDefaults in class ClientMetadata

toJSONObject

public net.minidev.json.JSONObject toJSONObject()

Description copied from class: ClientMetadata

Returns the JSON object representation of this client metadata, including any custom fields.

Overrides:

toJSONObject in class ClientMetadata

Returns:

The JSON object.

parse

public static OIDCClientMetadata parse(net.minidev.json.JSONObject jsonObject)
                                throws ParseException

Parses an OpenID Connect client metadata instance from the specified JSON object.

Parameters:

jsonObject - The JSON object to parse. Must not be null.

Returns:

The OpenID Connect client metadata.

Throws:

ParseException - If the JSON object couldn't be parsed to an OpenID Connect client metadata instance.