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	checkParameterGroupExclusiveness(Optional<org.mule.runtime.api.meta.model.parameter.ParameterizedModel> model, List<org.mule.runtime.api.meta.model.parameter.ParameterGroupModel> groups, Map<String,?> parameters, Map<String,String> aliasedParameterNames) Checks the given ParameterGroupModels against the given resolved parameters and validates that the group exclusiveness is honored.
static Optional<String>	extractExpression(Object value) Parse the given value and remove expression markers if it is considered as an expression.
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 Type	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 Optional<String>	getDefaultValue(org.mule.sdk.api.annotation.param.Optional optionalAnnotation)
static Optional<String>	getDefaultValue(org.mule.runtime.extension.api.annotation.param.Optional optionalAnnotation)
static String	getExtensionsNamespace(org.mule.runtime.api.meta.model.declaration.fluent.ExtensionDeclaration extensionDeclaration)
static String	getExtensionsNamespace(org.mule.runtime.api.meta.model.ExtensionModel extensionModel)
static Optional<Class>	getImplementingType(org.mule.runtime.api.meta.model.EnrichableModel enrichableModel) Tests the given enrichableModel for a ImplementingTypeModelProperty and if present it returns the enclosed implementing type.
static String	getImplicitConfigurationProviderName(org.mule.runtime.api.meta.model.ExtensionModel extensionModel, org.mule.runtime.api.meta.model.config.ConfigurationModel configurationModel, ArtifactType extendedArtifactType, String extendedArtifactId, org.mule.runtime.api.config.FeatureFlaggingService extendedArtifactFeatureFlaggingService) Resolves the ConfigurationProvider name for an extension.
static <T extends org.mule.runtime.api.meta.model.ComponentModel> org.mule.runtime.extension.api.runtime.operation.ComponentExecutorFactory<T>	getLegacyOperationExecutorFactory(T operationModel) Deprecated. since 4.3. Use getOperationExecutorFactory(ComponentModel) instead
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 MutableConfigurationStats	getMutableConfigurationStats(org.mule.runtime.extension.api.runtime.operation.ExecutionContext<?> context)
static <T extends org.mule.runtime.api.meta.model.ComponentModel> org.mule.runtime.extension.api.runtime.operation.CompletableComponentExecutorFactory<T>	getOperationExecutorFactory(T operationModel)
static org.mule.runtime.extension.api.runtime.source.SdkSourceFactory	getSdkSourceFactory(org.mule.runtime.api.meta.model.source.SourceModel sourceModel) Tests the given sourceModel for a SdkSourceFactoryModelProperty and if present it returns the enclosed SdkSourceFactory.
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 boolean	isCompileTime(org.mule.runtime.api.meta.model.ExtensionModel extensionModel) Indicates if the extension model is being built on compile time.
static boolean	isConnectedStreamingOperation(org.mule.runtime.api.meta.model.ComponentModel componentModel)
static boolean	isExpression(Object value) TODO MULE-14603 - This should not exist after MULE-14603 is fixed
static boolean	isNonBlocking(org.mule.runtime.api.meta.model.ComponentModel model)
static boolean	isNullSafe(org.mule.runtime.api.meta.model.parameter.ParameterModel parameterModel)
static boolean	isSynthetic(org.mule.runtime.api.meta.model.EnrichableModel enrichableModel) Indicates whether a give EnrichableModel is synthetic or not.
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 boolean	returnsListOfMessages(org.mule.runtime.api.meta.model.HasOutputModel componentModel)
static boolean	supportsOAuth(org.mule.runtime.api.meta.model.ExtensionModel extensionModel) Whether at least one ConnectionProviderModel in the given supports OAuth authentication
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 byte	toActionCode(org.mule.runtime.extension.api.tx.SourceTransactionalAction action) Converts the given action to its equivalent transactional action as defined in TransactionConfig
static Optional<org.mule.runtime.extension.api.runtime.source.BackPressureAction>	toBackPressureAction(MessageSource.BackPressureStrategy backPressureStrategy)
static MessageSource.BackPressureStrategy	toBackPressureStrategy(org.mule.runtime.extension.api.runtime.source.BackPressureMode mode)
static MessageSource.BackPressureStrategy	toBackPressureStrategy(String backPressureModeName)
static Map<String,Object>	toMap(ResolverSet resolverSet, ValueResolvingContext ctx)
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.HasOutputModel 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

toMap

public static Map<String,Object> toMap(ResolverSet resolverSet,
                                       ValueResolvingContext ctx)
                                throws org.mule.runtime.api.exception.MuleException

Throws:

org.mule.runtime.api.exception.MuleException

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

supportsOAuth

public static boolean supportsOAuth(org.mule.runtime.api.meta.model.ExtensionModel extensionModel)

Whether at least one ConnectionProviderModel in the given supports OAuth authentication

Parameters:

extensionModel - a ExtensionModel

Returns:

true if a ConnectionProviderModel exist which is OAuth enabled

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

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

toActionCode

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

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

Parameters:

action - a SourceTransactionalAction

Returns:

a byte transactional action

toBackPressureStrategy

public static MessageSource.BackPressureStrategy toBackPressureStrategy(org.mule.runtime.extension.api.runtime.source.BackPressureMode mode)

Parameters:

mode - a BackPressureMode

Returns:

a MessageSource.BackPressureStrategy

toBackPressureStrategy

public static MessageSource.BackPressureStrategy toBackPressureStrategy(String backPressureModeName)

Parameters:

