com.nimbusds.oauth2.sdk.client

Class ClientMetadata

java.lang.Object

com.nimbusds.oauth2.sdk.client.ClientMetadata

Direct Known Subclasses:

OIDCClientMetadata

public class ClientMetadata
extends java.lang.Object

Client metadata.

Example client metadata, serialised to a JSON object:

 {
  "redirect_uris"              : ["https://client.example.org/callback",
                                  "https://client.example.org/callback2"],
  "client_name"                : "My Example Client",
  "client_name#ja-Jpan-JP"     : "クライアント名",
  "token_endpoint_auth_method" : "client_secret_basic",
  "scope"                      : "read write dolphin",
  "logo_uri"                   : "https://client.example.org/logo.png",
  "jwks_uri"                   : "https://client.example.org/my_public_keys.jwks"
 }
 

Related specifications:

• OAuth 2.0 Dynamic Client Registration Protocol (RFC 7591), section 2.

Constructor Summary

Constructors

Constructor and Description
ClientMetadata() Creates a new OAuth 2.0 client metadata instance.
ClientMetadata(ClientMetadata metadata) Creates a shallow copy of the specified OAuth 2.0 client metadata instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyDefaults() Applies the client metadata defaults where no values have been specified.
java.util.List<javax.mail.internet.InternetAddress>	getContacts() Gets the administrator contacts for the client.
java.lang.Object	getCustomField(java.lang.String name) Gets the specified custom metadata field.
net.minidev.json.JSONObject	getCustomFields() Gets the custom metadata fields.
java.util.Set<GrantType>	getGrantTypes() Gets the expected OAuth 2.0 grant types.
com.nimbusds.jose.jwk.JWKSet	getJWKSet() Gets this client's JSON Web Key (JWK) set containing key(s) that are used in signing requests to the server and key(s) for encrypting responses.
java.net.URI	getJWKSetURI() Gets the URI for this client's JSON Web Key (JWK) set containing key(s) that are used in signing requests to the server and key(s) for encrypting responses.
java.net.URI	getLogoURI() Gets the client application logo.
java.net.URI	getLogoURI(com.nimbusds.langtag.LangTag langTag) Gets the client application logo.
java.util.Map<com.nimbusds.langtag.LangTag,java.net.URI>	getLogoURIEntries() Gets the client application logo entries.
java.lang.String	getName() Gets the client name.
java.lang.String	getName(com.nimbusds.langtag.LangTag langTag) Gets the client name.
java.util.Map<com.nimbusds.langtag.LangTag,java.lang.String>	getNameEntries() Gets the client name entries.
java.net.URI	getPolicyURI() Gets the client policy for use of end-user data.
java.net.URI	getPolicyURI(com.nimbusds.langtag.LangTag langTag) Gets the client policy for use of end-user data.
java.util.Map<com.nimbusds.langtag.LangTag,java.net.URI>	getPolicyURIEntries() Gets the client policy entries for use of end-user data.
java.util.Set<java.net.URI>	getRedirectionURIs() Gets the redirection URIs for this client.
java.util.Set<java.lang.String>	getRedirectionURIStrings() Gets the redirection URIs for this client as strings.
static java.util.Set<java.lang.String>	getRegisteredParameterNames() Gets the registered client metadata parameter names.
java.util.Set<ResponseType>	getResponseTypes() Gets the expected OAuth 2.0 response types.
Scope	getScope() Gets the scope values that the client can use when requesting access tokens.
SoftwareID	getSoftwareID() Gets the identifier for the OAuth 2.0 client software.
SoftwareVersion	getSoftwareVersion() Gets the version identifier for the OAuth 2.0 client software.
java.net.URI	getTermsOfServiceURI() Gets the client's terms of service.
java.net.URI	getTermsOfServiceURI(com.nimbusds.langtag.LangTag langTag) Gets the client's terms of service.
java.util.Map<com.nimbusds.langtag.LangTag,java.net.URI>	getTermsOfServiceURIEntries() Gets the client's terms of service entries.
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.
ClientAuthenticationMethod	getTokenEndpointAuthMethod() Gets the Token endpoint authentication method.
java.net.URI	getURI() Gets the client home page.
java.net.URI	getURI(com.nimbusds.langtag.LangTag langTag) Gets the client home page.
java.util.Map<com.nimbusds.langtag.LangTag,java.net.URI>	getURIEntries() Gets the client home page entries.
boolean	hasScopeValue(Scope.Value scopeValue) Checks if the scope matadata field is set and contains the specified scope value.
static ClientMetadata	parse(net.minidev.json.JSONObject jsonObject) Parses an client metadata instance from the specified JSON object.
void	setContacts(java.util.List<javax.mail.internet.InternetAddress> contacts) Sets the administrator contacts for the client.
void	setCustomField(java.lang.String name, java.lang.Object value) Sets the specified custom metadata field.
void	setCustomFields(net.minidev.json.JSONObject customFields) Sets the custom metadata fields.
void	setGrantTypes(java.util.Set<GrantType> grantTypes) Sets the expected OAuth 2.0 grant types.
void	setJWKSet(com.nimbusds.jose.jwk.JWKSet jwkSet) Sets this client's JSON Web Key (JWK) set containing key(s) that are used in signing requests to the server and key(s) for encrypting responses.
void	setJWKSetURI(java.net.URI jwkSetURI) Sets the URI for this client's JSON Web Key (JWK) set containing key(s) that are used in signing requests to the server and key(s) for encrypting responses.
void	setLogoURI(java.net.URI logoURI) Sets the client application logo.
void	setLogoURI(java.net.URI logoURI, com.nimbusds.langtag.LangTag langTag) Sets the client application logo.
void	setName(java.lang.String name) Sets the client name.
void	setName(java.lang.String name, com.nimbusds.langtag.LangTag langTag) Sets the client name.
void	setPolicyURI(java.net.URI policyURI) Sets the client policy for use of end-user data.
void	setPolicyURI(java.net.URI policyURI, com.nimbusds.langtag.LangTag langTag) Sets the client policy for use of end-user data.
void	setRedirectionURI(java.net.URI redirectURI) Sets a single redirection URI for this client.
void	setRedirectionURIs(java.util.Set<java.net.URI> redirectURIs) Sets the redirection URIs for this client.
void	setResponseTypes(java.util.Set<ResponseType> responseTypes) Sets the expected OAuth 2.0 response types.
void	setScope(Scope scope) Sets the scope values that the client can use when requesting access tokens.
void	setSoftwareID(SoftwareID softwareID) Sets the identifier for the OAuth 2.0 client software.
void	setSoftwareVersion(SoftwareVersion softwareVersion) Sets the version identifier for the OAuth 2.0 client software.
void	setTermsOfServiceURI(java.net.URI tosURI) Sets the client's terms of service.
void	setTermsOfServiceURI(java.net.URI tosURI, com.nimbusds.langtag.LangTag langTag) Sets the client's terms of service.
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	setTokenEndpointAuthMethod(ClientAuthenticationMethod authMethod) Sets the Token endpoint authentication method.
void	setURI(java.net.URI uri) Sets the client home page.
void	setURI(java.net.URI uri, com.nimbusds.langtag.LangTag langTag) Sets the client home page.
net.minidev.json.JSONObject	toJSONObject() Returns the JSON object representation of this client metadata, including any custom fields.
net.minidev.json.JSONObject	toJSONObject(boolean includeCustomFields) Returns the JSON object representation of this client metadata.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientMetadata

