org.mule.runtime.core.api

Interface MuleContext

All Superinterfaces:

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

All Known Implementing Classes:

DefaultMuleContext

public interface MuleContext
extends org.mule.runtime.api.lifecycle.Lifecycle

Field Summary

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

Method Summary

Modifier and Type	Method and Description
void	addRegistry(Registry registry) Deprecated. as of 3.7.0. This will be removed in Mule 4.0
void	fireNotification(ServerNotification notification) Fires a server notification to all regiistered listeners
ArtifactType	getArtifactType() The ArtifactType indicating if this configuration object is for an application or a domain.
MuleClient	getClient()
String	getClusterId()
int	getClusterNodeId()
MuleConfiguration	getConfiguration()
Map<QName,Set<Object>>	getConfigurationAnnotations() Return all annotations seen in the configuration
ConfigurationComponentLocator	getConfigurationComponentLocator()
org.mule.runtime.api.config.custom.CustomizationService	getCustomizationService() Provides access to a CustomizationService to change the default services provided by the MuleContext.
DataTypeConversionResolver	getDataTypeConverterResolver()
MessagingExceptionHandler	getDefaultErrorHandler()
ErrorTypeLocator	getErrorTypeLocator()
ErrorTypeRepository	getErrorTypeRepository()
Collection<ExceptionContextProvider>	getExceptionContextProviders()
SystemExceptionHandler	getExceptionListener()
ClassLoader	getExecutionClassLoader()
ExtendedExpressionManager	getExpressionManager()
ExtensionManager	getExtensionManager()
FlowTraceManager	getFlowTraceManager()
String	getId()
Injector	getInjector() Returns a Injector capable of injecting dependencies into objects
LifecycleManager	getLifecycleManager()
org.mule.runtime.api.lock.LockFactory	getLockFactory() Factory for creating locks for synchronizing mule components.
ServerNotificationManager	getNotificationManager()
ObjectSerializer	getObjectSerializer() The instance of ObjectSerializer to be used to serialize/deserealize objects
org.mule.runtime.api.store.ObjectStoreManager	getObjectStoreManager()
ProcessorInterceptorProvider	getProcessorInterceptorManager()
ProcessingTimeWatcher	getProcessorTimeWatcher()
QueueManager	getQueueManager() Gets the queue manager used by mule for queuing events.
MuleRegistry	getRegistry()
BootstrapServiceDiscoverer	getRegistryBootstrapServiceDiscoverer()
SchedulerConfig	getSchedulerBaseConfig()
SchedulerService	getSchedulerService()
SecurityManager	getSecurityManager() Gets the security manager used by this Mule instance to authenticate and authorise incoming and outgoing event traffic and service invocations
long	getStartDate() Returns the date when the server was started.
AllStatistics	getStatistics()
StreamCloserService	getStreamCloserService() Returns the configured StreamCloserService
SingleResourceTransactionFactoryManager	getTransactionFactoryManager()
TransactionManager	getTransactionManager() Returns the Jta transaction manager used by this Mule server instance.
TransformationService	getTransformationService() Gets application wide instance of TransformationService used for applying Transformer's to a Message and for obtaining different representations of the message payload.
String	getUniqueIdString() Generate a unique ID string; this will begin with the cluster node ID followed by a dash, e.g.
void	handleException(Exception e)
void	handleException(Exception e, RollbackSourceCallback rollbackMethod)
boolean	isDisposed()
boolean	isDisposing()
boolean	isInitialised() Determines if the server has been initialised
boolean	isInitialising() Determines if the server is being initialised
boolean	isPrimaryPollingInstance()
boolean	isStarted() Determines if the server has been started
boolean	isStarting()
boolean	isStopped()
boolean	isStopping()
void	registerListener(ServerNotificationListener l) Registers an intenal server event listener.
void	registerListener(ServerNotificationListener l, String resourceIdentifier) Registers an intenal server event listener.
void	removeRegistry(Registry registry) Deprecated. as of 3.7.0. This will be removed in Mule 4.0
void	setBootstrapServiceDiscoverer(BootstrapServiceDiscoverer bootstrapServiceDiscoverer) Sets application wide instance of BootstrapServiceDiscoverer
void	setExceptionListener(SystemExceptionHandler exceptionListener)
void	setExecutionClassLoader(ClassLoader cl)
void	setObjectStore(String name, ListableObjectStore<Serializable> store)
void	setQueueManager(QueueManager queueManager) Sets the queue manager used by mule for queuing events.
void	setSecurityManager(SecurityManager securityManager) Sets the security manager used by this Mule instance to authenticate and authorise incoming and outgoing event traffic and service invocations
void	setTransactionManager(TransactionManager manager) Deprecated. Use only for test cases.
void	setTransformationService(TransformationService transformationService) Sets application wide instance of TransformationService
void	unregisterListener(ServerNotificationListener l) Unregisters a previously registered listener.
boolean	waitUntilStarted(int timeout) Makes the caller wait until the MuleContext was started

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

initialise

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

start

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

stop

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

dispose

