com.nimbusds.openid.connect.sdk.rp

Class OIDCClientInformation

java.lang.Object

com.nimbusds.oauth2.sdk.client.ClientInformation

com.nimbusds.openid.connect.sdk.rp.OIDCClientInformation

@Immutable
public final class OIDCClientInformation
extends ClientInformation

OpenID Connect client information. Encapsulates the registration and metadata details of an OpenID Connect client:

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

Related specifications:

• OpenID Connect Dynamic Client Registration 1.0.
• 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
OIDCClientInformation(ClientID id, URL registrationURI, BearerAccessToken accessToken, ClientMetadata metadata, Secret secret, Date issueDate) Creates a new OpenID Connect client information instance.

Method Summary

Methods

Modifier and Type	Method and Description
OIDCClientMetadata	getOIDCClientMetadata() Gets the OpenID Connect client metadata.
static Set<String>	getRegisteredParameterNames() Gets the registered client metadata parameter names.
static OIDCClientInformation	parse(net.minidev.json.JSONObject jsonObject) Parses an OpenID Connect client information instance from the specified JSON object.

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

getClientMetadata, getID, getIssueDate, getRegistrationAccessToken, getRegistrationURI, getSecret, toJSONObject

Methods inherited from class java.lang.Object

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

Constructor Detail

OIDCClientInformation

public OIDCClientInformation(ClientID id,
                     URL registrationURI,
                     BearerAccessToken accessToken,
                     ClientMetadata metadata,
                     Secret secret,
                     Date issueDate)

Creates a new OpenID Connect 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.

getOIDCClientMetadata

public OIDCClientMetadata getOIDCClientMetadata()

Gets the OpenID Connect client metadata.

Returns:

The OpenID Connect client metadata.

parse

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

Parses an OpenID Connect 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 an OpenID Connect client information instance.