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

Class ExtensionComponent<T extends org.mule.runtime.api.meta.model.ComponentModel>

java.lang.Object

org.mule.runtime.api.component.AbstractComponent

org.mule.runtime.module.extension.internal.runtime.ExtensionComponent<T>

All Implemented Interfaces:

org.mule.runtime.api.component.Component, org.mule.runtime.api.lifecycle.Disposable, org.mule.runtime.api.lifecycle.Initialisable, org.mule.runtime.api.lifecycle.Lifecycle, org.mule.runtime.api.lifecycle.Startable, org.mule.runtime.api.lifecycle.Stoppable, org.mule.runtime.api.metadata.MetadataKeyProvider, org.mule.runtime.api.metadata.MetadataProvider<T>, MuleContextAware, ErrorMappingsAware, org.mule.runtime.extension.api.values.ComponentValueProvider

Direct Known Subclasses:

ComponentMessageProcessor, ExtensionMessageSource

public abstract class ExtensionComponent<T extends org.mule.runtime.api.meta.model.ComponentModel>
extends org.mule.runtime.api.component.AbstractComponent
implements MuleContextAware, ErrorMappingsAware, org.mule.runtime.api.metadata.MetadataKeyProvider, org.mule.runtime.api.metadata.MetadataProvider<T>, org.mule.runtime.extension.api.values.ComponentValueProvider, org.mule.runtime.api.lifecycle.Lifecycle

Class that groups all the common behaviour between different extension's components, like OperationMessageProcessor and ExtensionMessageSource.

Provides capabilities of Metadata resolution and configuration validation.

Since:

4.0

Nested Class Summary

Nested classes/interfaces inherited from interface org.mule.runtime.api.component.Component

org.mule.runtime.api.component.Component.Annotations

Field Summary

Fields

Modifier and Type	Field and Description
protected MetadataCacheIdGenerator<org.mule.runtime.ast.api.ComponentAst>	cacheIdGenerator
protected ClassLoader	classLoader
protected org.mule.runtime.api.component.location.ConfigurationComponentLocator	componentLocator
protected T	componentModel
protected ConnectionManagerAdapter	connectionManager
protected CursorProviderFactory	cursorProviderFactory
protected org.mule.runtime.api.exception.ErrorTypeRepository	errorTypeRepository
protected ExpressionManager	expressionManager
protected ExtensionManager	extensionManager
protected MuleMetadataService	metadataService
protected MuleContext	muleContext
protected ReflectionCache	reflectionCache
protected StreamingManager	streamingManager
protected TransactionFactoryLocator	transactionFactoryLocator

Fields inherited from class org.mule.runtime.api.component.AbstractComponent

ANNOTATION_NAME, LOCATION_KEY, ROOT_CONTAINER_NAME_KEY

Fields inherited from interface org.mule.runtime.api.component.Component

ANNOTATIONS_PROPERTY_NAME, NS_MULE_DOCUMENTATION, NS_MULE_PARSER_METADATA

Fields inherited from interface org.mule.runtime.api.lifecycle.Initialisable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Startable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Stoppable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Disposable

PHASE_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ExtensionComponent(org.mule.runtime.api.meta.model.ExtensionModel extensionModel, T componentModel, org.mule.runtime.extension.api.runtime.config.ConfigurationProvider configurationProvider, CursorProviderFactory cursorProviderFactory, ExtensionManager extensionManager)

Method Summary