Method Detail

setTransactionManager

@Deprecated
void setTransactionManager(TransactionManager manager)
                                throws Exception

Deprecated. Use only for test cases.

Sets the Jta Transaction Manager to use with this Mule server instance

Parameters:

manager - the manager to use

Throws:

Exception

getTransactionManager

TransactionManager getTransactionManager()

Returns the Jta transaction manager used by this Mule server instance. or null if a transaction manager has not been set

Returns:

the Jta transaction manager used by this Mule server instance. or null if a transaction manager has not been set

getNotificationManager

ServerNotificationManager getNotificationManager()

isStarted

boolean isStarted()

Determines if the server has been started

Returns:

true if the server has been started

isInitialised

boolean isInitialised()

Determines if the server has been initialised

Returns:

true if the server has been initialised

isInitialising

boolean isInitialising()

Determines if the server is being initialised

Returns:

true if the server is beening initialised

isDisposed

boolean isDisposed()

isDisposing

boolean isDisposing()

registerListener

void registerListener(ServerNotificationListener l)
               throws NotificationException

Registers an intenal server event listener. The listener will be notified when a particular event happens within the server. Typically this is not an event in the same sense as an MuleEvent (although there is nothing stopping the implementation of this class triggering listeners when a MuleEvent is received).

The types of notifications fired is entirely defined by the implementation of this class

Parameters:

l - the listener to register

Throws:

NotificationException

registerListener

void registerListener(ServerNotificationListener l,
                      String resourceIdentifier)
               throws NotificationException

Registers an intenal server event listener. The listener will be notified when a particular event happens within the server. Typically this is not an event in the same sense as an MuleEvent (although there is nothing stopping the implementation of this class triggering listeners when a MuleEvent is received).

The types of notifications fired is entirely defined by the implementation of this class

Parameters:

l - the listener to register

resourceIdentifier - a particular resource name for the given type of listener For example, the resourceName could be the name of a service if the listener was a ServiceNotificationListener

Throws:

NotificationException

unregisterListener

void unregisterListener(ServerNotificationListener l)

Unregisters a previously registered listener. If the listener has not already been registered, this method should return without exception

Parameters:

l - the listener to unregister

fireNotification

void fireNotification(ServerNotification notification)

Fires a server notification to all regiistered listeners

Parameters:

notification - the notification to fire

setSecurityManager

void setSecurityManager(SecurityManager securityManager)
                 throws org.mule.runtime.api.lifecycle.InitialisationException,
                        RegistrationException

Sets the security manager used by this Mule instance to authenticate and authorise incoming and outgoing event traffic and service invocations

Parameters:

securityManager - the security manager used by this Mule instance to authenticate and authorise incoming and outgoing event traffic and service invocations

Throws:

RegistrationException

org.mule.runtime.api.lifecycle.InitialisationException

getSecurityManager

SecurityManager getSecurityManager()

Gets the security manager used by this Mule instance to authenticate and authorise incoming and outgoing event traffic and service invocations

Returns:

he security manager used by this Mule instance to authenticate and authorise incoming and outgoing event traffic and service invocations

getSchedulerService

SchedulerService getSchedulerService()

getSchedulerBaseConfig

SchedulerConfig getSchedulerBaseConfig()

setQueueManager

void setQueueManager(QueueManager queueManager)
              throws RegistrationException

Sets the queue manager used by mule for queuing events. This is used for service queues

Parameters:

queueManager -

Throws:

RegistrationException

getQueueManager

QueueManager getQueueManager()

Gets the queue manager used by mule for queuing events. This is used for service queues.

getObjectStoreManager

org.mule.runtime.api.store.ObjectStoreManager getObjectStoreManager()

getExtensionManager

ExtensionManager getExtensionManager()

getObjectSerializer

ObjectSerializer getObjectSerializer()

The instance of ObjectSerializer to be used to serialize/deserealize objects

Returns:

a ObjectSerializer

Since:

3.7.0

getStatistics

AllStatistics getStatistics()

getLifecycleManager

LifecycleManager getLifecycleManager()

getRegistry

MuleRegistry getRegistry()

getInjector

Injector getInjector()

Returns a Injector capable of injecting dependencies into objects

Returns:

a Injector

Since:

3.7.0

getConfiguration

MuleConfiguration getConfiguration()

getStreamCloserService

StreamCloserService getStreamCloserService()

Returns the configured StreamCloserService

Returns:

a StreamCloserService

Since:

3.5.0

addRegistry

@Deprecated
void addRegistry(Registry registry)

Deprecated. as of 3.7.0. This will be removed in Mule 4.0

removeRegistry

@Deprecated
void removeRegistry(Registry registry)

Deprecated. as of 3.7.0. This will be removed in Mule 4.0

getStartDate

long getStartDate()

Returns the date when the server was started.

Returns:

the date when the server was started.

setExecutionClassLoader

void setExecutionClassLoader(ClassLoader cl)

getExecutionClassLoader

ClassLoader getExecutionClassLoader()

isStopped

boolean isStopped()

isStopping

