com.google.api.ads.dfa.lib.client

Class DfaSession

java.lang.Object

com.google.api.ads.dfa.lib.client.DfaSession

All Implemented Interfaces:

OAuth2Compatible, AdsSession

public class DfaSession
extends Object
implements AdsSession, OAuth2Compatible

A DfaSession represents a single session of DFA use.

Implementation is not thread-safe.

Author:

Adam Rogal

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DfaSession.Builder Builder for DfaSession.
static class	DfaSession.Environment Enum representing the endpoint server, aka environment.

Method Summary

Methods

Modifier and Type	Method and Description
String	getApplicationName() Gets the application name.
String	getEndpoint() Returns the server endpoint to make requests against.
com.google.api.client.auth.oauth2.Credential	getOAuth2Credential() Gets the OAuth2 credentials.
String	getPassword() Gets the password.
String	getToken() Gets the token used for authentication.
String	getUsername() Gets the user name.
boolean	isEnvironment(Endpoint environment) Determines if the session is for the supplied DfaSession.Environment.
void	setToken(String token) Sets the token associated with this session.

Methods inherited from class java.lang.Object

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

Method Detail

setToken

public void setToken(String token)

Sets the token associated with this session.

getUsername

public String getUsername()

Gets the user name.

getPassword

public String getPassword()

Gets the password.

getToken

public String getToken()

Gets the token used for authentication.

getApplicationName

public String getApplicationName()

Gets the application name.

getEndpoint

public String getEndpoint()

Description copied from interface: AdsSession

Returns the server endpoint to make requests against.

Specified by:

getEndpoint in interface AdsSession

Returns:

the endpoint

isEnvironment

public boolean isEnvironment(Endpoint environment)

Determines if the session is for the supplied DfaSession.Environment.

Specified by:

isEnvironment in interface AdsSession

Parameters:

environment - the environment to check

getOAuth2Credential

public com.google.api.client.auth.oauth2.Credential getOAuth2Credential()

Gets the OAuth2 credentials.

Specified by:

getOAuth2Credential in interface OAuth2Compatible