org.mule.devkit.apt.model.module.oauth

Class AnnotationProcessorOAuthModule

java.lang.Object

org.mule.devkit.apt.model.AnnotationProcessorIdentifiable<TypeElement>

org.mule.devkit.apt.model.AnnotationProcessorType

org.mule.devkit.apt.model.AnnotationProcessorClass

org.mule.devkit.apt.model.module.AnnotationProcessorModule

org.mule.devkit.apt.model.module.rest.AnnotationProcessorRestModule

org.mule.devkit.apt.model.module.oauth.AnnotationProcessorOAuthModule

All Implemented Interfaces:

Accessible, Annotable, ClassType, Documentable, Generifiable, Identifiable<TypeElement>, Module, OAuthCapability, OAuthModule, RestModule, Type, Typeable

Direct Known Subclasses:

OAuth2

public class AnnotationProcessorOAuthModule
extends AnnotationProcessorRestModule
implements OAuthModule

Field Summary

Fields inherited from class org.mule.devkit.apt.model.AnnotationProcessorIdentifiable

components, elements, innerElement, types

Constructor Summary

Constructors

Constructor and Description
AnnotationProcessorOAuthModule(TypeElement innerElement, Types types, Elements elements, List<Component> components)

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(ModelVisitor visitor) As this type of object could contain a connector with different connection strategies, the idea is to visit any concrete model object in the connector's components.
Field	getAccessTokenField() Retrieve the field annotated with OAuthAccessToken
String	getAccessTokenRegex() A Java regular expression used to extract the Access Token from the Service Provider response.
Field	getAccessTokenSecretField() Retrieve the field annotated with OAuthAccessTokenSecret
String	getAccessTokenUrl() The URL defined by the Service Provider to obtain an Access Token
List<OAuthAuthorizationParameter>	getAuthorizationParameters() Extra authorization parameters that will be appended as a query string arguments when building the authorization URL.
String	getAuthorizationUrl() The URL defined by the Service Provider where the Resource Owner will be redirected to grant authorization to the Consumer
List<OAuthCallbackParameterField>	getCallbackParameters() Retrieve a list of fields that need to be populated once the callback in OAuth is executed.
Field	getConsumerKeyField() Retrieve the field annotated with OAuthConsumerKey
Field	getConsumerSecretField() Retrieve the field annotated with OAuthConsumerSecret
String	getExpirationRegex() A Java regular expression used to extract the expiration time of the Access Token (in seconds) from the Service Provider response.
DeclaredType	getOAuthProvider()
OAuthVersion	getOAuthVersion()
Method<OAuthModule>	getPostAuthorizationMethod() Retrieve the method that should be executed once the authorization process has ended.
String	getRefreshTokenRegex() A Java regular expression used to extract the Refresh Token from the Service Provider response.
String	getRequestTokenUrl() The URL defined by the Service Provider used to obtain an un-authorized Request Token
Field	getScopeField() Retrieve the field annotated with OAuthScope
org.mule.security.oauth.OnNoTokenPolicy	getTokenPolicy()
Method<OAuthModule>	getUserIdentifierMethod() Retrieve the method marked with OAuthAccessTokenIdentifier
String	getVerifierRegex() A Java regular expression used to extract the verifier from the Service Provider response as a result of the Resource Owner authorizing the Consumer.
boolean	needsConfig() Return true if this module requires a config element or false if it can work without one.

Methods inherited from class org.mule.devkit.apt.model.module.rest.AnnotationProcessorRestModule

getHeaderFields, getPostFields, getQueryFields, getUriFields

Methods inherited from class org.mule.devkit.apt.model.module.AnnotationProcessorModule

getAnnotatedSchemaLocation, getConfigElementName, getConfigurableFields, getConnectionStrategy, getCurrentSchemaLocation, getDescription, getExceptionHandler, getFilterMethods, getFriendlyName, getKind, getLifecycleMethod, getMinMuleVersion, getModuleName, getModuleSchemaVersion, getProcessorMethods, getQueryTranslatorMethod, getRestCalls, getRestHttpClientField, getSourceMethods, getTransformerMethods, getTransformerResolverMethods, getVersionedSchemaLocation, getXmlNamespace, hasConfigurableWithType, hasDynamicMetadata, hasFilters, hasMetaDataScope, hasMethodWithName, hasProcessorMethodWithParameter, hasProcessors, hasQueryTranslator, hasRestCalls, hasSources, hasTransformerResolver, hasTransformers, isConnector, isModule, manager, metaDataScope, parentModule, reconnectOn, testConnectivityMethod, usesPooling

Methods inherited from class org.mule.devkit.apt.model.AnnotationProcessorClass

getInjectFields, getMetaDataKeyRetrieverMethod, getMetaDataOutputRetrieverMethod, getMetaDataRetrieverMethod

Methods inherited from class org.mule.devkit.apt.model.AnnotationProcessorType

