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 OpenID Connect metadata.
- The optional client secret for a confidential client.
- The optional registration URI and access token if dynamic client registration is permitted.
Related specifications:
- OpenID Connect Dynamic Client Registration 1.0.
- OAuth 2.0 Dynamic Client Registration Protocol (RFC 7591), section 3.2.1.
- OAuth 2.0 Dynamic Client Registration Management Protocol (RFC 7592), section 3.
-
-
Constructor Summary
Constructors Constructor Description OIDCClientInformation(ClientID id, OIDCClientMetadata metadata)
Creates a new minimal OpenID Connect client information instance without a client secret.OIDCClientInformation(ClientID id, Date issueDate, OIDCClientMetadata metadata, Secret secret)
Creates a new OpenID Connect client information instance.OIDCClientInformation(ClientID id, Date issueDate, OIDCClientMetadata metadata, Secret secret, URI registrationURI, BearerAccessToken accessToken)
Creates a new OpenID Connect client information instance permitting dynamic client registration management.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description OIDCClientMetadata
getOIDCMetadata()
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
getID, getIDIssueDate, getMetadata, getRegistrationAccessToken, getRegistrationURI, getSecret, inferClientType, toJSONObject
-
-
-
-
Constructor Detail
-
OIDCClientInformation
public OIDCClientInformation(ClientID id, OIDCClientMetadata metadata)
Creates a new minimal OpenID Connect client information instance without a client secret.- Parameters:
id
- The client identifier. Must not benull
.metadata
- The OpenID Connect client metadata. Must not benull
.
-
OIDCClientInformation
public OIDCClientInformation(ClientID id, Date issueDate, OIDCClientMetadata metadata, Secret secret)
Creates a new OpenID Connect client information instance.- Parameters:
id
- The client identifier. Must not benull
.issueDate
- The issue date of the client identifier,null
if not specified.metadata
- The OpenID Connect client metadata. Must not benull
.secret
- The optional client secret,null
if not specified.
-
OIDCClientInformation
public OIDCClientInformation(ClientID id, Date issueDate, OIDCClientMetadata metadata, Secret secret, URI registrationURI, BearerAccessToken accessToken)
Creates a new OpenID Connect client information instance permitting dynamic client registration management.- Parameters:
id
- The client identifier. Must not benull
.issueDate
- The issue date of the client identifier,null
if not specified.metadata
- The OpenID Connect client metadata. Must not benull
.secret
- The optional client secret,null
if not specified.registrationURI
- The client registration URI,null
if not specified.accessToken
- The client registration access token,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.
-
getOIDCMetadata
public OIDCClientMetadata getOIDCMetadata()
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 benull
.- Returns:
- The client information.
- Throws:
ParseException
- If the JSON object couldn't be parsed to an OpenID Connect client information instance.
-
-