Modifier and Type	Method and Description
void	dispose() Delegates into doDispose() making sure that it executes using the extension's class loader
protected abstract void	doDispose() Implementors will use this method to perform their own disposing logic
protected abstract void	doInitialise() Implementors will use this method to perform their own initialisation logic
protected abstract void	doStart() Implementors will use this method to perform their own starting logic
protected abstract void	doStop() Implementors will use this method to perform their own stopping logic
protected Optional<org.mule.runtime.extension.api.runtime.config.ConfigurationInstance>	getConfiguration(CoreEvent event)
protected org.mule.runtime.extension.api.runtime.config.ConfigurationProvider	getConfigurationProvider()
protected CursorProviderFactory	getCursorProviderFactory()
List<ErrorMapping>	getErrorMappings()
org.mule.runtime.api.meta.model.ExtensionModel	getExtensionModel()
org.mule.runtime.api.metadata.resolving.MetadataResult<org.mule.runtime.api.metadata.descriptor.ComponentMetadataDescriptor<T>>	getMetadata()
org.mule.runtime.api.metadata.resolving.MetadataResult<org.mule.runtime.api.metadata.descriptor.ComponentMetadataDescriptor<T>>	getMetadata(org.mule.runtime.api.metadata.MetadataKey key)
org.mule.runtime.api.metadata.resolving.MetadataResult<org.mule.runtime.api.metadata.MetadataKeysContainer>	getMetadataKeys()
List<org.mule.runtime.api.meta.model.parameter.ValueProviderModel>	getModels(String providerName)
protected abstract ParameterValueResolver	getParameterValueResolver()
protected Optional<org.mule.runtime.extension.api.runtime.config.ConfigurationInstance>	getStaticConfiguration() Similar to getConfiguration(CoreEvent) but only works if the configurationProvider is static.
Set<org.mule.runtime.api.value.Value>	getValues(String parameterName)
void	initialise() Makes sure that the operation is valid by invoking validateOperationConfiguration(ConfigurationProvider) and then delegates on doInitialise() for custom initialisation
protected boolean	requiresConfig()
protected <R> org.mule.runtime.api.metadata.resolving.MetadataResult<R>	runWithMetadataContext(Function<org.mule.runtime.api.metadata.MetadataContext,org.mule.runtime.api.metadata.resolving.MetadataResult<R>> contextConsumer)
void	setAnnotations(Map<QName,Object> newAnnotations)
void	setCacheIdGeneratorFactory(MetadataCacheIdGeneratorFactory<org.mule.runtime.ast.api.ComponentAst> cacheIdGeneratorFactory)
void	setComponentLocator(org.mule.runtime.api.component.location.ConfigurationComponentLocator componentLocator)
void	setMuleContext(MuleContext context)
void	start() Delegates into doStart() making sure that it executes using the extension's class loader
void	stop() Delegates into doStop() making sure that it executes using the extension's class loader
protected boolean	usesDynamicConfiguration()
protected abstract void	validateOperationConfiguration(org.mule.runtime.extension.api.runtime.config.ConfigurationProvider configurationProvider) Validates that the configuration returned by the configurationProvider is compatible with the associated ComponentModel

Methods inherited from class org.mule.runtime.api.component.AbstractComponent

getAnnotation, getAnnotations, getDslSource, getIdentifier, getLocation, getRepresentation, getRootContainerLocation, initRootContainerName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.runtime.api.component.Component

getAnnotation, getAnnotations, getDslSource, getIdentifier, getLocation, getRepresentation, getRootContainerLocation

Field Detail

extensionManager

protected final ExtensionManager extensionManager

classLoader

protected final ClassLoader classLoader

componentModel

protected final T extends org.mule.runtime.api.meta.model.ComponentModel componentModel

cursorProviderFactory

protected CursorProviderFactory cursorProviderFactory

muleContext

protected MuleContext muleContext

expressionManager

@Inject
protected ExpressionManager expressionManager

connectionManager

@Inject
protected ConnectionManagerAdapter connectionManager

streamingManager

@Inject
protected StreamingManager streamingManager

transactionFactoryLocator

@Inject
protected TransactionFactoryLocator transactionFactoryLocator

metadataService

@Inject
protected MuleMetadataService metadataService

componentLocator

protected org.mule.runtime.api.component.location.ConfigurationComponentLocator componentLocator

