org.mule.devkit.model.module

Interface ProcessorMethod

All Superinterfaces:

Accessible, Annotable, Documentable, Generifiable, Identifiable<ExecutableElement>, Method<Type>, Parentable<Type>

All Known Subinterfaces:

RestCall

public interface ProcessorMethod
extends Method<Type>

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canBeUsedInConnectionManagement()
boolean	canBeUsedInOAuthManagement() Deprecated.
<T> T	getAnnotationFieldValue(Class<? extends Annotation> anAnnotation, String annotationField) Returns the content of a field for a given annotation.
com.google.common.base.Optional<DeclaredType>	getExceptionHandler()
Parameter	getInputMetaDataKeyParameter()
ManagedConnectionModule	getManagedConnectionModule()
com.google.common.base.Optional<MetaDataCategoryComponent>	getMetaDataCategoryComponent()
OAuthModule	getOAuthModule() Deprecated.
Parameter	getOutputMetaDataKeyParameter()
Paged	getPagingAnnotation()
Parameter	getQueryParameter()
Parameter	getStaticKeyInputMetaData()
MetaDataStaticKey	getStaticKeyOutputMetaData()
boolean	hasDynamicInputMetadata()
boolean	hasDynamicMetaData() Returns true only if the current processor (1) module's minMuleVersion is higher than 3.4.x and (2) the current processor has not been annotated with NoMetaData
boolean	hasDynamicOutputMetaData()
boolean	hasInputOrOutputDynamicMetaData() Returns true only if the current processor hasDynamicMetaData() is true, and it has input or output metadata.
boolean	hasMetaDataScope()
boolean	hasQuery()
boolean	hasQueryParts()
boolean	hasQueryTranslator()
boolean	hasStaticKeyInputMetaData()
boolean	hasStaticKeyMetaData()
boolean	hasStaticKeyOutputMetaData()
DeclaredType	invalidateAccessTokenOn() Deprecated.
DeclaredType	invalidateConnectionOn() Deprecated.
boolean	isBatch()
boolean	isContainer()
boolean	isContainerList()
boolean	isIntercepting()
boolean	isOAuthProtected()
boolean	isPaged()
ProcessorComponentManager	manager() Returns the ProcessorComponent manager
DeclaredType	metaDataScope()
Module	module()
List<AnnotationValue>	reconnectOn()

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

friendlyName, getCapitalizedName, getParameters, getPayloadParameter, getReturnGenericType, getReturnType, getThrownTypes, getTypeParameters, hasOnlyOneChildElement, hasReturnGenericType, xsdName

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

accept, 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.Parentable

parent

Method Detail

manager

ProcessorComponentManager manager()

Returns the ProcessorComponent manager

module

Module module()

invalidateConnectionOn

@Deprecated
DeclaredType invalidateConnectionOn()

Deprecated.

Use reconnectOn() instead

invalidateAccessTokenOn

@Deprecated
DeclaredType invalidateAccessTokenOn()

Deprecated.

Use reconnectOn() instead

reconnectOn

List<AnnotationValue> reconnectOn()

metaDataScope

DeclaredType metaDataScope()

getMetaDataCategoryComponent

com.google.common.base.Optional<MetaDataCategoryComponent> getMetaDataCategoryComponent()

getAnnotationFieldValue

<T> T getAnnotationFieldValue(Class<? extends Annotation> anAnnotation,
                            String annotationField)

Returns the content of a field for a given annotation. Useful when the type of a annotationField within the anAnnotation is Class or Class[]. Use:

• Annotation has a field type of: Class (DeclaredType) getAnnotationFieldValue(SomeAnnotation.class, "value")
• Annotation has a field type of: Class[] (List) getAnnotationFieldValue(SomeAnnotation.class,"values")

isIntercepting

boolean isIntercepting()

isOAuthProtected

boolean isOAuthProtected()

canBeUsedInConnectionManagement

boolean canBeUsedInConnectionManagement()

getManagedConnectionModule

ManagedConnectionModule getManagedConnectionModule()

canBeUsedInOAuthManagement

@Deprecated
boolean canBeUsedInOAuthManagement()

Deprecated.

This is currently a hack to find if the current processor lives in a module with oauth support, or if any subclass has oauth support.

Returns:

getOAuthModule

@Deprecated
OAuthModule getOAuthModule()

Deprecated.

This is currently a hack to find if the current processor lives in a module with oauth support, or if any subclass has oauth support.

Returns:

hasQuery

boolean hasQuery()

getQueryParameter

Parameter getQueryParameter()

hasQueryParts

boolean hasQueryParts()

hasQueryTranslator

boolean hasQueryTranslator()

isPaged

boolean isPaged()

isBatch

boolean isBatch()

getPagingAnnotation

Paged getPagingAnnotation()

hasDynamicMetaData

boolean hasDynamicMetaData()

Returns true only if the current processor (1) module's minMuleVersion is higher than 3.4.x and (2) the current processor has not been annotated with NoMetaData

Returns:

true if the processor supports dynamic datasense, false otherwise.

hasInputOrOutputDynamicMetaData

boolean hasInputOrOutputDynamicMetaData()

Returns true only if the current processor hasDynamicMetaData() is true, and it has input or output metadata.

This method is used instead of hasDynamicMetaData() if we want to be 100% sure that the current processor actually hast something being affected by the MetaDataKeyParam

Returns:

true if the processor supports dynamic datasense, false otherwise.

hasDynamicInputMetadata

boolean hasDynamicInputMetadata()

hasDynamicOutputMetaData

boolean hasDynamicOutputMetaData()

getInputMetaDataKeyParameter

Parameter getInputMetaDataKeyParameter()

getOutputMetaDataKeyParameter

Parameter getOutputMetaDataKeyParameter()

hasStaticKeyMetaData

boolean hasStaticKeyMetaData()

hasStaticKeyInputMetaData

boolean hasStaticKeyInputMetaData()

getStaticKeyInputMetaData

Parameter getStaticKeyInputMetaData()

hasStaticKeyOutputMetaData

boolean hasStaticKeyOutputMetaData()

getStaticKeyOutputMetaData

MetaDataStaticKey getStaticKeyOutputMetaData()

hasMetaDataScope

boolean hasMetaDataScope()

getExceptionHandler

com.google.common.base.Optional<DeclaredType> getExceptionHandler()

isContainer

boolean isContainer()

isContainerList

boolean isContainerList()