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

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

java.lang.Object

org.mule.runtime.core.AbstractAnnotatedObject

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

All Implemented Interfaces:

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.meta.AnnotatedObject, org.mule.runtime.api.metadata.MetadataKeyProvider, org.mule.runtime.api.metadata.MetadataProvider<T>, FlowConstructAware, MuleContextAware

Direct Known Subclasses:

ExtensionMessageSource, OperationMessageProcessor

public abstract class ExtensionComponent<T extends org.mule.runtime.api.meta.model.ComponentModel<T>>
extends AbstractAnnotatedObject
implements MuleContextAware, org.mule.runtime.api.metadata.MetadataKeyProvider, org.mule.runtime.api.metadata.MetadataProvider<T>, FlowConstructAware, 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

Field Summary

Fields

Modifier and Type	Field and Description
protected ClassLoader	classLoader
protected ConnectionManagerAdapter	connectionManager
protected ExtensionManager	extensionManager
protected FlowConstruct	flowConstruct
protected MuleContext	muleContext

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

Fields inherited from interface org.mule.runtime.api.meta.AnnotatedObject

PROPERTY_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.ConfigurationProvider configurationProvider, CursorStreamProviderFactory cursorStreamProviderFactory, 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.ConfigurationInstance>	getConfiguration(Event event)
protected org.mule.runtime.extension.api.runtime.ConfigurationProvider	getConfigurationProvider()
protected CursorStreamProviderFactory	getCursorStreamProviderFactory()
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()
protected abstract ParameterValueResolver	getParameterValueResolver()
void	initialise() Makes sure that the operation is valid by invoking validateOperationConfiguration(ConfigurationProvider) and then delegates on doInitialise() for custom initialisation
protected <R> R	runWithMetadataContext(Function<org.mule.runtime.api.metadata.MetadataContext,R> metadataContextFunction)
void	setFlowConstruct(FlowConstruct flowConstruct)
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 abstract void	validateOperationConfiguration(org.mule.runtime.extension.api.runtime.ConfigurationProvider configurationProvider) Validates that the configuration returned by the configurationProvider is compatible with the associated ComponentModel

Methods inherited from class org.mule.runtime.core.AbstractAnnotatedObject

getAnnotation, getAnnotations, getIdentifier, getLocation, setAnnotations

Methods inherited from class java.lang.Object

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

Field Detail

extensionManager

protected final ExtensionManager extensionManager

classLoader

protected final ClassLoader classLoader

flowConstruct

protected FlowConstruct flowConstruct

muleContext

protected MuleContext muleContext

connectionManager

@Inject
protected ConnectionManagerAdapter connectionManager

Constructor Detail

ExtensionComponent

protected ExtensionComponent(org.mule.runtime.api.meta.model.ExtensionModel extensionModel,
                             T componentModel,
                             org.mule.runtime.extension.api.runtime.ConfigurationProvider configurationProvider,
                             CursorStreamProviderFactory cursorStreamProviderFactory,
                             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.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<T>>

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<T>>

Throws:

org.mule.runtime.api.metadata.MetadataResolvingException

setFlowConstruct

public void setFlowConstruct(FlowConstruct flowConstruct)

Specified by:

setFlowConstruct in interface FlowConstructAware

runWithMetadataContext

protected <R> R runWithMetadataContext(Function<org.mule.runtime.api.metadata.MetadataContext,R> metadataContextFunction)
                                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.ConfigurationInstance> getConfiguration(Event event)

Parameters:

event - a Event

Returns:

a configuration instance for the current component with a given Event

getCursorStreamProviderFactory

protected CursorStreamProviderFactory getCursorStreamProviderFactory()

getConfigurationProvider

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

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.