public ClientMetadata()

Creates a new OAuth 2.0 client metadata instance.

ClientMetadata

public ClientMetadata(ClientMetadata metadata)

Creates a shallow copy of the specified OAuth 2.0 client metadata instance.

Parameters:

metadata - The client metadata to copy. Must not be null.

Method Detail

getRegisteredParameterNames

public static java.util.Set<java.lang.String> getRegisteredParameterNames()

Gets the registered client metadata parameter names.

Returns:

The registered parameter names, as an unmodifiable set.

getRedirectionURIs

public java.util.Set<java.net.URI> getRedirectionURIs()

Gets the redirection URIs for this client. Corresponds to the redirect_uris client metadata field.

Returns:

The redirection URIs, null if not specified.

getRedirectionURIStrings

public java.util.Set<java.lang.String> getRedirectionURIStrings()

Gets the redirection URIs for this client as strings. Corresponds to the redirect_uris client metadata field.

This short-hand method is intended to enable string-based URI comparison.

Returns:

The redirection URIs as strings, null if not specified.

setRedirectionURIs

public void setRedirectionURIs(java.util.Set<java.net.URI> redirectURIs)

Sets the redirection URIs for this client. Corresponds to the redirect_uris client metadata field.

Parameters:

redirectURIs - The redirection URIs, null if not specified.

