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.

Version:
$Revision: 1.2 $
Author:
Ross Mason

Method Summary
 void fireEvent(UMOServerEvent event)
          Fires a server event to all regiistered listeners
 java.util.Map getConnectors()
          Gets an unmodifiable collection of Connectors registered with the UMOManager
 UMOContainerContext getContainerContext()
          associates a Dependency Injector container with Mule.
 java.util.Map getEndpointIdentifiers()
          Gets an unmodifiable collection of endpoints registered with the UMOManager
 java.util.Map getEndpoints()
          Gets an unmodifiable collection of endpoints registered with the UMOManager
 java.lang.String getId()
          Gets the unique Id for this Manager instance.
 UMOModel getModel()
          The model used for managing components for this server
 java.util.Map getProperties()
          Gets all properties associated with the UMOManager
 java.lang.Object getProperty(java.lang.Object key)
          Getter for the envionment parameters declared in the nule-config.xml
 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.
 java.util.Map getTransformers()
          Gets an unmodifiable collection of transformers registered with the UMOManager
 boolean isInitialised()
          Determines if the server has been initialised
 boolean isStarted()
          Determines if the server has been started
 UMOConnector lookupConnector(java.lang.String logicalName)
           
 UMOEndpoint lookupEndpoint(java.lang.String logicalName)
          Getter for a global endpoint.
 java.lang.String lookupEndpointIdentifier(java.lang.String logicalName, java.lang.String defaultName)
           
 java.util.List lookupInterceptorStack(java.lang.String name)
          Retrieves a configured interceptor stack.
 UMOTransformer lookupTransformer(java.lang.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(java.lang.String logicalName, java.lang.String endpoint)
          Registers an endpointUri with a logical name
 void registerInterceptorStack(java.lang.String name, java.util.List stack)
          registers a interceptor stack list that can be referenced by other components
 void registerListener(UMOServerEventListener l)
          Registers an intenal server event listener.
 void registerTransformer(UMOTransformer transformer)
          Registers a transformer with the MuleManager.
 UMOAgent removeAgent(java.lang.String name)
          Removes and destroys a registered agent
 void setContainerContext(UMOContainerContext context)
          associates a Dependency Injector container with Mule.
 void setId(java.lang.String id)
          Sets the unique Id for this Manager instance.
 void setModel(UMOModel model)
          The model used for managing components for this server
 void setProperty(java.lang.Object key, java.lang.Object value)
          Sets an Mule environment parameter in the MuleManager.
 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 unregisterConnector(java.lang.String connectorName)
          UnRegisters a UMOConnector with the MuleManager.
 void unregisterEndpoint(java.lang.String endpointName)
          unregisters a shared/global endpoint with the MuleManager.
 void unregisterEndpointIdentifier(java.lang.String logicalName)
          unregisters an endpointUri with a logical name
 void unregisterListener(UMOServerEventListener l)
          Unregisters a previously registered listener.
 void unregisterTransformer(java.lang.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

public java.lang.Object getProperty(java.lang.Object key)
Getter for the envionment parameters declared in the nule-config.xml

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

lookupConnector

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

lookupEndpointIdentifier

public java.lang.String lookupEndpointIdentifier(java.lang.String logicalName,
                                                 java.lang.String defaultName)
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

public UMOEndpoint lookupEndpoint(java.lang.String logicalName)
Getter for a global endpoint. Any endpoints returned from this method will be read-only as they may be shared by other components. To change any details on the endpoint you must clone it first calling it's clone() method

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

lookupTransformer

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

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

registerConnector

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

Parameters:
connector - the UMOConnector to register
Throws:
UMOException

unregisterConnector

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

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

registerEndpointIdentifier

public void registerEndpointIdentifier(java.lang.String logicalName,
                                       java.lang.String endpoint)
                                throws InitialisationException
Registers an endpointUri with a logical name

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

unregisterEndpointIdentifier

public void unregisterEndpointIdentifier(java.lang.String logicalName)
unregisters an endpointUri with a logical name

Parameters:
logicalName - the name of the endpointUri

registerEndpoint

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

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

unregisterEndpoint

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

Parameters:
endpointName - the UMOEndpoint name to unregister.

registerTransformer

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

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

unregisterTransformer

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

Parameters:
transformerName - the UMOTransformer name to register.

setProperty

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

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

setTransactionManager

public void setTransactionManager(TransactionManager manager)
                           throws java.lang.Exception
Sets the Jta Transaction Manager to use with this Mule server instance

Parameters:
manager - the manager to use
Throws:
java.lang.Exception

getTransactionManager

public 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

getModel

public UMOModel getModel()
The model used for managing components for this server

Returns:
The model used for managing components for this server

setModel

public void setModel(UMOModel model)
The model used for managing components for this server

Parameters:
model - The model used for managing components for this server

getProperties

public java.util.Map getProperties()
Gets all properties associated with the UMOManager

Returns:
a map of properties on the Manager

getConnectors

public java.util.Map getConnectors()
Gets an unmodifiable collection of Connectors registered with the UMOManager

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

getEndpointIdentifiers

public java.util.Map getEndpointIdentifiers()
Gets an unmodifiable collection of endpoints registered with the UMOManager

Returns:
All endpoints registered on the Manager

getEndpoints

public java.util.Map getEndpoints()
Gets an unmodifiable collection of endpoints registered with the UMOManager

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

getTransformers

public java.util.Map getTransformers()
Gets an unmodifiable collection of transformers registered with the UMOManager

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

registerInterceptorStack

public void registerInterceptorStack(java.lang.String name,
                                     java.util.List 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

public java.util.List lookupInterceptorStack(java.lang.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

public boolean isStarted()
Determines if the server has been started

Returns:
true if the server has been started

isInitialised

public boolean isInitialised()
Determines if the server has been initialised

Returns:
true if the server has been initialised

getStartDate

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

Returns:
the long date when the server was started

registerAgent

public 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

removeAgent

public UMOAgent removeAgent(java.lang.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

public void registerListener(UMOServerEventListener l)
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 events fired is entirely defined by the implementation of this class

Parameters:
l - the listener to register

unregisterListener

public void unregisterListener(UMOServerEventListener 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

fireEvent

public void fireEvent(UMOServerEvent event)
Fires a server event to all regiistered listeners

Parameters:
event - the event to fire

setContainerContext

public 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

public 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

public void setId(java.lang.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

public java.lang.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

public 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

public 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


Copyright © 2003-2005 SymphonySoft Limited. All Rights Reserved.