org.mule.umo
Interface UMOImmutableDescriptor

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

public interface UMOImmutableDescriptor

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

Version:
$Revision: 1.1.1.1 $
Author:
Ross Mason

Method Summary
 UMOExceptionStrategy getExceptionStrategy()
          The exception strategy to use to handle exceptions in the Mule UMO.
 java.lang.Object getImplementation()
          String used to instansiate the object, this can be a class name or a reference to an object in a container
 java.lang.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()
          The inbound Provider to use when receiveing an event.
 UMOInboundMessageRouter getInboundRouter()
          Inbound Routers control how events are received by a component.
 UMOTransformer getInboundTransformer()
          The transformer to use when receiving events or data.
 java.util.List getInterceptors()
          Retuens a list of interceptor objects that will be executed before/after the Mule UMO has executed
 java.lang.String getName()
          Gets the identifier for the Mule UMO created from the descriptor
 UMOEndpoint getOutboundEndpoint()
          The outbound Provider to use when sending an event.
 UMOOutboundMessageRouter getOutboundRouter()
          Outbound Routers control how events are published by a component once.
 UMOTransformer getOutboundTransformer()
          The transformer to use when sending events or data.
 java.util.HashMap getProperties()
          Returns any properties configured on this descriptor.
 UMOResponseMessageRouter getResponseRouter()
          Response Routers control how events are returned in a request/response call.
 java.lang.String getVersion()
          The version on the Mule UMO.
 

Method Detail

getExceptionStrategy

public UMOExceptionStrategy getExceptionStrategy()
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

public UMOEndpoint getInboundEndpoint()
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

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

public UMOEndpoint getOutboundEndpoint()
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

public java.util.HashMap getProperties()
Returns any properties configured on this descriptor.

Returns:
properties defined for the descriptor.

getInterceptors

public java.util.List getInterceptors()
Retuens 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

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

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

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

public UMOInboundMessageRouter 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:
UMOInboundMessageRouter

getOutboundRouter

public UMOOutboundMessageRouter 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:
UMOOutboundMessageRouter

getResponseRouter

public UMOResponseMessageRouter 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:
UMOResponseMessageRouter

getInboundTransformer

public UMOTransformer getInboundTransformer()
The transformer to use when receiving events or data.

Returns:
the Inbound transformer to use

getOutboundTransformer

public UMOTransformer getOutboundTransformer()
The transformer to use when sending events or data.

Returns:
the Outbound transformer to use


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