org.mule.umo.manager
Interface UMOManager

All Superinterfaces:
Disposable, Lifecycle, Startable, Stoppable
All Known Implementing Classes:
MuleManager

public interface UMOManager
extends Lifecycle

UMOManager maintains and provides services for a UMO server instance.


Method Summary
 void fireNotification(UMOServerNotification notification)
          Fires a server notification to all regiistered listeners
 Map getConnectors()
          Gets an unmodifiable collection of Connectors registered with the UMOManager
 UMOContainerContext getContainerContext()
          associates a Dependency Injector container with Mule.
 Map getEndpointIdentifiers()
          Deprecated. endpoint-identifiers have been deprecated in favor of global-endpoints
 Map getEndpoints()
          Gets an unmodifiable collection of endpoints registered with the UMOManager
 String getId()
          Gets the unique Id for this Manager instance.
 Map getModels()
          The model used for managing components for this server
 Map getProperties()
          Gets all properties associated with the UMOManager
 Object getProperty(Object key)
          Getter for the envionment parameters declared in the mule-config.xml
 QueueManager getQueueManager()
          Gets the queue manager used by mule for queuing events.
 UMOSecurityManager 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 long date when the server was started
 TransactionManager getTransactionManager()
          Returns the Jta transaction manager used by this Mule server instance.
 Map getTransformers()
          Gets an unmodifiable collection of transformers registered with the UMOManager
 UMOWorkManager getWorkManager()
          Obtains a workManager instance that can be used to schedule work in a thread pool.
 boolean isInitialised()
          Determines if the server has been initialised
 boolean isStarted()
          Determines if the server has been started
 UMOAgent lookupAgent(String name)
          Will find a registered agent using its name, which is unique for all registered agents
 UMOConnector lookupConnector(String logicalName)
           
 UMOEndpoint lookupEndpoint(String logicalName)
          Getter for a global endpoint.
 String lookupEndpointIdentifier(String logicalName, String defaultName)
          Deprecated. endpoint-identifiers have been deprecated in favor of global-endpoints
 UMOInterceptorStack lookupInterceptorStack(String name)
          Retrieves a configured interceptor stack.
 UMOModel lookupModel(String name)
          The model used for managing components for this server
 UMOTransformer lookupTransformer(String name)
          Getter method for a Transformer.
 void registerAgent(UMOAgent agent)
          Will register an agent object on this model.
 void registerConnector(UMOConnector connector)
          Registers a UMOConnector with the MuleManager.
 void registerEndpoint(UMOEndpoint endpoint)
          Registers a shared/global endpoint with the MuleManager.
 void registerEndpointIdentifier(String logicalName, String endpoint)
          Deprecated. endpoint-identifiers have been deprecated in favor of global-endpoints
 void registerInterceptorStack(String name, UMOInterceptorStack stack)
          registers a interceptor stack list that can be referenced by other components
 void registerListener(UMOServerNotificationListener l)
          Registers an intenal server event listener.
 void registerListener(UMOServerNotificationListener l, String resourceIdentifier)
          Registers an intenal server event listener.
 void registerModel(UMOModel model)
           
 void registerTransformer(UMOTransformer transformer)
          Registers a transformer with the MuleManager.
 void setContainerContext(UMOContainerContext context)
          associates a Dependency Injector container with Mule.
 void setId(String id)
          Sets the unique Id for this Manager instance.
 void setProperty(Object key, Object value)
          Sets an Mule environment parameter in the MuleManager.
 void setQueueManager(QueueManager queueManager)
          Sets the queue manager used by mule for queuing events.
 void setSecurityManager(UMOSecurityManager 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)
          Sets the Jta Transaction Manager to use with this Mule server instance
 void setWorkManager(UMOWorkManager workManager)
          Sets a workManager instance that can be used to schedule work in a thread pool.
 UMOAgent unregisterAgent(String name)
          Removes and destroys a registered agent
 void unregisterConnector(String connectorName)
          UnRegisters a UMOConnector with the MuleManager.
 void unregisterEndpoint(String endpointName)
          unregisters a shared/global endpoint with the MuleManager.
 void unregisterEndpointIdentifier(String logicalName)
          Deprecated. endpoint-identifiers have been deprecated in favor of global-endpoints
 void unregisterListener(UMOServerNotificationListener l)
          Unregisters a previously registered listener.
 void unregisterModel(String name)
           
 void unregisterTransformer(String transformerName)
          UnRegisters a transformer with the MuleManager.
 