getClassName, getFields, getFieldsAnnotatedWith, getFirstMethodAnnotatedWith, getInheritedFields, getMethods, getMethodsAnnotatedWith, getPackage, getPackageName, getPathToSourceFile, getQualifiedName, getRecursivelyAnnotationProcessorMethodsAnnotatedWith, getRecursivelyFirstMethodAnnotatedWith, getRecursivelyMethodsAnnotatedWith, getRecursivelyMethodsAnnotatedWith, getSuperClass, hasFieldAnnotatedWith, hasNoArgConstructor, hasSuperClass, inheritsFrom, inheritsFrom, isArrayOrList, isBigDecimal, isBigInteger, isBoolean, isCalendar, isChar, isCollection, isComplexType, isComplexTypeWithGetterAndSetter, isDate, isDouble, isDsqlQueryObject, isEnum, isFloat, isHttpCallback, isInteger, isInterface, isLong, isMap, isNestedProcessor, isParametrized, isPrimitive, isSet, isString, isURL, isXmlType

Methods inherited from class org.mule.devkit.apt.model.AnnotationProcessorIdentifiable

asType, asTypeMirror, equals, getAnnotation, getAnnotationFieldValue, getAnnotationMirrors, getJavaDocParameterSummary, getJavaDocSummary, getJavaDocTagContent, getName, getThrowsComment, getTypeArguments, getXmlDeclaredChilds, hasAnnotation, hashCode, hasJavaDocTag, hasTypeArguments, isAbstract, isFinal, isPrivate, isProtected, isPublic, isReservedIdentifier, isStatic, unwrap

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.devkit.model.module.rest.RestModule

getHeaderFields, getPostFields, getQueryFields, getUriFields

Methods inherited from interface org.mule.devkit.model.module.Module

getAnnotatedSchemaLocation, getConfigElementName, getConfigurableFields, getConnectionStrategy, getCurrentSchemaLocation, getDescription, getExceptionHandler, getFilterMethods, getFriendlyName, getKind, getLifecycleMethod, getMinMuleVersion, getModuleName, getModuleSchemaVersion, getProcessorMethods, getQueryTranslatorMethod, getRestCalls, getRestHttpClientField, getSourceMethods, getTransformerMethods, getTransformerResolverMethods, getVersionedSchemaLocation, getXmlNamespace, hasConfigurableWithType, hasDynamicMetadata, hasFilters, hasMetaDataScope, hasMethodWithName, hasProcessorMethodWithParameter, hasProcessors, hasQueryTranslator, hasRestCalls, hasSources, hasTransformerResolver, hasTransformers, isConnector, isModule, manager, metaDataScope, parentModule, reconnectOn, testConnectivityMethod, usesPooling

Methods inherited from interface org.mule.devkit.model.ClassType

getInjectFields, getMetaDataKeyRetrieverMethod, getMetaDataOutputRetrieverMethod, getMetaDataRetrieverMethod

Methods inherited from interface org.mule.devkit.model.Type

getClassName, getFields, getFieldsAnnotatedWith, getFirstMethodAnnotatedWith, getInheritedFields, getMethods, getMethodsAnnotatedWith, getPackage, getPackageName, getPathToSourceFile, getQualifiedName, getRecursivelyAnnotationProcessorMethodsAnnotatedWith, getRecursivelyFirstMethodAnnotatedWith, getRecursivelyMethodsAnnotatedWith, getRecursivelyMethodsAnnotatedWith, getSuperClass, hasFieldAnnotatedWith, hasNoArgConstructor, hasSuperClass, inheritsFrom, inheritsFrom, isDsqlQueryObject, isInterface, isParametrized, isPrimitive

Methods inherited from interface org.mule.devkit.model.Identifiable

asType, asTypeMirror, getName, isReservedIdentifier, unwrap

Methods inherited from interface org.mule.devkit.model.Annotable

getAnnotation, getAnnotationMirrors, hasAnnotation

Methods inherited from interface org.mule.devkit.model.Documentable

getJavaDocParameterSummary, getJavaDocSummary, getJavaDocTagContent, getThrowsComment, hasJavaDocTag

Methods inherited from interface org.mule.devkit.model.Accessible

isAbstract, isFinal, isPrivate, isProtected, isPublic, isStatic

Methods inherited from interface org.mule.devkit.model.Generifiable

getTypeArguments, getXmlDeclaredChilds, hasTypeArguments

Methods inherited from interface org.mule.devkit.model.Typeable

isArrayOrList, isBigDecimal, isBigInteger, isBoolean, isCalendar, isChar, isCollection, isComplexType, isComplexTypeWithGetterAndSetter, isDate, isDouble, isEnum, isFloat, isHttpCallback, isInteger, isLong, isMap, isNestedProcessor, isSet, isString, isURL, isXmlType

Constructor Detail

AnnotationProcessorOAuthModule

public AnnotationProcessorOAuthModule(TypeElement innerElement,
                              Types types,
                              Elements elements,
                              List<Component> components)

Method Detail

getOAuthVersion

public OAuthVersion getOAuthVersion()

Specified by:

getOAuthVersion in interface OAuthCapability

needsConfig

public boolean needsConfig()

Description copied from interface: Module

