org.mule.runtime.core.api

Interface MuleContext

All Superinterfaces:

Disposable, Initialisable, Lifecycle, Startable, Stoppable

Deprecated.

MuleContext interface will be replaced in future major version of mule.

For customizing an application or domain in mule you can use the CustomizationService which can be accessed by registering a deployment listener in a server plugin.

For accessing application or domain services like getTransformationService() or getErrorTypeRepository() etc. you can use JSR330 annotations for dependency injection. In case you need to access dynamically to objects within the application/domain you can inject Registry or if you want to access configuration elements you can use ConfigurationComponentLocator.

@Deprecated
public interface MuleContext
extends 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
ArtifactType	getArtifactType() Deprecated. The ArtifactType indicating if this configuration object is for an application or a domain.
String	getClusterId() Deprecated.
int	getClusterNodeId() Deprecated.
MuleConfiguration	getConfiguration() Deprecated.
ConfigurationComponentLocator	getConfigurationComponentLocator() Deprecated.
CustomizationService	getCustomizationService() Deprecated. Provides access to a CustomizationService to change the default services provided by the MuleContext.
DataTypeConversionResolver	getDataTypeConverterResolver() Deprecated.
FlowExceptionHandler	getDefaultErrorHandler(Optional<String> rootContainerName) Deprecated.
Properties	getDeploymentProperties() Deprecated.
ErrorTypeRepository	getErrorTypeRepository() Deprecated.
default EventContextService	getEventContextService() Deprecated.
Collection<ExceptionContextProvider>	getExceptionContextProviders() Deprecated.
SystemExceptionHandler	getExceptionListener() Deprecated.
ClassLoader	getExecutionClassLoader() Deprecated.
ExtendedExpressionManager	getExpressionManager() Deprecated.
ExtensionManager	getExtensionManager() Deprecated.
FlowTraceManager	getFlowTraceManager() Deprecated.
String	getId() Deprecated.
Injector	getInjector() Deprecated. Returns a Injector capable of injecting dependencies into objects
LifecycleManager	getLifecycleManager() Deprecated.
LockFactory	getLockFactory() Deprecated. Factory for creating locks for synchronizing mule components.
ServerNotificationManager	getNotificationManager() Deprecated.
ObjectSerializer	getObjectSerializer() Deprecated. The instance of ObjectSerializer to be used to serialize/deserealize objects
ObjectStoreManager	getObjectStoreManager() Deprecated.
ProcessingTimeWatcher	getProcessorTimeWatcher() Deprecated.
QueueManager	getQueueManager() Deprecated. Gets the queue manager used by mule for queuing events.
BootstrapServiceDiscoverer	getRegistryBootstrapServiceDiscoverer() Deprecated.
SchedulerConfig	getSchedulerBaseConfig() Deprecated.
SchedulerService	getSchedulerService() Deprecated.
SecurityManager	getSecurityManager() Deprecated. Gets the security manager used by this Mule instance to authenticate and authorise incoming and outgoing event traffic and service invocations
long	getStartDate() Deprecated. Returns the date when the server was started.
AllStatistics	getStatistics() Deprecated.
StreamCloserService	getStreamCloserService() Deprecated. Returns the configured StreamCloserService
SingleResourceTransactionFactoryManager	getTransactionFactoryManager() Deprecated.
TransactionManager	getTransactionManager() Deprecated. Returns the Jta transaction manager used by this Mule server instance.
TransformationService	getTransformationService() Deprecated. Gets application wide instance of an implementation of TransformationService used for applying Transformer's to a Message and for obtaining different representations of the message payload.
String	getUniqueIdString() Deprecated. Generate a unique ID string; this will begin with the cluster node ID followed by a dash, e.g.
void	handleException(Exception e) Deprecated.
void	handleException(Exception e, RollbackSourceCallback rollbackMethod) Deprecated.
boolean	isDisposed() Deprecated.
boolean	isDisposing() Deprecated.
boolean	isInitialised() Deprecated. Determines if the server has been initialised
boolean	isInitialising() Deprecated. Determines if the server is being initialised
boolean	isPrimaryPollingInstance() Deprecated.
boolean	isStarted() Deprecated. Determines if the server has been started
boolean	isStarting() Deprecated.
boolean	isStopped() Deprecated.
boolean	isStopping() Deprecated.
void	setBootstrapServiceDiscoverer(BootstrapServiceDiscoverer bootstrapServiceDiscoverer) Deprecated. Sets application wide instance of BootstrapServiceDiscoverer
void	setExceptionListener(SystemExceptionHandler exceptionListener) Deprecated.
void	setExecutionClassLoader(ClassLoader cl) Deprecated.
void	setExtensionManager(ExtensionManager extensionManager) Deprecated. Sets artifact wide instance of ExtensionManager
void	setQueueManager(QueueManager queueManager) Deprecated. Sets the queue manager used by mule for queuing events.
void	setSecurityManager(SecurityManager securityManager) Deprecated. 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) Deprecated. Sets application wide instance of an implementation of TransformationService
boolean	waitUntilStarted(int timeout) Deprecated. Makes the caller wait until the MuleContext was started
void	withLifecycleLock(Runnable command) Deprecated. Runs a command synchronized by the lock for the context's lifecycle.

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()

Deprecated.

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()

Deprecated.

isStarted

boolean isStarted()

Deprecated.

Determines if the server has been started

Returns:

true if the server has been started

isInitialised

boolean isInitialised()

Deprecated.

Determines if the server has been initialised

Returns:

true if the server has been initialised

isInitialising

boolean isInitialising()

Deprecated.

Determines if the server is being initialised

Returns:

true if the server is beening initialised

isDisposed

boolean isDisposed()

