com.google.api.ads.common.lib.factory.helper

Interface AdsServiceClientFactoryHelper<C extends AdsServiceClient<S,D>,S extends AdsSession,D extends AdsServiceDescriptor>

Type Parameters:

C - the subclass of AdsServiceClient

S - the subclass of AdsSession

D - the subclass of AdsServiceDescriptor

All Known Implementing Classes:

AdWordsServiceClientFactoryHelper, BaseAdsServiceClientFactoryHelper, DfpServiceClientFactoryHelper

public interface AdsServiceClientFactoryHelper<C extends AdsServiceClient<S,D>,S extends AdsSession,D extends AdsServiceDescriptor>

Interface for helpers of factories which creates ads service clients.

Method Summary

Modifier and Type	Method and Description
void	checkServiceClientPreconditions(S adsSession, Class<?> interfaceClass) Checks preconditions of the session and interface and throws an exception if the client cannot be generated.
C	createAdsServiceClient(D adsServiceDescriptor, S adsSession) Creates an AdsServiceClient for the descriptor, session, and endpoint.
D	createServiceDescriptor(Class<?> interfaceClass, String version) Creates an AdsServiceDescriptor for a specified service.
String	determineVersion(Class<?> interfaceClass) Determines what API version an ads service belongs to.

Method Detail

createServiceDescriptor

D createServiceDescriptor(Class<?> interfaceClass,
                          String version)

Creates an AdsServiceDescriptor for a specified service.

Parameters:

interfaceClass - the ads service that we want a descriptor for

version - of the service

Returns:

a descriptor of the requested service

createAdsServiceClient

C createAdsServiceClient(D adsServiceDescriptor,
                         S adsSession)
                  throws ServiceException

Creates an AdsServiceClient for the descriptor, session, and endpoint.

Parameters:

adsServiceDescriptor - the ads service descriptor

adsSession - the session

Returns:

the service client

Throws:

ServiceException - if there was a problem creating the client

determineVersion

String determineVersion(Class<?> interfaceClass)

Determines what API version an ads service belongs to.

Parameters:

interfaceClass - the interface class of the service

Returns:

a string representation of the version of this service

checkServiceClientPreconditions

void checkServiceClientPreconditions(S adsSession,
                                     Class<?> interfaceClass)
                              throws ServiceException

Checks preconditions of the session and interface and throws an exception if the client cannot be generated.

Parameters:

adsSession - the session containing the authentication method

interfaceClass - the ads service that a client is being generated for

Throws:

ServiceException - if the preconditions are not met for service client creation