org.mule.runtime.module.extension.internal.util

Class MuleExtensionUtils

java.lang.Object

org.mule.runtime.module.extension.internal.util.MuleExtensionUtils

public class MuleExtensionUtils
extends Object

Utilities for handling extensions

Since:

3.7.0

Constructor Summary

Constructors

Constructor and Description
MuleExtensionUtils()

Method Summary

Modifier and Type	Method and Description
static void	addInterceptorFactory(org.mule.runtime.api.meta.model.declaration.fluent.BaseDeclaration declaration, org.mule.runtime.extension.api.runtime.InterceptorFactory interceptorFactory) Adds the given interceptorFactory to the declaration as the last interceptor in the list
static void	addInterceptorFactory(org.mule.runtime.api.meta.model.declaration.fluent.BaseDeclaration declaration, org.mule.runtime.extension.api.runtime.InterceptorFactory interceptorFactory, int position) Adds the given interceptorFactory to the declaration at the given position
static List<org.mule.runtime.extension.api.runtime.operation.Interceptor>	createInterceptors(org.mule.runtime.api.meta.model.EnrichableModel model) Creates a new List of interceptors using the factories returned by InterceptorsModelProperty (if present).
static List<org.mule.runtime.extension.api.runtime.operation.Interceptor>	createInterceptors(List<org.mule.runtime.extension.api.runtime.InterceptorFactory> interceptorFactories) Creates a new List of interceptors using the interceptorFactories
static List<org.mule.runtime.api.meta.model.connection.ConnectionProviderModel>	getAllConnectionProviders(org.mule.runtime.api.meta.model.ExtensionModel extensionModel, org.mule.runtime.api.meta.model.config.ConfigurationModel configurationModel) Returns all the ConnectionProviderModel instances available for the given configurationModel plus the ones globally defined at the extensionModel.
static ClassLoader	getClassLoader(org.mule.runtime.api.meta.model.ExtensionModel extensionModel) If the extensionModel contains a ClassLoaderModelProperty, then it returns the ClassLoader associated to such property.
static org.mule.runtime.extension.api.runtime.config.ConfigurationFactory	getConfigurationFactory(org.mule.runtime.api.meta.model.config.ConfigurationModel configurationModel) Tests the configurationModel for a ConfigurationFactoryModelProperty and returns the contained ConfigurationFactory.
static org.mule.runtime.extension.api.runtime.connectivity.ConnectionProviderFactory	getConnectionProviderFactory(org.mule.runtime.api.meta.model.connection.ConnectionProviderModel connectionProviderModel) Tests the given connectionProviderModel for a ConnectionProviderFactoryModelProperty and if present it returns the enclosed ConnectionProviderFactory.
static Class<?>	getConnectionType(org.mule.runtime.api.meta.model.connection.ConnectionProviderModel connectionProviderModel) Tests the given connectionProviderModel for a ConnectionTypeModelProperty and if present it returns the enclosed connection type.
static Object	getDefaultValue(AccessibleObject object) Tests the given object to be annotated with Optional.
static String	getDefaultValue(org.mule.runtime.extension.api.annotation.param.Optional optional) Returns the default value associated with the given annotation.
static String	getExtensionsErrorNamespace(org.mule.runtime.api.meta.model.declaration.fluent.ExtensionDeclaration extensionDeclaration)
static String	getExtensionsErrorNamespace(org.mule.runtime.api.meta.model.ExtensionModel extensionModel)
static Method	getImplementingMethod(org.mule.runtime.api.meta.model.declaration.fluent.OperationDeclaration operationDeclaration) Returns the Method that was used to declare the given operationDeclaration.
static Event	getInitialiserEvent()
static Event	getInitialiserEvent(MuleContext muleContext)
static org.mule.runtime.extension.api.metadata.MetadataResolverFactory	getMetadataResolverFactory(org.mule.runtime.api.meta.model.EnrichableModel model) Tests the given model for a MetadataResolverFactoryModelProperty and if present it returns the contained MetadataResolverFactory.
static org.mule.runtime.extension.api.runtime.operation.OperationExecutorFactory	getOperationExecutorFactory(org.mule.runtime.api.meta.model.operation.OperationModel operationModel) Tests the given operationModel for a OperationExecutorModelProperty and if present it returns the enclosed OperationExecutorFactory.
static org.mule.runtime.extension.api.runtime.source.SourceFactory	getSourceFactory(org.mule.runtime.api.meta.model.source.SourceModel sourceModel) Tests the given sourceModel for a SourceFactoryModelProperty and if present it returns the enclosed SourceFactory.
static <T> boolean	hasAnyDynamic(Iterable<ValueResolver<T>> resolvers) Returns true if any of the items in resolvers return true for the ValueResolver.isDynamic() method
static void	injectConfigName(org.mule.runtime.api.meta.model.EnrichableModel model, Object target, String configName)
static boolean	isNullSafe(org.mule.runtime.api.meta.model.parameter.ParameterModel parameterModel)
static org.mule.runtime.api.meta.model.ExtensionModel	loadExtension(Class<?> clazz)
static org.mule.runtime.api.meta.model.ExtensionModel	loadExtension(Class<?> clazz, Map<String,Object> params)
static org.mule.runtime.extension.api.exception.IllegalModelDefinitionException	noClassLoaderException(String extensionName) Creates an exception that says that no ClassLoader was specified for the extension of the given extensionName
static boolean	returnsListOfMessages(org.mule.runtime.api.meta.model.ComponentModel componentModel)
static byte	toActionCode(org.mule.runtime.extension.api.tx.OperationTransactionalAction action) Converts the given action to its equivalent transactional action as defined in TransactionConfig
static <T> T	withExtensionClassLoader(org.mule.runtime.api.meta.model.ExtensionModel extensionModel, Callable<T> callable) Executes the given callable using the ClassLoader associated to the extensionModel

