org.mule.devkit.oauth.generation.manager

Class AbstractOAuthManagerGenerator

java.lang.Object

org.mule.devkit.oauth.generation.AbstractOAuthAdapterGenerator

org.mule.devkit.oauth.generation.manager.AbstractOAuthManagerGenerator

All Implemented Interfaces:

Generator, ModuleGenerator

Direct Known Subclasses:

AbstractOAuth2ManagerGenerator, OAuth1ManagerGenerator

public abstract class AbstractOAuthManagerGenerator
extends AbstractOAuthAdapterGenerator
implements ModuleGenerator

Abstract generator that specifies the template of the generated managers for a given connector (which could be OAuth1/OAuth2)

Field Summary

Fields inherited from class org.mule.devkit.oauth.generation.AbstractOAuthAdapterGenerator

ACCESS_CODE_PATTERN_FIELD_NAME, AUTH_CODE_PATTERN_FIELD_NAME, AUTHORIZE_METHOD_NAME, CONSUMER_FIELD_NAME, context, ENCODING, EXPIRATION_FIELD_NAME, EXPIRATION_TIME_PATTERN_FIELD_NAME, FETCH_ACCESS_TOKEN_METHOD_NAME, GRANT_TYPE, HAS_TOKEN_EXPIRED_METHOD_NAME, MULE_CONTEXT_FIELD_NAME, OAUTH_RESTORE_ACCESS_TOKEN_CALLBACK_FIELD_NAME, OAUTH_SAVE_ACCESS_TOKEN_CALLBACK_FIELD_NAME, OAUTH_VERIFIER_FIELD_NAME, ON_NO_TOKEN_POLICY_FIELD_NAME, REFRESH_TOKEN_FIELD_NAME, REFRESH_TOKEN_PATTERN_FIELD_NAME, REQUEST_TOKEN_FIELD_NAME, REQUEST_TOKEN_SECRET_FIELD_NAME, RESET_METHOD_NAME, VERIFIER_FIELD_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractOAuthManagerGenerator()

Method Summary

Modifier and Type	Method and Description
protected void	callGenerator(org.mule.devkit.model.module.Module module, AbstractOAuthAdapterGenerator oauthAdapterGenerator) Generation of the adapter, code lives here to reduce the dependency between generators (Adapter vs Manager..).
List<Product>	consumes()
protected abstract void	doGenerate(org.mule.devkit.model.module.Module module, org.mule.devkit.model.code.GeneratedClass oAuthManagerClass) Hook method to implement the custom core behaviour of the manager anything the concrete object to generate the adapter (either for OAuth1 or OAuth2)
void	generate(org.mule.devkit.model.module.Module module) Template method that subclasses must not override
protected void	generateLoggerMethod(org.mule.devkit.model.code.GeneratedClass oauthManagerClass) Implementation in the generated manager class to fulfill the contract within BaseOAuth2Manager.getLogger() if using OAuth2, or BaseOAuth1Manager.getLogger() if using OAuth
protected abstract AbstractOAuthAdapterGenerator	getAdapterGenerator() Returns the concrete object to generate the adapter (either for OAuth1 or OAuth2) TODO: It must be refactored to avoid calling a generator from another generator, but this will imply adding more dependencies in the CONSUMES/PRODUCES mechanism
protected abstract org.mule.devkit.model.code.TypeReference	getExtendManagerClass() Returns the concrete class to be used a superclass of the generated Manager (either for OAuth1 or OAuth2)
List<Product>	produces()

Methods inherited from class org.mule.devkit.oauth.generation.AbstractOAuthAdapterGenerator

authorizationCodeField, ctx, generateAccessTokenUrlField, generateAuthorizationUrlField, generateCatchAndReThrow, generateCatchAndReThrow, generateHasBeenAuthorizedMethod, generateInitialiseMethod, generateLoggerField, generateOAuth1AuthorizeMethod, generateOAuth2AuthorizeMethod, generateOnNoTokenPolicyField, generateRequestTokenUrlField, getOAuthAdapterClass, ref, ref, ref, ref, restoreAccessTokenCallbackField, saveAccessTokenCallbackField, setCtx

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.devkit.generation.api.ModuleGenerator

shouldGenerate

Methods inherited from interface org.mule.devkit.generation.api.Generator

ctx, setCtx

Constructor Detail

AbstractOAuthManagerGenerator

public AbstractOAuthManagerGenerator()

Method Detail

consumes

public List<Product> consumes()

Specified by:

consumes in interface Generator

Overrides:

consumes in class AbstractOAuthAdapterGenerator

produces

public List<Product> produces()

Specified by:

produces in interface Generator

Overrides:

produces in class AbstractOAuthAdapterGenerator

generate

public void generate(org.mule.devkit.model.module.Module module)
              throws GenerationException

Template method that subclasses must not override

Specified by:

generate in interface ModuleGenerator

Parameters:

module -

Throws:

GenerationException

getExtendManagerClass

protected abstract org.mule.devkit.model.code.TypeReference getExtendManagerClass()

Returns the concrete class to be used a superclass of the generated Manager (either for OAuth1 or OAuth2)

Returns:

getAdapterGenerator

protected abstract AbstractOAuthAdapterGenerator getAdapterGenerator()

Returns the concrete object to generate the adapter (either for OAuth1 or OAuth2) TODO: It must be refactored to avoid calling a generator from another generator, but this will imply adding more dependencies in the CONSUMES/PRODUCES mechanism

Returns:

doGenerate

protected abstract void doGenerate(org.mule.devkit.model.module.Module module,
                                   org.mule.devkit.model.code.GeneratedClass oAuthManagerClass)
                            throws GenerationException

Hook method to implement the custom core behaviour of the manager anything the concrete object to generate the adapter (either for OAuth1 or OAuth2)

Parameters:

module -

oAuthManagerClass -

Throws:

GenerationException

callGenerator

protected void callGenerator(org.mule.devkit.model.module.Module module,
                             AbstractOAuthAdapterGenerator oauthAdapterGenerator)
                      throws GenerationException

Generation of the adapter, code lives here to reduce the dependency between generators (Adapter vs Manager..). TODO: It must be refactored to avoid calling a generator from another generator, but this will imply adding more dependencies in the CONSUMES/PRODUCES mechanism

Parameters:

module -

oauthAdapterGenerator -

Throws:

GenerationException

generateLoggerMethod

protected void generateLoggerMethod(org.mule.devkit.model.code.GeneratedClass oauthManagerClass)

Implementation in the generated manager class to fulfill the contract within BaseOAuth2Manager.getLogger() if using OAuth2, or BaseOAuth1Manager.getLogger() if using OAuth

Parameters:

oauthManagerClass - generated subclass of BaseOAuth2Manager or BaseOAuth1Manager