Methods inherited from interface org.mule.umo.lifecycle.Startable
start
 
Methods inherited from interface org.mule.umo.lifecycle.Stoppable
stop
 
Methods inherited from interface org.mule.umo.lifecycle.Disposable
dispose
 

Method Detail

getProperty

Object getProperty(Object key)
Getter for the envionment parameters declared in the mule-config.xml

Parameters:
key - the propery name
Returns:
the property value

lookupConnector

UMOConnector lookupConnector(String logicalName)
Parameters:
logicalName - the name of the endpoint to retrieve
Returns:
the endpoint instnace if it exists

lookupEndpointIdentifier

String lookupEndpointIdentifier(String logicalName,
                                String defaultName)
Deprecated. endpoint-identifiers have been deprecated in favor of global-endpoints

Parameters:
logicalName - the logical mapping name for an endpointUri i.e. rather than specifing an endpointUri to be someone@my.com you can supply a more descriptive name such as The System Administrator
defaultName -
Returns:
the actual endpointUri value or null if it is not found

lookupEndpoint

UMOEndpoint lookupEndpoint(String logicalName)
Getter for a global endpoint. Any endpoints returned from this method can be modified, as they are clones of the registered endpoints.

Parameters:
logicalName - the name of the endpoint
Returns:
the UMOEndpoint or null if it doesn't exist

lookupTransformer

UMOTransformer lookupTransformer(String name)
Getter method for a Transformer.

Parameters:
name - the name of the transformer
Returns:
the Transformer instance if found, otherwise null

registerConnector

void registerConnector(UMOConnector connector)
                       throws UMOException
Registers a UMOConnector with the MuleManager.

Parameters:
connector - the UMOConnector to register
Throws:
UMOException

unregisterConnector

void unregisterConnector(String connectorName)
                         throws UMOException
UnRegisters a UMOConnector with the MuleManager.

Parameters:
connectorName - the name of the UMOConnector to unregister
Throws:
UMOException

registerEndpointIdentifier

void registerEndpointIdentifier(String logicalName,
                                String endpoint)
                                throws InitialisationException
Deprecated. endpoint-identifiers have been deprecated in favor of global-endpoints

Registers an endpointUri with a logical name

Parameters:
logicalName - the name of the endpointUri
endpoint - the physical endpointUri value
Throws:
InitialisationException

unregisterEndpointIdentifier

void unregisterEndpointIdentifier(String logicalName)
Deprecated. endpoint-identifiers have been deprecated in favor of global-endpoints

unregisters an endpointUri with a logical name

Parameters:
logicalName - the name of the endpointUri

registerEndpoint

void registerEndpoint(UMOEndpoint endpoint)
                      throws InitialisationException
Registers a shared/global endpoint with the MuleManager.

Parameters:
endpoint - the UMOEndpoint to register.
Throws:
InitialisationException

unregisterEndpoint

void unregisterEndpoint(String endpointName)
unregisters a shared/global endpoint with the MuleManager.

Parameters:
endpointName - the UMOEndpoint name to unregister.

registerTransformer

void registerTransformer(UMOTransformer transformer)
                         throws InitialisationException
Registers a transformer with the MuleManager.

Parameters:
transformer - the UMOTransformer to register.
Throws:
InitialisationException

unregisterTransformer

void unregisterTransformer(String transformerName)
UnRegisters a transformer with the MuleManager.

Parameters:
transformerName - the UMOTransformer name to register.

setProperty

void setProperty(Object key,
                 Object value)
Sets an Mule environment parameter in the MuleManager.

Parameters:
key - the parameter name
value - the parameter value

setTransactionManager

void setTransactionManager(TransactionManager manager)
                           throws Exception
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

lookupModel

UMOModel lookupModel(String name)
The model used for managing components for this server

Returns:
The model used for managing components for this server

registerModel

void registerModel(UMOModel model)
                   throws UMOException
Throws:
UMOException

unregisterModel

void unregisterModel(String name)

getModels

Map getModels()
The model used for managing components for this server

Returns:
The models set on this manager instance

getProperties

Map getProperties()
Gets all properties associated with the UMOManager

Returns:
a map of properties on the Manager

getConnectors

Map getConnectors()
Gets an unmodifiable collection of Connectors registered with the UMOManager

Returns:
All connectors registered on the Manager
See Also:
UMOConnector

getEndpointIdentifiers