Return true if this module requires a config element or false if it can work without one.

Specified by:

needsConfig in interface Module

Overrides:

needsConfig in class AnnotationProcessorModule

Returns:

True if requires a config element, false otherwise

getConsumerKeyField

public Field getConsumerKeyField()

Description copied from interface: OAuthCapability

Retrieve the field annotated with OAuthConsumerKey

Specified by:

getConsumerKeyField in interface OAuthCapability

getConsumerSecretField

public Field getConsumerSecretField()

Description copied from interface: OAuthCapability

Retrieve the field annotated with OAuthConsumerSecret

Specified by:

getConsumerSecretField in interface OAuthCapability

getAccessTokenField

public Field getAccessTokenField()

Description copied from interface: OAuthCapability

Retrieve the field annotated with OAuthAccessToken

Specified by:

getAccessTokenField in interface OAuthCapability

getScopeField

public Field getScopeField()

Description copied from interface: OAuthCapability

Retrieve the field annotated with OAuthScope

Specified by:

getScopeField in interface OAuthCapability

getAccessTokenSecretField

public Field getAccessTokenSecretField()

Description copied from interface: OAuthCapability

Retrieve the field annotated with OAuthAccessTokenSecret

Specified by:

getAccessTokenSecretField in interface OAuthCapability

getVerifierRegex

public String getVerifierRegex()

Description copied from interface: OAuthCapability

A Java regular expression used to extract the verifier from the Service Provider response as a result of the Resource Owner authorizing the Consumer.

Specified by:

getVerifierRegex in interface OAuthCapability

getRequestTokenUrl

public String getRequestTokenUrl()

Description copied from interface: OAuthCapability

The URL defined by the Service Provider used to obtain an un-authorized Request Token

Specified by:

getRequestTokenUrl in interface OAuthCapability

getAccessTokenUrl

public String getAccessTokenUrl()

Description copied from interface: OAuthCapability

The URL defined by the Service Provider to obtain an Access Token

Specified by:

getAccessTokenUrl in interface OAuthCapability

getAuthorizationUrl

public String getAuthorizationUrl()

Description copied from interface: OAuthCapability

The URL defined by the Service Provider where the Resource Owner will be redirected to grant authorization to the Consumer

Specified by:

getAuthorizationUrl in interface OAuthCapability

getExpirationRegex

public String getExpirationRegex()

Description copied from interface: OAuthCapability

A Java regular expression used to extract the expiration time of the Access Token (in seconds) from the Service Provider response. If the this regular expression is not found in the Service Provider response (whether the regular expression is wrong or the Access Token never expires), the Access Token will be treated as if it would never expire.

Specified by:

getExpirationRegex in interface OAuthCapability

getAccessTokenRegex

public String getAccessTokenRegex()

Description copied from interface: OAuthCapability

A Java regular expression used to extract the Access Token from the Service Provider response.

Specified by:

getAccessTokenRegex in interface OAuthCapability

getRefreshTokenRegex

public String getRefreshTokenRegex()

Description copied from interface: OAuthCapability

A Java regular expression used to extract the Refresh Token from the Service Provider response.

Specified by:

getRefreshTokenRegex in interface OAuthCapability

getAuthorizationParameters

public List<OAuthAuthorizationParameter> getAuthorizationParameters()

Description copied from interface: OAuthCapability

Extra authorization parameters that will be appended as a query string arguments when building the authorization URL.

Specified by:

getAuthorizationParameters in interface OAuthCapability

getCallbackParameters

public List<OAuthCallbackParameterField> getCallbackParameters()

Description copied from interface: OAuthCapability

Retrieve a list of fields that need to be populated once the callback in OAuth is executed.

Specified by:

getCallbackParameters in interface OAuthCapability

getPostAuthorizationMethod

public Method<OAuthModule> getPostAuthorizationMethod()

Description copied from interface: OAuthCapability

Retrieve the method that should be executed once the authorization process has ended.

Specified by:

getPostAuthorizationMethod in interface OAuthCapability

getUserIdentifierMethod

public Method<OAuthModule> getUserIdentifierMethod()

Description copied from interface: OAuthCapability

Retrieve the method marked with OAuthAccessTokenIdentifier

Specified by:

getUserIdentifierMethod in interface OAuthCapability

accept

public void accept(ModelVisitor visitor)

Description copied from class: AnnotationProcessorRestModule

As this type of object could contain a connector with different connection strategies, the idea is to visit any concrete model object in the connector's components. So far, the only scenario we need to cover is the OAuth one (when visiting a connector), but future scenarios might arise and a refactor on the components could be made to simplify the way of propagating the visitor. handle this

Specified by:

accept in interface Identifiable<TypeElement>

Overrides:

accept in class AnnotationProcessorRestModule

getOAuthProvider

public DeclaredType getOAuthProvider()

Specified by:

getOAuthProvider in interface OAuthCapability

getTokenPolicy

public org.mule.security.oauth.OnNoTokenPolicy getTokenPolicy()

Specified by:

getTokenPolicy in interface OAuthCapability