backPressureModeName - the name of a BackPressureMode

Returns:

a MessageSource.BackPressureStrategy

toBackPressureAction

public static Optional<org.mule.runtime.extension.api.runtime.source.BackPressureAction> toBackPressureAction(MessageSource.BackPressureStrategy backPressureStrategy)

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

getLegacyOperationExecutorFactory

@Deprecated
public static <T extends org.mule.runtime.api.meta.model.ComponentModel> org.mule.runtime.extension.api.runtime.operation.ComponentExecutorFactory<T> getLegacyOperationExecutorFactory(T operationModel)

Deprecated. since 4.3. Use getOperationExecutorFactory(ComponentModel) instead

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

Parameters:

operationModel - an OperationModel

Returns:

a ComponentExecutorFactory

Throws:

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

getOperationExecutorFactory

public static <T extends org.mule.runtime.api.meta.model.ComponentModel> org.mule.runtime.extension.api.runtime.operation.CompletableComponentExecutorFactory<T> getOperationExecutorFactory(T operationModel)

isNonBlocking

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

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

getSdkSourceFactory

public static org.mule.runtime.extension.api.runtime.source.SdkSourceFactory getSdkSourceFactory(org.mule.runtime.api.meta.model.source.SourceModel sourceModel)

Tests the given sourceModel for a SdkSourceFactoryModelProperty and if present it returns the enclosed SdkSourceFactory. 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 Type 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

getExtensionsNamespace

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

Returns:

the extension's error namespace for a given ExtensionModel

getExtensionsNamespace

public static String getExtensionsNamespace(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)

getImplicitConfigurationProviderName

public static String getImplicitConfigurationProviderName(org.mule.runtime.api.meta.model.ExtensionModel extensionModel,
                                                          org.mule.runtime.api.meta.model.config.ConfigurationModel configurationModel,
                                                          ArtifactType extendedArtifactType,
                                                          String extendedArtifactId,
                                                          org.mule.runtime.api.config.FeatureFlaggingService extendedArtifactFeatureFlaggingService)

Resolves the ConfigurationProvider name for an extension.

Parameters:

extensionModel - The ExtensionModel of the extension.

configurationModel - The ConfigurationModel of the extension.

extendedArtifactType - The ArtifactType of the extended artifact.

extendedArtifactId - The unique id of the extended artifact.

extendedArtifactFeatureFlaggingService - The FeatureFlaggingService of the extended artifact.

Returns:

The ConfigurationProvider name.

isExpression

public static boolean isExpression(Object value)

TODO MULE-14603 - This should not exist after MULE-14603 is fixed

Indicates if the given value is considered as an expression

Parameters:

value - Value to check

Returns:

a boolean indicating if the value is an expression or not.

extractExpression

public static Optional<String> extractExpression(Object value)

Parse the given value and remove expression markers if it is considered as an expression.

Parameters:

value - Value to parse

Returns:

a String containing the expression without markers or null if the value is not an expression.

isCompileTime

public static boolean isCompileTime(org.mule.runtime.api.meta.model.ExtensionModel extensionModel)

Indicates if the extension model is being built on compile time.

Parameters:

extensionModel - the extension model to check

Returns:

a boolean indicating if the the extension model is being build on runtime or not

Since:

4.3.0

isSynthetic

public static boolean isSynthetic(org.mule.runtime.api.meta.model.EnrichableModel enrichableModel)

Indicates whether a give EnrichableModel is synthetic or not.

Parameters:

enrichableModel - the enrichable model that may be synthetic

Returns:

if the enrichable model is synthetic or not

Since:

4.3.0

getImplementingType

public static Optional<Class> getImplementingType(org.mule.runtime.api.meta.model.EnrichableModel enrichableModel)

Tests the given enrichableModel for a ImplementingTypeModelProperty and if present it returns the enclosed implementing type.

Parameters:

enrichableModel - the provider to get the implemented type from

Returns:

an Optional that either has the provider implementing type, or is empty

Since:

4.3.0

getMutableConfigurationStats

public static MutableConfigurationStats getMutableConfigurationStats(org.mule.runtime.extension.api.runtime.operation.ExecutionContext<?> context)

Returns:

the MutableConfigurationStats for a given ExecutionContext

Since:

4.2.3 - 4.3.0

isConnectedStreamingOperation

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

Returns:

whether the ComponentModel defines a streaming operation that uses a connection.

Since:

4.2.3 - 4.3.0

getDefaultValue

public static Optional<String> getDefaultValue(org.mule.sdk.api.annotation.param.Optional optionalAnnotation)

getDefaultValue

public static Optional<String> getDefaultValue(org.mule.runtime.extension.api.annotation.param.Optional optionalAnnotation)

checkParameterGroupExclusiveness

public static void checkParameterGroupExclusiveness(Optional<org.mule.runtime.api.meta.model.parameter.ParameterizedModel> model,
                                                    List<org.mule.runtime.api.meta.model.parameter.ParameterGroupModel> groups,
                                                    Map<String,?> parameters,
                                                    Map<String,String> aliasedParameterNames)
                                             throws ConfigurationException

Checks the given ParameterGroupModels against the given resolved parameters and validates that the group exclusiveness is honored.

Parameters:

model - the model that owns the parameter groups

groups - the parameter groups in the model whose exclusiveness must be honored

parameters - the resolved parameters

aliasedParameterNames - the alias for each parameter if it has one

Throws:

ConfigurationException - if the group exclusiveness is not honored by the resolved parameters.

Since:

4.4.0