Deprecated.

isDisposing

boolean isDisposing()

Deprecated.

setSecurityManager

void setSecurityManager(SecurityManager securityManager)
                 throws InitialisationException

Deprecated.

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:

InitialisationException

getSecurityManager

SecurityManager getSecurityManager()

Deprecated.

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()

Deprecated.

getSchedulerBaseConfig

SchedulerConfig getSchedulerBaseConfig()

Deprecated.

setQueueManager

void setQueueManager(QueueManager queueManager)

Deprecated.

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

Parameters:

queueManager -

getQueueManager

QueueManager getQueueManager()

Deprecated.

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

getObjectStoreManager

ObjectStoreManager getObjectStoreManager()

Deprecated.

getExtensionManager

ExtensionManager getExtensionManager()

Deprecated.

getObjectSerializer

ObjectSerializer getObjectSerializer()

Deprecated.

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

Returns:

a ObjectSerializer

Since:

3.7.0

getStatistics

AllStatistics getStatistics()

Deprecated.

getLifecycleManager

LifecycleManager getLifecycleManager()

Deprecated.

getInjector

Injector getInjector()

Deprecated.

Returns a Injector capable of injecting dependencies into objects

Returns:

a Injector

Since:

3.7.0

getConfiguration

MuleConfiguration getConfiguration()

Deprecated.

getStreamCloserService

StreamCloserService getStreamCloserService()

Deprecated.

Returns the configured StreamCloserService

Returns:

a StreamCloserService

Since:

3.5.0

getStartDate

long getStartDate()

Deprecated.

Returns the date when the server was started.

Returns:

the date when the server was started.

setExecutionClassLoader

void setExecutionClassLoader(ClassLoader cl)

Deprecated.

getExecutionClassLoader

ClassLoader getExecutionClassLoader()

Deprecated.

isStopped

boolean isStopped()

Deprecated.

isStopping

boolean isStopping()

Deprecated.

isStarting

boolean isStarting()

Deprecated.

withLifecycleLock

void withLifecycleLock(Runnable command)

Deprecated.

Runs a command synchronized by the lock for the context's lifecycle.

Use this method to run code that depends on this context's lifecycle state not changing while the command is running.

Parameters:

command - the command to run with the lock for this context's lifecycle taken.

getExceptionListener

SystemExceptionHandler getExceptionListener()

Deprecated.

setExceptionListener

void setExceptionListener(SystemExceptionHandler exceptionListener)

Deprecated.

handleException

void handleException(Exception e,
                     RollbackSourceCallback rollbackMethod)

Deprecated.

handleException

void handleException(Exception e)

Deprecated.

getClusterId

String getClusterId()

Deprecated.

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()

Deprecated.

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()

Deprecated.

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()

Deprecated.

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

getDefaultErrorHandler

FlowExceptionHandler getDefaultErrorHandler(Optional<String> rootContainerName)

Deprecated.

Returns:

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

getTransactionFactoryManager

SingleResourceTransactionFactoryManager getTransactionFactoryManager()

Deprecated.

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()

Deprecated.

Returns:

a non null DataTypeConversionResolver instance to resolve implicit data type conversions

getExpressionManager

ExtendedExpressionManager getExpressionManager()

Deprecated.

Returns:

an ExtendedExpressionManager for evaluating expressions using Mule as the context

getLockFactory

LockFactory getLockFactory()

Deprecated.

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()

Deprecated.

Returns:

{ProcessingTimeWatcher} used to compute processing time of finalized events

waitUntilStarted

boolean waitUntilStarted(int timeout)
                  throws InterruptedException

Deprecated.

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()

Deprecated.

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

getFlowTraceManager

FlowTraceManager getFlowTraceManager()

Deprecated.

Returns:

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

Since:

3.8.0

getEventContextService

default EventContextService getEventContextService()

Deprecated.

Returns:

the keeper of all currently active EventContexts to generate a dump on demand.

Since:

4.1

getExceptionContextProviders

Collection<ExceptionContextProvider> getExceptionContextProviders()

Deprecated.

Returns:

the providers for additional context information for exceptions.

Since:

3.8.0

getTransformationService

TransformationService getTransformationService()

Deprecated.

Gets application wide instance of an implementation 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)

Deprecated.

Sets application wide instance of an implementation of TransformationService

Parameters:

transformationService - transformation service instance

getRegistryBootstrapServiceDiscoverer

BootstrapServiceDiscoverer getRegistryBootstrapServiceDiscoverer()

Deprecated.

Returns:

BootstrapServiceDiscoverer used to bootstrap this MuleContext

getCustomizationService

CustomizationService getCustomizationService()

Deprecated.

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()

Deprecated.

Returns:

a unique identifier for this context.

Since:

4.0

getErrorTypeRepository

ErrorTypeRepository getErrorTypeRepository()

Deprecated.

Returns:

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

setBootstrapServiceDiscoverer

void setBootstrapServiceDiscoverer(BootstrapServiceDiscoverer bootstrapServiceDiscoverer)

Deprecated.

Sets application wide instance of BootstrapServiceDiscoverer

Parameters:

bootstrapServiceDiscoverer - bootstrap service discoverer instance. Non null.

getConfigurationComponentLocator

ConfigurationComponentLocator getConfigurationComponentLocator()

Deprecated.

Returns:

locator for accessing runtime object created by the mule configuration.

setExtensionManager

void setExtensionManager(ExtensionManager extensionManager)

Deprecated.

Sets artifact wide instance of ExtensionManager

Parameters:

extensionManager - manages the extensions available on the artifact. Non null.

getDeploymentProperties

Properties getDeploymentProperties()

Deprecated.

Returns:

the deployment properties.