reflectionCache

@Inject
protected ReflectionCache reflectionCache

errorTypeRepository

@Inject
protected org.mule.runtime.api.exception.ErrorTypeRepository errorTypeRepository

cacheIdGenerator

protected MetadataCacheIdGenerator<org.mule.runtime.ast.api.ComponentAst> cacheIdGenerator

Constructor Detail

ExtensionComponent

protected ExtensionComponent(org.mule.runtime.api.meta.model.ExtensionModel extensionModel,
                             T componentModel,
                             org.mule.runtime.extension.api.runtime.config.ConfigurationProvider configurationProvider,
                             CursorProviderFactory cursorProviderFactory,
                             ExtensionManager extensionManager)

Method Detail

initialise

public final void initialise()
                      throws org.mule.runtime.api.lifecycle.InitialisationException

Makes sure that the operation is valid by invoking validateOperationConfiguration(ConfigurationProvider) and then delegates on doInitialise() for custom initialisation

Specified by:

initialise in interface org.mule.runtime.api.lifecycle.Initialisable

Throws:

org.mule.runtime.api.lifecycle.InitialisationException - if a fatal error occurs causing the Mule instance to shutdown

start

public final void start()
                 throws org.mule.runtime.api.exception.MuleException

Delegates into doStart() making sure that it executes using the extension's class loader

Specified by:

start in interface org.mule.runtime.api.lifecycle.Startable

Throws:

org.mule.runtime.api.exception.MuleException - if the phase couldn't be applied

stop

public final void stop()
                throws org.mule.runtime.api.exception.MuleException

Delegates into doStop() making sure that it executes using the extension's class loader

Specified by:

stop in interface org.mule.runtime.api.lifecycle.Stoppable

Throws:

org.mule.runtime.api.exception.MuleException - if the phase couldn't be applied

dispose

public final void dispose()

Delegates into doDispose() making sure that it executes using the extension's class loader

Specified by:

dispose in interface org.mule.runtime.api.lifecycle.Disposable

doInitialise

protected abstract void doInitialise()
                              throws org.mule.runtime.api.lifecycle.InitialisationException

Implementors will use this method to perform their own initialisation logic

Throws:

org.mule.runtime.api.lifecycle.InitialisationException - if a fatal error occurs causing the Mule instance to shutdown

doStart

protected abstract void doStart()
                         throws org.mule.runtime.api.exception.MuleException

Implementors will use this method to perform their own starting logic

Throws:

org.mule.runtime.api.exception.MuleException - if the component could not start

doStop

protected abstract void doStop()
                        throws org.mule.runtime.api.exception.MuleException

Implementors will use this method to perform their own stopping logic

Throws:

org.mule.runtime.api.exception.MuleException - if the component could not stop

doDispose

protected abstract void doDispose()

Implementors will use this method to perform their own disposing logic

validateOperationConfiguration

protected abstract void validateOperationConfiguration(org.mule.runtime.extension.api.runtime.config.ConfigurationProvider configurationProvider)

Validates that the configuration returned by the configurationProvider is compatible with the associated ComponentModel

Parameters:

configurationProvider -

setMuleContext

public void setMuleContext(MuleContext context)

Specified by:

setMuleContext in interface MuleContextAware

getMetadataKeys

public org.mule.runtime.api.metadata.resolving.MetadataResult<org.mule.runtime.api.metadata.MetadataKeysContainer> getMetadataKeys()
                                                                                                                            throws org.mule.runtime.api.metadata.MetadataResolvingException

Specified by:

getMetadataKeys in interface org.mule.runtime.api.metadata.MetadataKeyProvider

Throws:

org.mule.runtime.api.metadata.MetadataResolvingException

getMetadata

public org.mule.runtime.api.metadata.resolving.MetadataResult<org.mule.runtime.api.metadata.descriptor.ComponentMetadataDescriptor<T>> getMetadata()
                                                                                                                                            throws org.mule.runtime.api.metadata.MetadataResolvingException

