com.google.api.ads.common.lib.auth

Class GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder

java.lang.Object

com.google.api.ads.common.lib.auth.GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder

All Implemented Interfaces:

Builder<com.google.api.client.googleapis.auth.oauth2.GoogleClientSecrets>

Enclosing class:

GoogleClientSecretsBuilder

public static class GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder
extends Object
implements Builder<com.google.api.client.googleapis.auth.oauth2.GoogleClientSecrets>

Builder for GoogleClientSecrets.

Field Summary

Fields inherited from interface com.google.api.ads.common.lib.utils.Builder

DEFAULT_CONFIGURATION_FILENAME

Method Summary

Modifier and Type	Method and Description
com.google.api.client.googleapis.auth.oauth2.GoogleClientSecrets	build() Constructs this object.
GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder	from(org.apache.commons.configuration.Configuration config) Reads properties from the provided Configuration object Understands the following properties suffixes: clientId clientSecret For example, the AdWords OAuth2 client ID can be read from: api.adwords.clientId
GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder	fromFile() Loads credentials from the "ads.properties" file in one of the following locations according to the following order: in the current directory, in the user home directory, in the classpath
GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder	fromFile(File path) Populates this builder from a properties file from a specified path.
GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder	fromFile(String path) Populates this builder from a properties file from a specified path.
GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder	fromFile(URL path) Populates this builder from a properties file from a specified path.
GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder	withClientSecrets(String clientId, String clientSecret) Sets the client ID & secret to create the OAuth2 Credential with.

Methods inherited from class java.lang.Object

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

Method Detail

withClientSecrets

public GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder withClientSecrets(String clientId,
                                                                                     String clientSecret)

Sets the client ID & secret to create the OAuth2 Credential with. If you do not have a client ID or secret, please create one in the API console: https://console.developers.google.com

build

public com.google.api.client.googleapis.auth.oauth2.GoogleClientSecrets build()
                                                                       throws ValidationException

Description copied from interface: Builder

Constructs this object.

Specified by:

build in interface Builder<com.google.api.client.googleapis.auth.oauth2.GoogleClientSecrets>

Throws:

ValidationException - if the provided data is not valid.

from

public GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder from(org.apache.commons.configuration.Configuration config)

Reads properties from the provided Configuration object

Understands the following properties suffixes:

• clientId
• clientSecret

For example, the AdWords OAuth2 client ID can be read from: api.adwords.clientId

Specified by:

from in interface Builder<com.google.api.client.googleapis.auth.oauth2.GoogleClientSecrets>

Parameters:

config - the configuration

Returns:

Builder populated from the Configuration

fromFile

public GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder fromFile(String path)
                                                                     throws com.google.api.ads.common.lib.conf.ConfigurationLoadException

Description copied from interface: Builder

Populates this builder from a properties file from a specified path. If not absolute, will look in user home directory, the current classpath and the system classpath.

Specified by:

fromFile in interface Builder<com.google.api.client.googleapis.auth.oauth2.GoogleClientSecrets>

Parameters:

path - the path to try first as a resource, then as a file

Returns:

Builder populated with properties.

Throws:

com.google.api.ads.common.lib.conf.ConfigurationLoadException - if the configuration could not be loaded.

fromFile

public GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder fromFile(File path)
                                                                     throws com.google.api.ads.common.lib.conf.ConfigurationLoadException

Description copied from interface: Builder

Populates this builder from a properties file from a specified path.

Specified by:

fromFile in interface Builder<com.google.api.client.googleapis.auth.oauth2.GoogleClientSecrets>

Parameters:

path - the path to load properties from

Returns:

Builder populated with properties.

Throws:

com.google.api.ads.common.lib.conf.ConfigurationLoadException - if the configuration could not be loaded.

fromFile

public GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder fromFile(URL path)
                                                                     throws com.google.api.ads.common.lib.conf.ConfigurationLoadException

Description copied from interface: Builder

Populates this builder from a properties file from a specified path. If not absolute, will look in user home directory, the current classpath and the system classpath.

Specified by:

fromFile in interface Builder<com.google.api.client.googleapis.auth.oauth2.GoogleClientSecrets>

Parameters:

path - the path to try first as a resource, then as a file

Returns:

Builder populated with properties.

Throws:

com.google.api.ads.common.lib.conf.ConfigurationLoadException - if the configuration could not be loaded.

fromFile

public GoogleClientSecretsBuilder.GoogleClientSecretsForApiBuilder fromFile()
                                                                     throws com.google.api.ads.common.lib.conf.ConfigurationLoadException

Description copied from interface: Builder

Loads credentials from the "ads.properties" file in one of the following locations according to the following order: in the current directory, in the user home directory, in the classpath

Specified by:

fromFile in interface Builder<com.google.api.client.googleapis.auth.oauth2.GoogleClientSecrets>

Throws:

com.google.api.ads.common.lib.conf.ConfigurationLoadException - if the configuration could not be loaded.