org.mule.umo
Interface UMODescriptor

All Superinterfaces:
UMOImmutableDescriptor
All Known Implementing Classes:
MuleDescriptor

public interface UMODescriptor
extends UMOImmutableDescriptor

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

Version:
$Revision: 1.1.1.1 $
Author:
Ross Mason

Method Summary
 void addInterceptor(UMOInterceptor interceptor)
          Interceptors are executable objects that can be chained together.
 void setExceptionStrategy(UMOExceptionStrategy strategy)
          The exception strategy to use to handle exceptions in the Mule UMO.
 void setImplementation(java.lang.Object reference)
          The String used to instanciate create the object, this can be a FQ class name or a reference to an object in a configured container
 void setInboundEndpoint(UMOEndpoint endpoint)
          The inbound endpointUri to use when receiveing an event.
 void setInboundRouter(UMOInboundMessageRouter router)
          Inbound Routers control how events are received by a component.
 void setInboundTransformer(UMOTransformer transformer)
           
 void setInterceptors(java.util.List interceptorList)
          Interceptors are executable objects that can be chained together.
 void setName(java.lang.String newName)
          sets the identifier for the Mule UMO created from the descriptor
 void setOutboundEndpoint(UMOEndpoint endpoint)
          The outbound Provider to use when sending an event.
 void setOutboundRouter(UMOOutboundMessageRouter router)
          Outbound Routers control how events are published by a component once.
 void setOutboundTransformer(UMOTransformer transformer)
          The transformer to use when sending events or data.
 void setProperties(java.util.HashMap props)
           
 void setResponseRouter(UMOResponseMessageRouter router)
          Response Routers control how events are returned in a request/response call.
 void setVersion(java.lang.String ver)
          The version on the Mule UMO.
 
Methods inherited from interface org.mule.umo.UMOImmutableDescriptor
getExceptionStrategy, getImplementation, getImplementationClass, getInboundEndpoint, getInboundRouter, getInboundTransformer, getInterceptors, getName, getOutboundEndpoint, getOutboundRouter, getOutboundTransformer, getProperties, getResponseRouter, getVersion
 

Method Detail

addInterceptor

public void addInterceptor(UMOInterceptor interceptor)
Interceptors are executable objects that can be chained together. Interceptors are executed in the order they are added, for example if INTERCEPTOR_1 is added and then INTERCEPTOR_2 is added to UMO_A the execution order will be: INTERCEPTOR_1 -> INTERCEPTOR_2 -> UMO_A.

Parameters:
interceptor - the interceptor to add.

setInterceptors

public void setInterceptors(java.util.List interceptorList)
Interceptors are executable objects that can be chained together. Interceptors are executed in the order they are added, for example if INTERCEPTOR_1 is added and then INTERCEPTOR_2 is added to UMO_A the execution order will be: INTERCEPTOR_1 -> INTERCEPTOR_2 -> UMO_A.

Parameters:
interceptorList - A list of interceptors to associate.

setExceptionStrategy

public void setExceptionStrategy(UMOExceptionStrategy strategy)
The exception strategy to use to handle exceptions in the Mule UMO.

Parameters:
strategy - the exception strategy to use. If none has been set or argument is null a default will be used.

setInboundEndpoint

public void setInboundEndpoint(UMOEndpoint endpoint)
                        throws MuleException
The inbound endpointUri to use when receiveing an event.

Parameters:
endpoint - the inbound endpoint to use
Throws:
MuleException - if the Provider is not valid i.e. the proivder is not a receiver
See Also:
UMOEndpoint

setName

public void setName(java.lang.String newName)
sets the identifier for the Mule UMO created from the descriptor

Parameters:
newName - the identifier for the Mule UMO created from the descriptor

setOutboundEndpoint

public void setOutboundEndpoint(UMOEndpoint endpoint)
                         throws MuleException
The outbound Provider to use when sending an event.

Parameters:
endpoint - the outbound endpoint to use
Throws:
MuleException - if the Provider is not valid i.e. the proivder is a receiver
See Also:
UMOEndpoint

setProperties

public void setProperties(java.util.HashMap props)
Parameters:
props - the properties for the descriptor. These will be passed to the UMO when it's initialise method is called or set as bean properties whe the UMO is created

setVersion

public void setVersion(java.lang.String ver)
The version on the Mule UMO. This is currently not used by the mule run-time but may be used in future.

Parameters:
ver - the version of the Mule descriptor

setImplementation

public void setImplementation(java.lang.Object reference)
The String used to instanciate create the object, this can be a FQ class name or a reference to an object in a configured container

Parameters:
reference - The String object reference

setInboundRouter

public void setInboundRouter(UMOInboundMessageRouter router)
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.

Parameters:
router - the inbound router for this component
See Also:
UMOInboundMessageRouter

setOutboundRouter

public void setOutboundRouter(UMOOutboundMessageRouter router)
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.

Parameters:
router - the outbound router for this component
See Also:
UMOOutboundMessageRouter

setResponseRouter

public void setResponseRouter(UMOResponseMessageRouter router)
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

Parameters:
router - the response router for this component
See Also:
UMOResponseMessageRouter

setInboundTransformer

public void setInboundTransformer(UMOTransformer transformer)
Parameters:
transformer - the transformer to use.
See Also:
UMOTransformer, AbstractTransformer

setOutboundTransformer

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

Parameters:
transformer - the transformer to use.
See Also:
UMOTransformer, AbstractTransformer


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