Methods inherited from class java.lang.Object

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

Constructor Detail

MuleExtensionUtils

public MuleExtensionUtils()

Method Detail

returnsListOfMessages

public static boolean returnsListOfMessages(org.mule.runtime.api.meta.model.ComponentModel componentModel)

Parameters:

componentModel - a ComponentModel

Returns:

Whether the componentModel returns a list of messages

hasAnyDynamic

public static <T> boolean hasAnyDynamic(Iterable<ValueResolver<T>> resolvers)

Returns true if any of the items in resolvers return true for the ValueResolver.isDynamic() method

Type Parameters:

T - the generic type of the ValueResolver items

Parameters:

resolvers - a Iterable with instances of ValueResolver

Returns:

true if at least one ValueResolver is dynamic, false otherwise

isNullSafe

public static boolean isNullSafe(org.mule.runtime.api.meta.model.parameter.ParameterModel parameterModel)

Parameters:

parameterModel - a ParameterModel

Returns:

Whether the given parameter is null safe

getAllConnectionProviders

public static List<org.mule.runtime.api.meta.model.connection.ConnectionProviderModel> getAllConnectionProviders(org.mule.runtime.api.meta.model.ExtensionModel extensionModel,
                                                                                                                 org.mule.runtime.api.meta.model.config.ConfigurationModel configurationModel)

Returns all the ConnectionProviderModel instances available for the given configurationModel plus the ones globally defined at the extensionModel. The List will first contain those defined at a HasConnectionProviderModels.getConnectionProviders() level and finally the ones at ExtensionModel.getConnectionProviders()

Parameters:

extensionModel - the ExtensionModel which owns the configurationModel

configurationModel - a ConfigurationModel

Returns:

a List. Might be empty but will never be null

createInterceptors

public static List<org.mule.runtime.extension.api.runtime.operation.Interceptor> createInterceptors(org.mule.runtime.api.meta.model.EnrichableModel model)

Creates a new List of interceptors using the factories returned by InterceptorsModelProperty (if present).

Parameters:

model - the model on which InterceptorsModelProperty is to be invoked

Returns:

an immutable List with instances of Interceptor

addInterceptorFactory

public static void addInterceptorFactory(org.mule.runtime.api.meta.model.declaration.fluent.BaseDeclaration declaration,
                                         org.mule.runtime.extension.api.runtime.InterceptorFactory interceptorFactory)