boolean isStopping()

isStarting

boolean isStarting()

getClient

MuleClient getClient()

getExceptionListener

SystemExceptionHandler getExceptionListener()

setExceptionListener

void setExceptionListener(SystemExceptionHandler exceptionListener)

setObjectStore

void setObjectStore(String name,
                    ListableObjectStore<Serializable> store)
             throws RegistrationException

Throws:

RegistrationException

handleException

void handleException(Exception e,
                     RollbackSourceCallback rollbackMethod)

handleException

void handleException(Exception e)

getClusterId

String getClusterId()

Returns:

the ID of the cluster the current instance belongs to. Returns the empty string if this instance isn't part of a cluster.

getClusterNodeId

int getClusterNodeId()

Returns:

the cluster node ID for the current instance belongs to. Returns 0 if this instance isn't part of a cluster.

isPrimaryPollingInstance

boolean isPrimaryPollingInstance()

Returns:

true if this instance in the designated poller. This will always be true unless the instance is part of a cluster.

getUniqueIdString

String getUniqueIdString()

Generate a unique ID string; this will begin with the cluster node ID followed by a dash, e.g. "3-XXXYYY"

getConfigurationAnnotations

Map<QName,Set<Object>> getConfigurationAnnotations()

Return all annotations seen in the configuration

getDefaultErrorHandler

MessagingExceptionHandler getDefaultErrorHandler()

Returns:

default exception strategy. If no default error handler was configured it returns one with a catch all element.

getTransactionFactoryManager

SingleResourceTransactionFactoryManager getTransactionFactoryManager()

Returns:

single resource transaction factory manager. Used to retrieve a transaction factory for each transactional resource (i.e jdbc DataSource, jms Connection)

getDataTypeConverterResolver

DataTypeConversionResolver getDataTypeConverterResolver()

Returns:

a non null DataTypeConversionResolver instance to resolve implicit data type conversions

getExpressionManager

ExtendedExpressionManager getExpressionManager()

Returns:

an ExtendedExpressionManager for evaluating expressions using Mule as the context

getLockFactory

org.mule.runtime.api.lock.LockFactory getLockFactory()

Factory for creating locks for synchronizing mule components. Synchronization must be done using LockFactory locks in order for mule components to work in single servers as in a cluster

Returns:

a factory for creating locks

getProcessorTimeWatcher

ProcessingTimeWatcher getProcessorTimeWatcher()

Returns:

{ProcessingTimeWatcher} used to compute processing time of finalized events

waitUntilStarted

boolean waitUntilStarted(int timeout)
                  throws InterruptedException

Makes the caller wait until the MuleContext was started

Parameters:

timeout - maximum number of milliseconds that will be waiting

Returns:

true if the context started before the timeout, false otherwise

Throws:

InterruptedException - if the current thread is interrupted while waiting

getArtifactType

ArtifactType getArtifactType()

The ArtifactType indicating if this configuration object is for an application or a domain.

getFlowTraceManager

FlowTraceManager getFlowTraceManager()

Returns:

the callbacks for notifying when a flow call from another flow is started or completed.

Since:

3.8.0

getExceptionContextProviders

Collection<ExceptionContextProvider> getExceptionContextProviders()

Returns:

the providers for additional context information for exceptions.

Since:

3.8.0

getTransformationService

TransformationService getTransformationService()

Gets application wide instance of TransformationService used for applying Transformer's to a Message and for obtaining different representations of the message payload.

Returns:

transformation service

setTransformationService

void setTransformationService(TransformationService transformationService)

Sets application wide instance of TransformationService

Parameters:

transformationService - transformation service instance

getRegistryBootstrapServiceDiscoverer

BootstrapServiceDiscoverer getRegistryBootstrapServiceDiscoverer()

Returns:

BootstrapServiceDiscoverer used to bootstrap this MuleContext

getCustomizationService

org.mule.runtime.api.config.custom.CustomizationService getCustomizationService()

Provides access to a CustomizationService to change the default services provided by the MuleContext. Any usage of this service after the MuleContext initialization will be disregarded.

Returns:

a customization service.

getId

String getId()

Returns:

a unique identifier for this context.

Since:

4.0

getErrorTypeLocator

ErrorTypeLocator getErrorTypeLocator()

Returns:

a locator for discovering ErrorTypes related to exceptions and components.

getErrorTypeRepository

ErrorTypeRepository getErrorTypeRepository()

Returns:

an error type repository to get access to the ErrorType instances of this artifact.

getProcessorInterceptorManager

ProcessorInterceptorProvider getProcessorInterceptorManager()

setBootstrapServiceDiscoverer

void setBootstrapServiceDiscoverer(BootstrapServiceDiscoverer bootstrapServiceDiscoverer)

Sets application wide instance of BootstrapServiceDiscoverer

Parameters:

bootstrapServiceDiscoverer - bootstrap service discoverer instance. Non null.

getConfigurationComponentLocator

ConfigurationComponentLocator getConfigurationComponentLocator()

Returns:

locator for accessing runtime object created by the mule configuration.