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

Class ExtensionMessageSource

java.lang.Object

org.mule.runtime.api.component.AbstractComponent

org.mule.runtime.module.extension.internal.runtime.ExtensionComponent<org.mule.runtime.api.meta.model.source.SourceModel>

org.mule.runtime.module.extension.internal.runtime.source.ExtensionMessageSource

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<org.mule.runtime.api.meta.model.source.SourceModel>, MuleContextAware, LifecycleStateEnabled, MessageSource, ErrorMappingsAware, ExceptionCallback<org.mule.runtime.api.connection.ConnectionException>, org.mule.runtime.extension.api.runtime.config.ConfiguredComponent, org.mule.runtime.extension.api.runtime.source.ParameterizedSource, org.mule.runtime.extension.api.values.ComponentValueProvider

public class ExtensionMessageSource
extends ExtensionComponent<org.mule.runtime.api.meta.model.source.SourceModel>
implements MessageSource, ExceptionCallback<org.mule.runtime.api.connection.ConnectionException>, org.mule.runtime.extension.api.runtime.source.ParameterizedSource, org.mule.runtime.extension.api.runtime.config.ConfiguredComponent, LifecycleStateEnabled

A MessageSource which connects the Extensions API with the Mule runtime by connecting a Source with a flow represented by a messageProcessor

Since:

4.0

Nested Class Summary

Nested classes/interfaces inherited from interface org.mule.runtime.core.api.source.MessageSource

MessageSource.BackPressureStrategy

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

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

Field Summary

Fields inherited from class org.mule.runtime.module.extension.internal.runtime.ExtensionComponent

cacheIdGenerator, classLoader, componentLocator, componentModel, connectionManager, cursorProviderFactory, errorTypeRepository, extensionManager, metadataService, muleContext, streamingManager, 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

Constructor and Description

ExtensionMessageSource(org.mule.runtime.api.meta.model.ExtensionModel extensionModel, org.mule.runtime.api.meta.model.source.SourceModel sourceModel, SourceAdapterFactory sourceAdapterFactory, org.mule.runtime.extension.api.runtime.config.ConfigurationProvider configurationProvider, boolean primaryNodeOnly, RetryPolicyTemplate retryPolicyTemplate, CursorProviderFactory cursorProviderFactory, MessageSource.BackPressureStrategy backPressureStrategy, ExtensionManager managerAdapter, org.mule.runtime.api.notification.NotificationDispatcher notificationDispatcher, SingleResourceTransactionFactoryManager transactionFactoryManager, String applicationName)

Method Summary

Modifier and Type	Method and Description
void	doDispose() Implementors will use this method to perform their own disposing logic
protected void	doInitialise() Implementors will use this method to perform their own initialisation logic
void	doStart() Implementors will use this method to perform their own starting logic
void	doStop() Implementors will use this method to perform their own stopping logic
MessageSource.BackPressureStrategy	getBackPressureStrategy()
Optional<org.mule.runtime.extension.api.runtime.config.ConfigurationInstance>	getConfigurationInstance()
Map<String,Object>	getInitialisationParameters()
LifecycleState	getLifecycleState()
protected ParameterValueResolver	getParameterValueResolver()
void	onException(org.mule.runtime.api.connection.ConnectionException exception)
void	setListener(Processor listener)
String	toString()
protected void	validateOperationConfiguration(org.mule.runtime.extension.api.runtime.config.ConfigurationProvider configurationProvider) Validates if the current source is valid for the set configuration.

Methods inherited from class org.mule.runtime.module.extension.internal.runtime.ExtensionComponent

dispose, getConfiguration, getConfigurationProvider, getCursorProviderFactory, getErrorMappings, getExtensionModel, getMetadata, getMetadata, getMetadataKeys, getModels, getStaticConfiguration, getValues, initialise, requiresConfig, runWithMetadataContext, setAnnotations, setCacheIdGeneratorFactory, setComponentLocator, setMuleContext, start, stop, usesDynamicConfiguration

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, wait, wait, wait

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

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

Constructor Detail

ExtensionMessageSource

public ExtensionMessageSource(org.mule.runtime.api.meta.model.ExtensionModel extensionModel,
                              org.mule.runtime.api.meta.model.source.SourceModel sourceModel,
                              SourceAdapterFactory sourceAdapterFactory,
                              org.mule.runtime.extension.api.runtime.config.ConfigurationProvider configurationProvider,
                              boolean primaryNodeOnly,
                              RetryPolicyTemplate retryPolicyTemplate,
                              CursorProviderFactory cursorProviderFactory,
                              MessageSource.BackPressureStrategy backPressureStrategy,
                              ExtensionManager managerAdapter,
                              org.mule.runtime.api.notification.NotificationDispatcher notificationDispatcher,
                              SingleResourceTransactionFactoryManager transactionFactoryManager,
                              String applicationName)

Method Detail

getConfigurationInstance

public Optional<org.mule.runtime.extension.api.runtime.config.ConfigurationInstance> getConfigurationInstance()

Specified by:

getConfigurationInstance in interface org.mule.runtime.extension.api.runtime.config.ConfiguredComponent

onException

public void onException(org.mule.runtime.api.connection.ConnectionException exception)

Specified by:

onException in interface ExceptionCallback<org.mule.runtime.api.connection.ConnectionException>

doStart

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

Description copied from class: ExtensionComponent

Implementors will use this method to perform their own starting logic

Specified by:

doStart in class ExtensionComponent<org.mule.runtime.api.meta.model.source.SourceModel>

Throws:

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

doStop

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

Description copied from class: ExtensionComponent

Implementors will use this method to perform their own stopping logic

Specified by:

doStop in class ExtensionComponent<org.mule.runtime.api.meta.model.source.SourceModel>

Throws:

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

doDispose

public void doDispose()

Description copied from class: ExtensionComponent

Implementors will use this method to perform their own disposing logic

Specified by:

doDispose in class ExtensionComponent<org.mule.runtime.api.meta.model.source.SourceModel>

setListener

public void setListener(Processor listener)

Specified by:

setListener in interface MessageSource

validateOperationConfiguration

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

Validates if the current source is valid for the set configuration. In case that the validation fails, the method will throw a IllegalSourceException

Specified by:

validateOperationConfiguration in class ExtensionComponent<org.mule.runtime.api.meta.model.source.SourceModel>

getParameterValueResolver

protected ParameterValueResolver getParameterValueResolver()

Specified by:

getParameterValueResolver in class ExtensionComponent<org.mule.runtime.api.meta.model.source.SourceModel>

doInitialise

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

Description copied from class: ExtensionComponent

Implementors will use this method to perform their own initialisation logic

Specified by:

doInitialise in class ExtensionComponent<org.mule.runtime.api.meta.model.source.SourceModel>

Throws:

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

getInitialisationParameters

public Map<String,Object> getInitialisationParameters()

Specified by:

getInitialisationParameters in interface org.mule.runtime.extension.api.runtime.source.ParameterizedSource

getBackPressureStrategy

public MessageSource.BackPressureStrategy getBackPressureStrategy()

Specified by:

getBackPressureStrategy in interface MessageSource

getLifecycleState

public LifecycleState getLifecycleState()

Specified by:

getLifecycleState in interface LifecycleStateEnabled

toString

public String toString()

Overrides:

toString in class Object