org.mule.devkit.oauth.generation.manager

Class AbstractOAuth2ManagerGenerator

java.lang.Object

org.mule.devkit.oauth.generation.AbstractOAuthAdapterGenerator

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

org.mule.devkit.oauth.generation.manager.AbstractOAuth2ManagerGenerator

All Implemented Interfaces:

Generator, ModuleGenerator

Direct Known Subclasses:

OAuth2ManagerComponentGenerator, OAuth2ManagerModuleGenerator

public abstract class AbstractOAuth2ManagerGenerator
extends AbstractOAuthManagerGenerator

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
AbstractOAuth2ManagerGenerator()

Method Summary

Methods

Modifier and Type	Method and Description
void	doGenerate(Module module, 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)
protected 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 List<Field>	getConfigurableFields(Module module) Returns the list of configurable fields that the generated manager must wrap when being filled from the definition parser.
protected TypeReference	getExtendManagerClass() Returns the concrete class to be used a superclass of the generated Manager (either for OAuth1 or OAuth2)
protected abstract OAuthCapability	getOAuthCapability(Module module) Given a module, returns the concrete object that represents the OAuth2 annotation
protected OAuthClientFactoryGenerator	getOAuthFactoryGenerator() Returns a factory generator to fulfil the BaseOAuthClientFactory extends contract
protected abstract GeneratedExpression	wrapAccessorConnector(Module module, Field field, GeneratedExpression connector) Wraps the connector to the custom strategy if applies.

Methods inherited from class org.mule.devkit.oauth.generation.manager.AbstractOAuthManagerGenerator

callGenerator, consumes, generate, generateLoggerMethod, produces

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

authorizationCodeField, ctx, generateAccessTokenUrlField, generateAuthorizationUrlField, generateCatchAndReThrow, generateCatchAndReThrow, generateCreateConsumerMethod, generateFieldForBoolean, generateFieldForMessageProcessor, generateFieldForString, generateHasBeenAuthorizedMethod, generateInitialiseMethod, generateLoggerField, generateOAuth1AuthorizeMethod, generateOAuth2AuthorizeMethod, generateOnNoTokenPolicyField, generateProvider, generateRequestTokenUrlField, getOAuthAdapterClass, getterMethodForFieldAnnotatedWith, muleContextField, 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

AbstractOAuth2ManagerGenerator

public AbstractOAuth2ManagerGenerator()

Method Detail

getExtendManagerClass

protected TypeReference getExtendManagerClass()

Description copied from class: AbstractOAuthManagerGenerator

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

Specified by:

getExtendManagerClass in class AbstractOAuthManagerGenerator

Returns:

getAdapterGenerator

protected AbstractOAuthAdapterGenerator getAdapterGenerator()

Description copied from class: AbstractOAuthManagerGenerator

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

Specified by:

getAdapterGenerator in class AbstractOAuthManagerGenerator

Returns:

doGenerate

public void doGenerate(Module module,
              GeneratedClass oAuthManagerClass)
                throws GenerationException

Description copied from class: AbstractOAuthManagerGenerator

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

Specified by:

doGenerate in class AbstractOAuthManagerGenerator

Throws:

GenerationException

getOAuthCapability

protected abstract OAuthCapability getOAuthCapability(Module module)

Given a module, returns the concrete object that represents the OAuth2 annotation

wrapAccessorConnector

protected abstract GeneratedExpression wrapAccessorConnector(Module module,
                                        Field field,
                                        GeneratedExpression connector)

Wraps the connector to the custom strategy if applies. If not, it will return the same object instance

Parameters:

module -

field -

connector -

Returns:

getConfigurableFields

protected abstract List<Field> getConfigurableFields(Module module)

Returns the list of configurable fields that the generated manager must wrap when being filled from the definition parser. Some of this fields might be just for the connector, whereas others might be also used for the OAuth2 dance (consumer key, consumer secret or the scope). If that's the case, then, those configurables are going to be treated differently

Parameters:

module -

Returns:

getOAuthFactoryGenerator

protected OAuthClientFactoryGenerator getOAuthFactoryGenerator()

Returns a factory generator to fulfil the BaseOAuthClientFactory extends contract