com.nimbusds.oauth2.sdk.client

Class ClientInformation

java.lang.Object

com.nimbusds.oauth2.sdk.client.ClientInformation

Direct Known Subclasses:

OIDCClientInformation

@Immutable
public class ClientInformation
extends Object

Client information. Encapsulates the registration and metadata details of an OAuth 2.0 client:

• The client identifier.
• The client registration URI and access token.
• The client metadata.
• The optional client secret for a confidential client.

Related specifications:

• OAuth 2.0 Dynamic Client Registration Protocol (draft-ietf-oauth-dyn-reg-14), sections 2, 3.2 and 5.1.

Constructor Summary

Constructors

Constructor and Description
ClientInformation(ClientID id, URI registrationURI, BearerAccessToken accessToken, ClientMetadata metadata, Secret secret, Date issueDate) Creates a new client information instance.

Method Summary

Methods

Modifier and Type	Method and Description
ClientMetadata	getClientMetadata() Gets the client metadata.
ClientID	getID() Gets the client ID.
Date	getIssueDate() Gets the issue date of the client identifier.
static Set<String>	getRegisteredParameterNames() Gets the registered client metadata parameter names.
BearerAccessToken	getRegistrationAccessToken() Gets the registration access token.
URI	getRegistrationURI() Gets the URI of the client registration.
Secret	getSecret() Gets the client secret.
static ClientInformation	parse(net.minidev.json.JSONObject jsonObject) Parses a client information instance from the specified JSON object.
net.minidev.json.JSONObject	toJSONObject() Returns the JSON object representation of this client information instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientInformation

public ClientInformation(ClientID id,
                 URI registrationURI,
                 BearerAccessToken accessToken,
                 ClientMetadata metadata,
                 Secret secret,
                 Date issueDate)

Creates a new client information instance.

Parameters:

id - The client identifier. Must not be null.

registrationURI - The client registration URI. Must not be null.

accessToken - The client registration access token. Must not be null.

metadata - The client metadata. Must not be null.

secret - The optional client secret, null if not specified.

issueDate - The issue date of the client identifier, null if not specified.

Method Detail

getRegisteredParameterNames

public static Set<String> getRegisteredParameterNames()

Gets the registered client metadata parameter names.

Returns:

The registered parameter names, as an unmodifiable set.

getID

public ClientID getID()

Gets the client ID. Corresponds to the client_id client registration parameter.

Returns:

The client ID, null if not specified.

getRegistrationURI

public URI getRegistrationURI()

Gets the URI of the client registration. Corresponds to the registration_client_uri client registration parameter.

Returns:

The registration URI, null if not specified.

getRegistrationAccessToken

public BearerAccessToken getRegistrationAccessToken()

Gets the registration access token. Corresponds to the registration_access_token client registration parameter.

Returns:

The registration access token, null if not specified.

getClientMetadata

public ClientMetadata getClientMetadata()

Gets the client metadata.

Returns:

The client metadata.

getSecret

public Secret getSecret()

Gets the client secret. Corresponds to the client_secret and client_secret_expires_at client registration parameters.

Returns:

The client secret, null if not specified.

getIssueDate

public Date getIssueDate()

Gets the issue date of the client identifier. Corresponds to the client_id_issued_at client registration parameter.

Returns:

The issue date, null if not specified.

toJSONObject

public net.minidev.json.JSONObject toJSONObject()

Returns the JSON object representation of this client information instance.

Returns:

The JSON object.

parse

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

Parses a client information instance from the specified JSON object.

Parameters:

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

Returns:

The client information.

Throws:

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