setRedirectionURI

public void setRedirectionURI(java.net.URI redirectURI)

Sets a single redirection URI for this client. Corresponds to the redirect_uris client metadata field.

Parameters:

redirectURI - The redirection URIs, null if not specified.

getScope

public Scope getScope()

Gets the scope values that the client can use when requesting access tokens. Corresponds to the scope client metadata field.

Returns:

The scope, null if not specified.

hasScopeValue

public boolean hasScopeValue(Scope.Value scopeValue)

Checks if the scope matadata field is set and contains the specified scope value.

Parameters:

scopeValue - The scope value. Must not be null.

Returns:

true if the scope value is contained, else false.

setScope

public void setScope(Scope scope)

Sets the scope values that the client can use when requesting access tokens. Corresponds to the scope client metadata field.

Parameters:

scope - The scope, null if not specified.

getResponseTypes

public java.util.Set<ResponseType> getResponseTypes()

Gets the expected OAuth 2.0 response types. Corresponds to the response_types client metadata field.

Returns:

The response types, null if not specified.

setResponseTypes

public void setResponseTypes(java.util.Set<ResponseType> responseTypes)

Sets the expected OAuth 2.0 response types. Corresponds to the response_types client metadata field.

Parameters:

responseTypes - The response types, null if not specified.

getGrantTypes

public java.util.Set<GrantType> getGrantTypes()

Gets the expected OAuth 2.0 grant types. Corresponds to the grant_types client metadata field.

Returns:

The grant types, null if not specified.

setGrantTypes

public void setGrantTypes(java.util.Set<GrantType> grantTypes)

Sets the expected OAuth 2.0 grant types. Corresponds to the grant_types client metadata field.

Parameters:

grantTypes - The grant types, null if not specified.

getContacts

public java.util.List<javax.mail.internet.InternetAddress> getContacts()

Gets the administrator contacts for the client. Corresponds to the contacts client metadata field.

Returns:

The administrator contacts, null if not specified.

setContacts

public void setContacts(java.util.List<javax.mail.internet.InternetAddress> contacts)

Sets the administrator contacts for the client. Corresponds to the contacts client metadata field.

Parameters:

contacts - The administrator contacts, null if not specified.

getName

public java.lang.String getName()

Gets the client name. Corresponds to the client_name client metadata field, with no language tag.

Returns:

The client name, null if not specified.

getName

public java.lang.String getName(com.nimbusds.langtag.LangTag langTag)

Gets the client name. Corresponds to the client_name client metadata field, with an optional language tag.

Parameters:

langTag - The language tag of the entry, null to get the non-tagged entry.

Returns:

The client name, null if not specified.

getNameEntries

public java.util.Map<com.nimbusds.langtag.LangTag,java.lang.String> getNameEntries()

Gets the client name entries. Corresponds to the client_name client metadata field.

Returns:

The client name entries, empty map if none.

setName

public void setName(java.lang.String name)

Sets the client name. Corresponds to the client_name client metadata field, with no language tag.

Parameters:

name - The client name, null if not specified.

setName

public void setName(java.lang.String name,
           com.nimbusds.langtag.LangTag langTag)

Sets the client name. Corresponds to the client_name client metadata field, with an optional language tag.

Parameters:

name - The client name. Must not be null.

langTag - The language tag, null if not specified.

getLogoURI

public java.net.URI getLogoURI()

Gets the client application logo. Corresponds to the logo_uri client metadata field, with no language tag.

Returns:

The logo URI, null if not specified.

getLogoURI

public java.net.URI getLogoURI(com.nimbusds.langtag.LangTag langTag)

Gets the client application logo. Corresponds to the logo_uri client metadata field, with an optional language tag.

Returns:

The logo URI, null if not specified.

getLogoURIEntries

public java.util.Map<com.nimbusds.langtag.LangTag,java.net.URI> getLogoURIEntries()

Gets the client application logo entries. Corresponds to the logo_uri client metadata field.

Returns:

The logo URI entries, empty map if none.

setLogoURI

