public interface Module extends ClassType
Module
, Connector
or ExpressionLanguage
.Modifier and Type | Method and Description |
---|---|
String |
getAnnotatedSchemaLocation() |
String |
getConfigElementName()
Retrieve the name of the config element
|
List<Field> |
getConfigurableFields()
Retrieve a list of fields that have been annotated with
Configurable
This method will recursively go thru all superclasses as well. |
com.google.common.base.Optional<Field<Type>> |
getConnectionStrategy() |
String |
getCurrentSchemaLocation() |
String |
getDescription()
Get the description of this module
|
com.google.common.base.Optional<DeclaredType> |
getExceptionHandler() |
List<FilterMethod> |
getFilterMethods()
Get a list of all methods annotated with @Filter
This method will recursively go thru all superclasses as well.
|
String |
getFriendlyName()
Returns the friendlyName attribute if exists, if not, it will transform the name attribute.
|
ModuleKind |
getKind() |
Method |
getLifecycleMethod(String phaseName)
Retrieve the method that needs to be called during a particular lifecycle phase.
|
org.mule.common.MuleVersion |
getMinMuleVersion()
Get the minimum Mule version supported by this module
|
String |
getModuleName() |
String |
getModuleSchemaVersion() |
List<ProcessorMethod> |
getProcessorMethods()
Get a list of all methods annotated with @Processor
This method will recursively go thru all superclasses as well.
|
Method |
getQueryTranslatorMethod() |
List<RestCall> |
getRestCalls()
Retrieve a list of all the methods inside the module that are annotated
with
RestCall |
Field |
getRestHttpClientField()
Retrieve the field annotated with
RestHttpClient |
List<SourceMethod> |
getSourceMethods()
Get a list of all methods annotated with @Source
This method will recursively go thru all superclasses as well.
|
List<TransformerMethod> |
getTransformerMethods()
Retrieve a list of all the methods inside the module that are annotated
with
Transformer |
List<TransformerResolverMethod> |
getTransformerResolverMethods()
Retrieve a list of all the methods inside the module that are annotated
with
TransformerResolver |
String |
getVersionedSchemaLocation() |
String |
getXmlNamespace() |
boolean |
hasConfigurableWithType(Class<?> parameterType) |
boolean |
hasDynamicMetadata()
Returns true if the connector has (1) minMuleVersion 3.4.x or above,
and (2) one of the following is fulfilled:
support both datasense methods (@MetaDataRetriever and @MetaDataKeyRetriever, soon to be deprecated for @MetaDataCategories)
either the current module's manager, or any of its @Processors, has a @MetaDataCategory component
|
boolean |
hasFilters()
True if the module has at least one method annotated with
Filter |
boolean |
hasMetaDataScope() |
boolean |
hasMethodWithName(String methodName) |
boolean |
hasProcessorMethodWithParameter(Class<?> parameterType) |
boolean |
hasProcessors()
True if the module has at least one method annotated with
Processor |
boolean |
hasQueryTranslator() |
boolean |
hasRestCalls()
True if the module has at least one method annotated with
RestCall |
boolean |
hasSources()
True if the module has at least one method annotated with
Source |
boolean |
hasTransformerResolver()
True if the module has at least one method annotated with
TransformerResolver |
boolean |
hasTransformers()
True if the module has at least one method annotated with
Transformer |
boolean |
isConnector()
Check if the module is annotated with
Connector |
boolean |
isModule()
Check if the module is annotated with
Module |
ModuleComponentManager |
manager()
Returns the manager for the
ModuleComponent of this module |
DeclaredType |
metaDataScope() |
boolean |
needsConfig()
Return true if this module requires a config element or false if it can work
without one.
|
Module |
parentModule() |
List<AnnotationValue> |
reconnectOn() |
com.google.common.base.Optional<Method> |
testConnectivityMethod() |
boolean |
usesPooling() |
getInjectFields, getMetaDataKeyRetrieverMethod, getMetaDataOutputRetrieverMethod, getMetaDataRetrieverMethod
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
accept, asType, asTypeMirror, getName, isReservedIdentifier, unwrap
getAnnotation, getAnnotationMirrors, hasAnnotation
getJavaDocParameterSummary, getJavaDocSummary, getJavaDocTagContent, getThrowsComment, hasJavaDocTag
isAbstract, isFinal, isPrivate, isProtected, isPublic, isStatic
getTypeArguments, getXmlDeclaredChilds, hasTypeArguments
isArrayOrList, isBigDecimal, isBigInteger, isBoolean, isCalendar, isChar, isCollection, isComplexType, isComplexTypeWithGetterAndSetter, isDate, isDouble, isEnum, isFloat, isHttpCallback, isInteger, isLong, isMap, isNestedProcessor, isSet, isString, isURL, isXmlType
ModuleComponentManager manager()
ModuleComponent
of this moduleboolean hasProcessorMethodWithParameter(Class<?> parameterType)
boolean hasConfigurableWithType(Class<?> parameterType)
List<Field> getConfigurableFields()
Configurable
This method will recursively go thru all superclasses as well.Configurable
List<SourceMethod> getSourceMethods()
SourceMethod}
List<ProcessorMethod> getProcessorMethods()
ProcessorMethod}
List<FilterMethod> getFilterMethods()
FilterMethod}
boolean hasSources()
Source
Source
boolean hasProcessors()
Processor
Processor
boolean hasFilters()
Filter
Filter
boolean hasTransformers()
Transformer
Transformer
List<TransformerMethod> getTransformerMethods()
Transformer
List<TransformerResolverMethod> getTransformerResolverMethods()
TransformerResolver
boolean usesPooling()
org.mule.common.MuleVersion getMinMuleVersion()
String getXmlNamespace()
String getModuleName()
String getAnnotatedSchemaLocation()
String getVersionedSchemaLocation()
String getCurrentSchemaLocation()
String getModuleSchemaVersion()
String getFriendlyName()
String getDescription()
boolean needsConfig()
ModuleKind getKind()
String getConfigElementName()
Method getLifecycleMethod(String phaseName)
phaseName
- The name of the phase. Supported phases are:
org.mule.api.lifecycle.Startable.PHASE_NAME
,
org.mule.api.lifecycle.Stoppable.PHASE_NAME
,
org.mule.api.lifecycle.Initialisable.PHASE_NAME
,
org.mule.api.lifecycle.Disposable.PHASE_NAME
Field getRestHttpClientField()
RestHttpClient
boolean hasRestCalls()
RestCall
RestCall
boolean hasTransformerResolver()
TransformerResolver
TransformerResolver
List<RestCall> getRestCalls()
RestCall
boolean isConnector()
Connector
boolean isModule()
Module
boolean hasDynamicMetadata()
Returns true if the connector has (1) minMuleVersion 3.4.x or above, and (2) one of the following is fulfilled:
Module parentModule()
boolean hasMethodWithName(String methodName)
boolean hasQueryTranslator()
Method getQueryTranslatorMethod()
DeclaredType metaDataScope()
boolean hasMetaDataScope()
List<AnnotationValue> reconnectOn()
com.google.common.base.Optional<Method> testConnectivityMethod()
TestConnectivity
com.google.common.base.Optional<DeclaredType> getExceptionHandler()
Copyright © 2010–2015 MuleSoft, Inc.. All rights reserved.