Class ClientId (1.3.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

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
Name Description
json Map<String,Object>

the JSON from the downloaded file
Returns
Type Description
ClientId

the ClientId instance based on the JSON
Exceptions
Type Description
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
Name Description
relativeClass Class<?>

a class in the same namespace as the resource
resourceName String

the name of the resource
Returns
Type Description
ClientId

the constructed ClientID instance based on the JSON in the resource
Exceptions
Type Description
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
Name Description
stream InputStream

the downloaded JSON file
Returns
Type Description
ClientId

the constructed ClientID instance based on the JSON in the stream
Exceptions
Type Description
IOException

the JSON could not be read or parsed

getClientId()

public final String getClientId()

Returns the text identifier of the Client ID.

Returns
Type Description
String

The text identifier of the Client ID.

getClientSecret()

public final String getClientSecret()

Returns the secret associated with the Client ID.

Returns
Type Description
String

The secret associated with the Client ID.

newBuilder()

public static ClientId.Builder newBuilder()
Returns
Type Description
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
Name Description
clientId String

Text identifier of the Client ID.
clientSecret String

Secret to associated with the Client ID.
Returns
Type Description
ClientId

The ClientId instance.

toBuilder()

public ClientId.Builder toBuilder()
Returns
Type Description
ClientId.Builder