public void setLogoURI(java.net.URI logoURI)

Sets the client application logo. Corresponds to the logo_uri client metadata field, with no language tag.

Parameters:

logoURI - The logo URI, null if not specified.

setLogoURI

public void setLogoURI(java.net.URI logoURI,
              com.nimbusds.langtag.LangTag langTag)

Sets the client application logo. Corresponds to the logo_uri client metadata field, with an optional language tag.

Parameters:

logoURI - The logo URI. Must not be null.

langTag - The language tag, null if not specified.

getURI

public java.net.URI getURI()

Gets the client home page. Corresponds to the client_uri client metadata field, with no language tag.

Returns:

The client URI, null if not specified.

getURI

public java.net.URI getURI(com.nimbusds.langtag.LangTag langTag)

Gets the client home page. Corresponds to the client_uri client metadata field, with an optional language tag.

Returns:

The client URI, null if not specified.

getURIEntries

public java.util.Map<com.nimbusds.langtag.LangTag,java.net.URI> getURIEntries()

Gets the client home page entries. Corresponds to the client_uri client metadata field.

Returns:

The client URI entries, empty map if none.

setURI

public void setURI(java.net.URI uri)

Sets the client home page. Corresponds to the client_uri client metadata field, with no language tag.

Parameters:

uri - The client URI, null if not specified.

setURI

public void setURI(java.net.URI uri,
          com.nimbusds.langtag.LangTag langTag)

Sets the client home page. Corresponds to the client_uri client metadata field, with an optional language tag.

Parameters:

uri - The URI. Must not be null.

langTag - The language tag, null if not specified.

getPolicyURI

public java.net.URI getPolicyURI()

Gets the client policy for use of end-user data. Corresponds to the policy_uri client metadata field, with no language tag.

Returns:

The policy URI, null if not specified.

getPolicyURI

public java.net.URI getPolicyURI(com.nimbusds.langtag.LangTag langTag)

Gets the client policy for use of end-user data. Corresponds to the policy_uri client metadata field, with an optional language tag.

Returns:

The policy URI, null if not specified.

getPolicyURIEntries

public java.util.Map<com.nimbusds.langtag.LangTag,java.net.URI> getPolicyURIEntries()

Gets the client policy entries for use of end-user data. Corresponds to the policy_uri client metadata field.

Returns:

The policy URI entries, empty map if none.

setPolicyURI

public void setPolicyURI(java.net.URI policyURI)

Sets the client policy for use of end-user data. Corresponds to the policy_uri client metadata field, with no language tag.

Parameters:

policyURI - The policy URI, null if not specified.

setPolicyURI

public void setPolicyURI(java.net.URI policyURI,
                com.nimbusds.langtag.LangTag langTag)

Sets the client policy for use of end-user data. Corresponds to the policy_uri client metadata field, with an optional language tag.

Parameters:

policyURI - The policy URI. Must not be null.

langTag - The language tag, null if not specified.

getTermsOfServiceURI

public java.net.URI getTermsOfServiceURI()

Gets the client's terms of service. Corresponds to the tos_uri client metadata field, with no language tag.

Returns:

The terms of service URI, null if not specified.

getTermsOfServiceURI

public java.net.URI getTermsOfServiceURI(com.nimbusds.langtag.LangTag langTag)

Gets the client's terms of service. Corresponds to the tos_uri client metadata field, with an optional language tag.

Returns:

The terms of service URI, null if not specified.

getTermsOfServiceURIEntries

public java.util.Map<com.nimbusds.langtag.LangTag,java.net.URI> getTermsOfServiceURIEntries()

Gets the client's terms of service entries. Corresponds to the tos_uri client metadata field.

Returns:

The terms of service URI entries, empty map if none.

setTermsOfServiceURI

public void setTermsOfServiceURI(java.net.URI tosURI)

Sets the client's terms of service. Corresponds to the tos_uri client metadata field, with no language tag.

Parameters:

tosURI - The terms of service URI, null if not specified.

setTermsOfServiceURI

public void setTermsOfServiceURI(java.net.URI tosURI,
                        com.nimbusds.langtag.LangTag langTag)

Sets the client's terms of service. Corresponds to the tos_uri client metadata field, with an optional language tag.

Parameters:

tosURI - The terms of service URI. Must not be null.

