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

Class BaseAdsServiceClientFactoryHelper<C extends AdsServiceClient<S,D>,S extends AdsSession,D extends AdsServiceDescriptor>

java.lang.Object

com.google.api.ads.common.lib.factory.helper.BaseAdsServiceClientFactoryHelper<C,S,D>

Type Parameters:

C - the type of AdsServiceClient

S - the type of AdsSession

D - the type of AdsServiceDescriptor

All Implemented Interfaces:

AdsServiceClientFactoryHelper<C,S,D>

Direct Known Subclasses:

AdWordsServiceClientFactoryHelper, DfpServiceClientFactoryHelper

public abstract class BaseAdsServiceClientFactoryHelper<C extends AdsServiceClient<S,D>,S extends AdsSession,D extends AdsServiceDescriptor>
extends Object
implements AdsServiceClientFactoryHelper<C,S,D>

Abstract helper for AdsServiceClientFactoryHelper.

Constructor Summary

Constructors

Constructor and Description
BaseAdsServiceClientFactoryHelper(FactoryModule.AdsServiceClientFactoryInterface<C,S,D> adsServiceClientFactory, FactoryModule.AdsServiceDescriptorFactoryInterface<D> adsServiceDescriptorFactory, SoapClientHandlerInterface<?> soapClientHandler) Constructor.

Method Summary

Modifier and Type	Method and Description
void	checkServiceClientPreconditions(S adsSession, Class<?> interfaceClass) Default implementation of passing service client preconditions.
C	createAdsServiceClient(D adsServiceDescriptor, S adsSession) Creates an AdsServiceClient given an AdsServiceDescriptor descriptor and an AdsSession.
D	createServiceDescriptor(Class<?> interfaceClass, String version) Creates an AdsServiceDescriptor for a specified service.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.api.ads.common.lib.factory.helper.AdsServiceClientFactoryHelper

determineVersion

Constructor Detail

BaseAdsServiceClientFactoryHelper

public BaseAdsServiceClientFactoryHelper(FactoryModule.AdsServiceClientFactoryInterface<C,S,D> adsServiceClientFactory,
                                         FactoryModule.AdsServiceDescriptorFactoryInterface<D> adsServiceDescriptorFactory,
                                         SoapClientHandlerInterface<?> soapClientHandler)

Constructor.

Parameters:

adsServiceClientFactory - the Guice service client factory.

Method Detail

createAdsServiceClient

public C createAdsServiceClient(D adsServiceDescriptor,
                                S adsSession)
                         throws ServiceException

Creates an AdsServiceClient given an AdsServiceDescriptor descriptor and an AdsSession.

Specified by:

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

Parameters:

adsServiceDescriptor - descriptor with information on ads service

adsSession - the session associated with the desired client

Returns:

the created AdsServiceClient

Throws:

ServiceException - if the ads service client could not be created

createServiceDescriptor

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

Creates an AdsServiceDescriptor for a specified service.

Specified by:

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

Parameters:

interfaceClass - the ads service that we want a descriptor for

version - the version of the service

Returns:

a descriptor of the requested service

checkServiceClientPreconditions

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

Default implementation of passing service client preconditions.

Specified by:

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

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