Map getEndpointIdentifiers()
Deprecated. endpoint-identifiers have been deprecated in favor of global-endpoints

Gets an unmodifiable collection of endpoints registered with the UMOManager

Returns:
All endpoints registered on the Manager

getEndpoints

Map getEndpoints()
Gets an unmodifiable collection of endpoints registered with the UMOManager

Returns:
All endpoints registered on the Manager
See Also:
UMOEndpoint

getTransformers

Map getTransformers()
Gets an unmodifiable collection of transformers registered with the UMOManager

Returns:
All transformers registered on the Manager
See Also:
UMOTransformer

registerInterceptorStack

void registerInterceptorStack(String name,
                              UMOInterceptorStack stack)
registers a interceptor stack list that can be referenced by other components

Parameters:
name - the referenceable name for this stack
stack - a List of interceptors
See Also:
UMOInterceptor

lookupInterceptorStack

UMOInterceptorStack lookupInterceptorStack(String name)
Retrieves a configured interceptor stack.

Parameters:
name - the name of the stack
Returns:
the interceptor stack requested or null if there wasn't one configured for the given name

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

getStartDate

long getStartDate()
Returns the long date when the server was started

Returns:
the long date when the server was started

registerAgent

void registerAgent(UMOAgent agent)
                   throws UMOException
Will register an agent object on this model. Agents can be server plugins such as Jms support

Parameters:
agent -
Throws:
UMOException

lookupAgent

UMOAgent lookupAgent(String name)
Will find a registered agent using its name, which is unique for all registered agents

Parameters:
name - the name of the Agent to find
Returns:
the Agent or null if there is not agent registered with the given name

unregisterAgent

UMOAgent unregisterAgent(String name)
                         throws UMOException
Removes and destroys a registered agent

Parameters:
name - the agent name
Returns:
the destroyed agent or null if the agent doesn't exist
Throws:
UMOException

registerListener

void registerListener(UMOServerNotificationListener 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 UMOEvent (although there is nothing stopping the implementation of this class triggering listeners when a UMOEvent 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(UMOServerNotificationListener 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 UMOEvent (although there is nothing stopping the implementation of this class triggering listeners when a UMOEvent 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 component if the listener was a ComponentNotificationListener
Throws:
NotificationException

unregisterListener

void unregisterListener(UMOServerNotificationListener 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(UMOServerNotification notification)
Fires a server notification to all regiistered listeners

Parameters:
notification - the notification to fire

setContainerContext

void setContainerContext(UMOContainerContext context)
                         throws UMOException
associates a Dependency Injector container with Mule. This can be used to integrate container managed resources with Mule resources

Parameters:
context - a Container context to use.
Throws:
UMOException

getContainerContext

UMOContainerContext getContainerContext()
associates a Dependency Injector container with Mule. This can be used to integrate container managed resources with Mule resources

Returns:
the container associated with the Manager

setId

void setId(String id)
Sets the unique Id for this Manager instance. this id can be used to assign an identy to the manager so it can be identified in a network of Mule nodes

Parameters:
id - the unique Id for this manager in the network

getId

String getId()
Gets the unique Id for this Manager instance. this id can be used to assign an identy to the manager so it can be identified in a network of Mule nodes

Returns:
the unique Id for this manager in the network

setSecurityManager

void setSecurityManager(UMOSecurityManager securityManager)
                        throws InitialisationException
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

UMOSecurityManager 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

getWorkManager

UMOWorkManager getWorkManager()
Obtains a workManager instance that can be used to schedule work in a thread pool. This will be used primarially by UMOAgents wanting to schedule work. This work Manager must never be used by provider implementations as they have their own workManager accible on the connector.

Returns:
a workManager instance used by the current MuleManager

setWorkManager

void setWorkManager(UMOWorkManager workManager)
Sets a workManager instance that can be used to schedule work in a thread pool. This will be used primarially by UMOAgents wanting to schedule work. This work Manager must never be used by provider implementations as they have their own workManager accible on the connector.

Parameters:
workManager - the workManager instance used by the current MuleManager

setQueueManager

void setQueueManager(QueueManager queueManager)
Sets the queue manager used by mule for queuing events. This is used by both components and vm provider.

Parameters:
queueManager -

getQueueManager

QueueManager getQueueManager()
Gets the queue manager used by mule for queuing events. This is used by both components and vm provider.

Returns:


Copyright © 2003-2008 MuleSource, Inc.. All Rights Reserved.