Specified by:

getMetadata in interface org.mule.runtime.api.metadata.MetadataProvider<T extends org.mule.runtime.api.meta.model.ComponentModel>

Throws:

org.mule.runtime.api.metadata.MetadataResolvingException

getMetadata

public org.mule.runtime.api.metadata.resolving.MetadataResult<org.mule.runtime.api.metadata.descriptor.ComponentMetadataDescriptor<T>> getMetadata(org.mule.runtime.api.metadata.MetadataKey key)
                                                                                                                                            throws org.mule.runtime.api.metadata.MetadataResolvingException

Specified by:

getMetadata in interface org.mule.runtime.api.metadata.MetadataProvider<T extends org.mule.runtime.api.meta.model.ComponentModel>

Throws:

org.mule.runtime.api.metadata.MetadataResolvingException

getValues

public Set<org.mule.runtime.api.value.Value> getValues(String parameterName)
                                                throws org.mule.runtime.extension.api.values.ValueResolvingException

Specified by:

getValues in interface org.mule.runtime.extension.api.values.ComponentValueProvider

Throws:

org.mule.runtime.extension.api.values.ValueResolvingException

runWithMetadataContext

protected <R> org.mule.runtime.api.metadata.resolving.MetadataResult<R> runWithMetadataContext(Function<org.mule.runtime.api.metadata.MetadataContext,org.mule.runtime.api.metadata.resolving.MetadataResult<R>> contextConsumer)
                                                                                        throws org.mule.runtime.api.metadata.MetadataResolvingException,
                                                                                               org.mule.runtime.api.connection.ConnectionException

Throws:

org.mule.runtime.api.metadata.MetadataResolvingException

org.mule.runtime.api.connection.ConnectionException

getConfiguration

protected Optional<org.mule.runtime.extension.api.runtime.config.ConfigurationInstance> getConfiguration(CoreEvent event)

Parameters:

event - a CoreEvent

Returns:

a configuration instance for the current component with a given CoreEvent

requiresConfig

protected boolean requiresConfig()

getConfigurationProvider

protected org.mule.runtime.extension.api.runtime.config.ConfigurationProvider getConfigurationProvider()

usesDynamicConfiguration

protected boolean usesDynamicConfiguration()

getStaticConfiguration

protected Optional<org.mule.runtime.extension.api.runtime.config.ConfigurationInstance> getStaticConfiguration()

Similar to getConfiguration(CoreEvent) but only works if the configurationProvider is static. Otherwise, returns an empty value.

getCursorProviderFactory

protected CursorProviderFactory getCursorProviderFactory()

getParameterValueResolver

protected abstract ParameterValueResolver getParameterValueResolver()

getExtensionModel

public org.mule.runtime.api.meta.model.ExtensionModel getExtensionModel()

Returns:

the extension model where the component has been defined.

getModels

public List<org.mule.runtime.api.meta.model.parameter.ValueProviderModel> getModels(String providerName)

Specified by:

getModels in interface org.mule.runtime.extension.api.values.ComponentValueProvider

setCacheIdGeneratorFactory

@Inject
public void setCacheIdGeneratorFactory(MetadataCacheIdGeneratorFactory<org.mule.runtime.ast.api.ComponentAst> cacheIdGeneratorFactory)

setComponentLocator

@Inject
public void setComponentLocator(org.mule.runtime.api.component.location.ConfigurationComponentLocator componentLocator)

getErrorMappings

public List<ErrorMapping> getErrorMappings()

Specified by:

getErrorMappings in interface ErrorMappingsAware

setAnnotations

public void setAnnotations(Map<QName,Object> newAnnotations)

Specified by:

setAnnotations in interface org.mule.runtime.api.component.Component

Overrides:

setAnnotations in class org.mule.runtime.api.component.AbstractComponent