com.nimbusds.oauth2.sdk.id

Class ClientID

java.lang.Object

com.nimbusds.oauth2.sdk.id.Identifier

com.nimbusds.oauth2.sdk.id.ClientID

All Implemented Interfaces:

Comparable<Identifier>, net.minidev.json.JSONAware

@Immutable
public final class ClientID
extends Identifier

Client identifier.

Example of a client identifier created from string:

 ClientID clientID = new ClientID("client-12345678");
 

Related specifications:

• OAuth 2.0 (RFC 6749), section 2.2.

Field Summary

Fields inherited from class com.nimbusds.oauth2.sdk.id.Identifier

DEFAULT_BYTE_LENGTH

Constructor Summary

Constructors

Constructor and Description
ClientID() Creates a new client identifier with a randomly generated 256-bit (32-byte) value, Base64URL-encoded.
ClientID(int byteLength) Creates a new client identifier with a randomly generated value of the specified byte length, Base64URL-encoded.
ClientID(String value) Creates a new client identifier with the specified value.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object object) Overrides Object.equals().

Methods inherited from class com.nimbusds.oauth2.sdk.id.Identifier

compareTo, getValue, hashCode, toJSONString, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ClientID

public ClientID(String value)

Creates a new client identifier with the specified value.

Parameters:

value - The client identifier value. Must not be null or empty string.

ClientID

public ClientID(int byteLength)

Creates a new client identifier with a randomly generated value of the specified byte length, Base64URL-encoded.

Parameters:

byteLength - The byte length of the value to generate. Must be greater than one.

ClientID

public ClientID()

Creates a new client identifier with a randomly generated 256-bit (32-byte) value, Base64URL-encoded.

Method Detail

equals

public boolean equals(Object object)

Description copied from class: Identifier

Overrides Object.equals().

Specified by:

equals in class Identifier

Parameters:

object - The object to compare to.

Returns:

true if the objects have the same value, otherwise false.