com.google.api.ads.dfa.axis.utils

Class DfaAxisLoginTokensHelper

java.lang.Object

com.google.api.ads.dfa.axis.utils.DfaAxisLoginTokensHelper

All Implemented Interfaces:

LoginTokensHelper

public class DfaAxisLoginTokensHelper
extends Object
implements LoginTokensHelper

Implementation of LoginTokensHelper for Axis.

Author:

Adam Rogal

Constructor Summary

Constructors

Constructor and Description
DfaAxisLoginTokensHelper(DfaServiceClientFactory dfaServiceClientFactory) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Object	authenticate(String username, String password, Class<?> loginClass, Object loginService) Authenticates against the DFA API.
Class<?>	getLoginClass(String stubPackage) Retrieves the Class object representing the login service.
Object	getLoginService(DfaSession session, Class<?> loginClass) Returns a DfaServiceClient wrapping the login service.
Class<?>	getUserProfileClass(String stubPackage) Retrieves the Class object representing user profiles.
String	retrieveToken(Object userProfile) Retrieves the user's authentication token from the UserProfile returned by the DFA API.

Methods inherited from class java.lang.Object

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

Constructor Detail

DfaAxisLoginTokensHelper

@Inject
public DfaAxisLoginTokensHelper(DfaServiceClientFactory dfaServiceClientFactory)

Constructor.

Parameters:

dfaServiceClientFactory - the DFA service client factory

Method Detail

getLoginClass

public Class<?> getLoginClass(String stubPackage)
                       throws ClassNotFoundException

Retrieves the Class object representing the login service.

Specified by:

getLoginClass in interface LoginTokensHelper

Parameters:

stubPackage - the package where all generated stubs are located

Returns:

the Class object representing the login service

Throws:

ClassNotFoundException - if the class cannot be resolved

getUserProfileClass

public Class<?> getUserProfileClass(String stubPackage)
                             throws ClassNotFoundException

Retrieves the Class object representing user profiles.

Specified by:

getUserProfileClass in interface LoginTokensHelper

Parameters:

stubPackage - the package where all generated stubs are located

Returns:

the Class object representing user profiles

Throws:

ClassNotFoundException - if the class cannot be resolved

getLoginService

public Object getLoginService(DfaSession session,
                     Class<?> loginClass)

Returns a DfaServiceClient wrapping the login service.

Specified by:

getLoginService in interface LoginTokensHelper

Parameters:

session - the DFA session

loginClass - the Class type of the login service

Returns:

a client pointing to the login service

authenticate

public Object authenticate(String username,
                  String password,
                  Class<?> loginClass,
                  Object loginService)
                    throws IllegalArgumentException,
                           IllegalAccessException,
                           InvocationTargetException,
                           NoSuchMethodException

Authenticates against the DFA API.

Specified by:

authenticate in interface LoginTokensHelper

Parameters:

username - the username

password - the password

loginClass - the Class type of the login service

loginService - a service client object wrapping the login service

Returns:

the UserProfile response from the API

Throws:

IllegalArgumentException - if one of the arguments used in authenticating is not allowed

IllegalAccessException - if the authenticate method cannot be accessed

InvocationTargetException - if an error occurs while invoking the authenticate method

NoSuchMethodException - if the authenticate method cannot be located

retrieveToken

public String retrieveToken(Object userProfile)
                     throws ClassNotFoundException,
                            InvocationTargetException,
                            NoSuchMethodException,
                            IllegalAccessException

Retrieves the user's authentication token from the UserProfile returned by the DFA API.

Specified by:

retrieveToken in interface LoginTokensHelper

Parameters:

userProfile - the UserProfile object returned by the API

Returns:

the users authentication token

Throws:

ClassNotFoundException - if the UserProfile class cannot be located

InvocationTargetException - if an error occurs while invoking getToken on the given object

NoSuchMethodException - if the getToken method cannot be found.

IllegalAccessException - if the getToken method cannot be accessed.