org.mule.umo
Interface UMOImmutableDescriptor

All Superinterfaces:
Initialisable
All Known Subinterfaces:
UMODescriptor
All Known Implementing Classes:
ImmutableMuleDescriptor, MuleDescriptor

public interface UMOImmutableDescriptor
extends Initialisable

UMODescriptor describes all the properties for a Mule UMO. New Mule UMOs can be initialised as needed from their descriptor.


Method Summary
 String getContainer()
          Returns the name of the contaier where the object for this descriptor resides.
 String getEncoding()
           
 ExceptionListener getExceptionListener()
          The exception strategy to use to handle exceptions in the Mule UMO.
 Object getImplementation()
          String used to instansiate the object, this can be a class name or a reference to an object in a container
 Class getImplementationClass()
          Class used to instansiate the object, this can be a class name or a reference to an object in a container
 UMOEndpoint getInboundEndpoint()
          Deprecated. use getInboundRouter() instead (see MULE-506)
 UMOInboundRouterCollection getInboundRouter()
          Inbound Routers control how events are received by a component.
 UMOTransformer getInboundTransformer()
          Deprecated. use getInboundRouter() instead (see MULE-506)
 String getInitialState()
          Returns the initial state of this component
 List getInterceptors()
          Returns a list of interceptor objects that will be executed before/after the Mule UMO has executed
 String getModelName()
          Returns the name of the model that this descriptor is registered with.
 String getName()
          Gets the identifier for the Mule UMO created from the descriptor
 UMONestedRouterCollection getNestedRouter()
           
 UMOEndpoint getOutboundEndpoint()
          Deprecated. use getOutboundRouter() instead (see MULE-506)
 UMOOutboundRouterCollection getOutboundRouter()
          Outbound Routers control how events are published by a component once.
 UMOTransformer getOutboundTransformer()
          Deprecated. use getOutboundRouter() instead (see MULE-506)
 Map getProperties()
          Returns any properties configured on this descriptor.
 UMOResponseRouterCollection getResponseRouter()
          Response Routers control how events are returned in a request/response call.
 UMOTransformer getResponseTransformer()
          The transformer to use when sending events or data back as a response.
 String getVersion()
          The version on the Mule UMO.
 boolean isSingleton()
          Determines if only a single instance of this component is created.
 
Methods inherited from interface org.mule.umo.lifecycle.Initialisable
initialise
 

Method Detail

getExceptionListener

ExceptionListener getExceptionListener()
The exception strategy to use to handle exceptions in the Mule UMO.

Returns:
the exception strategy to use. If none has been set a default will be used.

getInboundEndpoint

UMOEndpoint getInboundEndpoint()
Deprecated. use getInboundRouter() instead (see MULE-506)

The inbound Provider to use when receiveing an event. This may get overidden by the configured behaviour of the inbound router on this component

Returns:
the inbound endpoint or null if one is not set
See Also:
UMOEndpoint

getName

String getName()
Gets the identifier for the Mule UMO created from the descriptor

Returns:
the identifier for the Mule UMO created from the descriptor

getOutboundEndpoint

UMOEndpoint getOutboundEndpoint()
Deprecated. use getOutboundRouter() instead (see MULE-506)

The outbound Provider to use when sending an event. This may get overidden by the configured behaviour of the outbound router on this component

Returns:
the outbound endpoint or null if one is not set
See Also:
UMOEndpoint

getProperties

Map getProperties()
Returns any properties configured on this descriptor.

Returns:
properties defined for the descriptor.

getInterceptors

List getInterceptors()
Returns a list of interceptor objects that will be executed before/after the Mule UMO has executed

Returns:
a list of interceptor objects that will be executed before/after the Mule UMO has executed

getVersion

String getVersion()
The version on the Mule UMO. This is currently not used by the mule run-time but may be used in future.

Returns:
the Descriptor Version

getImplementation

Object getImplementation()
String used to instansiate the object, this can be a class name or a reference to an object in a container

Returns:
the Object's class r reference name or an instance of the object to use

getImplementationClass

Class getImplementationClass()
                             throws UMOException
Class used to instansiate the object, this can be a class name or a reference to an object in a container

Returns:
the Object's class representation
Throws:
UMOException

getInboundRouter

UMOInboundRouterCollection getInboundRouter()
Inbound Routers control how events are received by a component. If no router is set. A default will be used that uses the inboundProvider set on his descriptor.

Returns:
the inbound router for this component. This will always return a valid router.
See Also:
UMOInboundRouterCollection

getOutboundRouter

UMOOutboundRouterCollection getOutboundRouter()
Outbound Routers control how events are published by a component once. the event has been processed. If no router is set. A default will be used that uses the outboundProvider set on his descriptor to route the event.

Returns:
the outbound router for this component
See Also:
UMOOutboundRouterCollection

getNestedRouter

UMONestedRouterCollection getNestedRouter()

getResponseRouter

UMOResponseRouterCollection getResponseRouter()
Response Routers control how events are returned in a request/response call. It cn be use to aggregate response events before returning, thus acting as a Join in a forked process. This can be used to make request/response calls a lot more efficient as independent tasks can be forked, execute concurrently and then join before the request completes

Returns:
the response router for this component
See Also:
UMOResponseRouterCollection

getInboundTransformer

UMOTransformer getInboundTransformer()
Deprecated. use getInboundRouter() instead (see MULE-506)

The transformer to use when receiving events or data.

Returns:
the Inbound transformer to use

getOutboundTransformer

UMOTransformer getOutboundTransformer()
Deprecated. use getOutboundRouter() instead (see MULE-506)

The transformer to use when sending events or data.

Returns:
the Outbound transformer to use

getResponseTransformer

UMOTransformer getResponseTransformer()
The transformer to use when sending events or data back as a response.

Returns:
the response transformer to use

getEncoding

String getEncoding()

isSingleton

boolean isSingleton()
Determines if only a single instance of this component is created. This is useful when a component hands off event processing to another engine such as Rules processing or Bpel and the processing engine allocates and manages its own threads.

Returns:
true if this component is a singleton

getInitialState

String getInitialState()
Returns the initial state of this component

Returns:
the initial state of this component

getContainer

String getContainer()
Returns the name of the contaier where the object for this descriptor resides. If this value is 'none' the 'implementaiton' attributed is expected to be a fully qualified class name that will be instanciated.

Returns:
the container name, or null if it is not known - in which case each container will be queried for the component implementation.

getModelName

String getModelName()
Returns the name of the model that this descriptor is registered with.

Returns:
the name of the model that this descriptor is registered with or null if this descriptor has not been registered with a model yet


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