Adds the given interceptorFactory to the declaration as the last interceptor in the list

Parameters:

declaration - a BaseDeclaration

interceptorFactory - a InterceptorFactory

addInterceptorFactory

public static void addInterceptorFactory(org.mule.runtime.api.meta.model.declaration.fluent.BaseDeclaration declaration,
                                         org.mule.runtime.extension.api.runtime.InterceptorFactory interceptorFactory,
                                         int position)

Adds the given interceptorFactory to the declaration at the given position

Parameters:

declaration - a BaseDeclaration

interceptorFactory - a InterceptorFactory

position - a valid list index

createInterceptors

public static List<org.mule.runtime.extension.api.runtime.operation.Interceptor> createInterceptors(List<org.mule.runtime.extension.api.runtime.InterceptorFactory> interceptorFactories)

Creates a new List of interceptors using the interceptorFactories

Parameters:

interceptorFactories - a List with instances of InterceptorFactory

Returns:

an immutable List with instances of Interceptor

getDefaultValue

public static String getDefaultValue(org.mule.runtime.extension.api.annotation.param.Optional optional)

Returns the default value associated with the given annotation.

The reason for this method to be instead of simply using Optional.defaultValue() is a limitation on the Java language to have an annotation which defaults to a null value. For that reason, this method tests the default value for equality against the Optional.NULL. If such test is positive, then null is returned.

If a null optional is supplied, then this method returns null

Parameters:

optional - a nullable annotation

Returns:

the default value associated to the annotation or null

getDefaultValue

public static Object getDefaultValue(AccessibleObject object)

Tests the given object to be annotated with Optional.

If the annotation is present, then a default value is extracted by the rules of getDefaultValue(Optional). Otherwise, null is returned.

Notice that a null return value doesn't necessarily mean that the annotation is not present. It could well be that null happens to be the default value.

Parameters:

object - an object potentially annotated with Optional

Returns:

A default value or null

getInitialiserEvent

public static Event getInitialiserEvent()

getInitialiserEvent

public static Event getInitialiserEvent(MuleContext muleContext)

getImplementingMethod

public static Method getImplementingMethod(org.mule.runtime.api.meta.model.declaration.fluent.OperationDeclaration operationDeclaration)

Returns the Method that was used to declare the given operationDeclaration.

Parameters:

operationDeclaration - a OperationDeclaration

Returns:

A Method or null if the operationDeclaration was defined by other means

getClassLoader

public static ClassLoader getClassLoader(org.mule.runtime.api.meta.model.ExtensionModel extensionModel)

If the extensionModel contains a ClassLoaderModelProperty, then it returns the ClassLoader associated to such property. Otherwise, it returns the current TCCL

Parameters:

extensionModel - a ExtensionModel

Returns:

a ClassLoader

withExtensionClassLoader

public static <T> T withExtensionClassLoader(org.mule.runtime.api.meta.model.ExtensionModel extensionModel,
                                             Callable<T> callable)
                                      throws Exception

Executes the given callable using the ClassLoader associated to the extensionModel

Type Parameters:

T - the generic type of the callable's return type

Parameters:

extensionModel - a ExtensionModel

callable - a Callable

Returns:

the value returned by the callable

Throws:

Exception - if the callable fails to execute

injectConfigName

public static void injectConfigName(org.mule.runtime.api.meta.model.EnrichableModel model,
                                    Object target,
                                    String configName)

toActionCode

public static byte toActionCode(org.mule.runtime.extension.api.tx.OperationTransactionalAction action)

Converts the given action to its equivalent transactional action as defined in TransactionConfig

Parameters:

action - a OperationTransactionalAction

Returns:

a byte transactional action

getConfigurationFactory

public static org.mule.runtime.extension.api.runtime.config.ConfigurationFactory getConfigurationFactory(org.mule.runtime.api.meta.model.config.ConfigurationModel configurationModel)

Tests the configurationModel for a ConfigurationFactoryModelProperty and returns the contained ConfigurationFactory.

Parameters:

configurationModel - a ConfigurationModel

Returns:

a ConfigurationFactory

Throws:

