Class ClientId (1.18.0)

public class ClientId

An OAuth2 user authorization Client ID and associated information.

Corresponds to the information in the json file downloadable for a Client ID.

Inheritance

java.lang.Object > ClientId

Static Methods

fromJson(Map<String,Object> json)

public static ClientId fromJson(Map<String,Object> json)

Constructs a Client ID from JSON from a downloaded file.

Parameter
NameDescription
jsonMap<String,Object>

the JSON from the downloaded file

Returns
TypeDescription
ClientId

the ClientId instance based on the JSON

Exceptions
TypeDescription
IOException

the JSON could not be parsed

fromResource(Class<?> relativeClass, String resourceName)

public static ClientId fromResource(Class<?> relativeClass, String resourceName)

Constructs a Client ID from JSON file stored as a resource.

Parameters
NameDescription
relativeClassClass<?>

a class in the same namespace as the resource

resourceNameString

the name of the resource

Returns
TypeDescription
ClientId

the constructed ClientID instance based on the JSON in the resource

Exceptions
TypeDescription
IOException

The JSON could not be loaded or parsed.

fromStream(InputStream stream)

public static ClientId fromStream(InputStream stream)

Constructs a Client ID from JSON file stream.

Parameter
NameDescription
streamInputStream

the downloaded JSON file

Returns
TypeDescription
ClientId

the constructed ClientID instance based on the JSON in the stream

Exceptions
TypeDescription
IOException

the JSON could not be read or parsed

newBuilder()

public static ClientId.Builder newBuilder()
Returns
TypeDescription
ClientId.Builder

of(String clientId, String clientSecret)

public static ClientId of(String clientId, String clientSecret)

Constructs a client ID from an explicit ID and secret.

Note: Direct use of this factory method in application code is not recommended to avoid having secrets or values that need to be updated in source code.

Parameters
NameDescription
clientIdString

Text identifier of the Client ID.

clientSecretString

Secret to associated with the Client ID.

Returns
TypeDescription
ClientId

The ClientId instance.

Methods

getClientId()

public final String getClientId()

Returns the text identifier of the Client ID.

Returns
TypeDescription
String

The text identifier of the Client ID.

getClientSecret()

public final String getClientSecret()

Returns the secret associated with the Client ID.

Returns
TypeDescription
String

The secret associated with the Client ID.

toBuilder()

public ClientId.Builder toBuilder()
Returns
TypeDescription
ClientId.Builder