com.google.auth.oauth2

Class ClientId

java.lang.Object

com.google.auth.oauth2.ClientId

public class ClientId
extends Object

An OAuth2 user authorization Client ID and associated information.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClientId.Builder

Constructor Summary

Constructors

Constructor and Description
ClientId(String clientId, String clientSecret) Deprecated. Use of(String, String) instead. This constructor will either be deleted or made private in a later version.

Method Summary

Modifier and Type	Method and Description
static ClientId	fromJson(Map<String,Object> json) Constructs a Client ID from JSON from a downloaded file.
static ClientId	fromResource(Class<?> relativeClass, String resourceName) Constructs a Client ID from JSON file stored as a resource.
static ClientId	fromStream(InputStream stream) Constructs a Client ID from JSON file stream.
String	getClientId() Returns the text identifier of the Client ID.
String	getClientSecret() Returns the secret associated with the Client ID.
static ClientId.Builder	newBuilder()
static ClientId	of(String clientId, String clientSecret) Constructs a client ID from an explicit ID and secret.
ClientId.Builder	toBuilder()

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientId

@Deprecated
public ClientId(String clientId,
                            String clientSecret)

Deprecated. Use of(String, String) instead. This constructor will either be deleted or made private in a later version.

Constructs a client ID using an explicit ID and secret

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

Parameters:

clientId - Text identifier of the Client ID.

clientSecret - Secret to associated with the Client ID.

Method Detail

of

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:

clientId - Text identifier of the Client ID.

clientSecret - Secret to associated with the Client ID.

fromJson

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

Constructs a Client ID from JSON from a downloaded file.

Parameters:

json - The JSON from the downloaded file.

Returns:

the ClientId instance based on the JSON.

Throws:

IOException - The JSON could not be parsed.

fromResource

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

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

Parameters:

relativeClass - A class in the same namespace as the resource.

resourceName - The name of the resource

Returns:

The constructed ClientID instance based on the JSON in the resource.

Throws:

IOException - The JSON could not be loaded or parsed.

fromStream

public static ClientId fromStream(InputStream stream)
                           throws IOException

Constructs a Client ID from JSON file stream.

Parameters:

stream - Stream of the downloaded JSON file.

Returns:

The constructed ClientID instance based on the JSON in the stream.

Throws:

IOException - The JSON could not be read or parsed.

getClientId

public final String getClientId()

Returns the text identifier of the Client ID.

getClientSecret

public final String getClientSecret()

Returns the secret associated with the Client ID.

newBuilder

public static ClientId.Builder newBuilder()

toBuilder

public ClientId.Builder toBuilder()