langTag - The language tag, null if not specified.

getTokenEndpointAuthMethod

public ClientAuthenticationMethod getTokenEndpointAuthMethod()

Gets the Token endpoint authentication method. Corresponds to the token_endpoint_auth_method client metadata field.

Returns:

The Token endpoint authentication method, null if not specified.

setTokenEndpointAuthMethod

public void setTokenEndpointAuthMethod(ClientAuthenticationMethod authMethod)

Sets the Token endpoint authentication method. Corresponds to the token_endpoint_auth_method client metadata field.

Parameters:

authMethod - The Token endpoint authentication 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.

getJWKSetURI

public java.net.URI getJWKSetURI()

Gets the URI for this client's JSON Web Key (JWK) set containing key(s) that are used in signing requests to the server and key(s) for encrypting responses. Corresponds to the jwks_uri client metadata field.

Returns:

The JWK set URI, null if not specified.

setJWKSetURI

public void setJWKSetURI(java.net.URI jwkSetURI)

Sets the URI for this client's JSON Web Key (JWK) set containing key(s) that are used in signing requests to the server and key(s) for encrypting responses. Corresponds to the jwks_uri client metadata field.

Parameters:

jwkSetURI - The JWK set URI, null if not specified.

getJWKSet

public com.nimbusds.jose.jwk.JWKSet getJWKSet()

Gets this client's JSON Web Key (JWK) set containing key(s) that are used in signing requests to the server and key(s) for encrypting responses. Intended as an alternative to getJWKSetURI() for native clients. Corresponds to the jwks client metadata field.

Returns:

The JWK set, null if not specified.

setJWKSet

public void setJWKSet(com.nimbusds.jose.jwk.JWKSet jwkSet)

Sets this client's JSON Web Key (JWK) set containing key(s) that are used in signing requests to the server and key(s) for encrypting responses. Intended as an alternative to getJWKSetURI() for native clients. Corresponds to the jwks client metadata field.

Parameters:

jwkSet - The JWK set, null if not specified.

getSoftwareID

public SoftwareID getSoftwareID()

Gets the identifier for the OAuth 2.0 client software. Corresponds to the software_id client metadata field.

Returns:

The software identifier, null if not specified.

setSoftwareID

public void setSoftwareID(SoftwareID softwareID)

Sets the identifier for the OAuth 2.0 client software. Corresponds to the software_id client metadata field.

Parameters:

softwareID - The software identifier, null if not specified.

getSoftwareVersion

public SoftwareVersion getSoftwareVersion()

Gets the version identifier for the OAuth 2.0 client software. Corresponds to the software_version client metadata field.

Returns:

The version identifier, null if not specified.

setSoftwareVersion

public void setSoftwareVersion(SoftwareVersion softwareVersion)

Sets the version identifier for the OAuth 2.0 client software. Corresponds to the software_version client metadata field.

Parameters:

softwareVersion - The version identifier, null if not specified.

getCustomField

public java.lang.Object getCustomField(java.lang.String name)

Gets the specified custom metadata field.

Parameters:

name - The field name. Must not be null.

Returns:

The field value, typically serialisable to a JSON entity, null if none.

getCustomFields

public net.minidev.json.JSONObject getCustomFields()

Gets the custom metadata fields.

Returns:

The custom metadata fields, as a JSON object, empty object if none.

setCustomField

public void setCustomField(java.lang.String name,
                  java.lang.Object value)

Sets the specified custom metadata field.

Parameters:

name - The field name. Must not be null.

value - The field value. Should serialise to a JSON entity.

setCustomFields

public void setCustomFields(net.minidev.json.JSONObject customFields)

Sets the custom metadata fields.

Parameters:

customFields - The custom metadata fields, as a JSON object, empty object if none. Must not be null.

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", unless the grant type is "implicit" only.

toJSONObject

public net.minidev.json.JSONObject toJSONObject()

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

Returns:

The JSON object.

toJSONObject

public net.minidev.json.JSONObject toJSONObject(boolean includeCustomFields)

Returns the JSON object representation of this client metadata.

Parameters:

includeCustomFields - true to include any custom metadata fields, false to omit them.

Returns:

The JSON object.

parse

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

Parses an client metadata instance from the specified JSON object.

Parameters:

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

Returns:

The client metadata.

Throws:

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