org.mule.runtime.extension.api.exception.IllegalConfigurationModelDefinitionException - if the configurationModel doesn't contain such model property

getMetadataResolverFactory

public static org.mule.runtime.extension.api.metadata.MetadataResolverFactory getMetadataResolverFactory(org.mule.runtime.api.meta.model.EnrichableModel model)

Tests the given model for a MetadataResolverFactoryModelProperty and if present it returns the contained MetadataResolverFactory. If no such property is found, then a NullMetadataResolverFactory is returned

Parameters:

model - an enriched model

Returns:

a MetadataResolverFactory

getOperationExecutorFactory

public static org.mule.runtime.extension.api.runtime.operation.OperationExecutorFactory getOperationExecutorFactory(org.mule.runtime.api.meta.model.operation.OperationModel operationModel)

Tests the given operationModel for a OperationExecutorModelProperty and if present it returns the enclosed OperationExecutorFactory. If no such property is found, then a IllegalOperationModelDefinitionException is thrown.

Parameters:

operationModel - an OperationModel

Returns:

a OperationExecutorFactory

Throws:

org.mule.runtime.extension.api.exception.IllegalOperationModelDefinitionException - if the operation is not properly enriched

getSourceFactory

public static org.mule.runtime.extension.api.runtime.source.SourceFactory getSourceFactory(org.mule.runtime.api.meta.model.source.SourceModel sourceModel)

Tests the given sourceModel for a SourceFactoryModelProperty and if present it returns the enclosed SourceFactory. If no such property is found, then a IllegalSourceModelDefinitionException is thrown

Parameters:

sourceModel - a SourceModel

Returns:

a SourceFactory

Throws:

org.mule.runtime.extension.api.exception.IllegalSourceModelDefinitionException - if the source is not properly enriched

getConnectionProviderFactory

public static org.mule.runtime.extension.api.runtime.connectivity.ConnectionProviderFactory getConnectionProviderFactory(org.mule.runtime.api.meta.model.connection.ConnectionProviderModel connectionProviderModel)

Tests the given connectionProviderModel for a ConnectionProviderFactoryModelProperty and if present it returns the enclosed ConnectionProviderFactory. If no such property is found, then a IllegalConnectionProviderModelDefinitionException is thrown

Parameters:

connectionProviderModel - a ConnectionProviderModel

Returns:

a SourceFactory

Throws:

org.mule.runtime.extension.api.exception.IllegalConnectionProviderModelDefinitionException - if the connection provider is not properly enriched

getConnectionType

public static Class<?> getConnectionType(org.mule.runtime.api.meta.model.connection.ConnectionProviderModel connectionProviderModel)

Tests the given connectionProviderModel for a ConnectionTypeModelProperty and if present it returns the enclosed connection type. If no such property is found, then a IllegalConnectionProviderModelDefinitionException is thrown

Parameters:

connectionProviderModel - a ConnectionProviderModel

Returns:

a connection Class

Throws:

org.mule.runtime.extension.api.exception.IllegalConnectionProviderModelDefinitionException - if the connection provider is not properly enriched

noClassLoaderException

public static org.mule.runtime.extension.api.exception.IllegalModelDefinitionException noClassLoaderException(String extensionName)

Creates an exception that says that no ClassLoader was specified for the extension of the given extensionName

Parameters:

extensionName - the name of the offending extension

Returns:

an IllegalModelDefinitionException

getExtensionsErrorNamespace

public static String getExtensionsErrorNamespace(org.mule.runtime.api.meta.model.ExtensionModel extensionModel)

Returns:

the extension's error namespace for a given ExtensionModel

getExtensionsErrorNamespace

public static String getExtensionsErrorNamespace(org.mule.runtime.api.meta.model.declaration.fluent.ExtensionDeclaration extensionDeclaration)

Returns:

the extension's error namespace for a given ExtensionDeclaration

loadExtension

public static org.mule.runtime.api.meta.model.ExtensionModel loadExtension(Class<?> clazz)

loadExtension

public static org.mule.runtime.api.meta.model.ExtensionModel loadExtension(Class<?> clazz,
                                                                           Map<String,Object> params)