org.mule.umo
Interface UMODescriptor

All Superinterfaces:
Initialisable, 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.


Method Summary
 void addInterceptor(UMOInterceptor interceptor)
          Interceptors are executable objects that can be chained together.
 void setContainer(String containerName)
          Sets the name of the contaier where the object for this descriptor resides.
 void setEncoding(String encoding)
           
 void setExceptionListener(ExceptionListener listener)
          The exception strategy to use to handle exceptions in the Mule UMO.
 void setImplementation(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)
          Deprecated. use setInboundRouter() instead (see MULE-506)
 void setInboundRouter(UMOInboundRouterCollection router)
          Inbound Routers control how events are received by a component.
 void setInboundTransformer(UMOTransformer transformer)
          Deprecated. use setInboundRouter() instead (see MULE-506)
 void setInitialState(String state)
          Sets the initial state of this component
 void setInterceptors(List interceptorList)
          Interceptors are executable objects that can be chained together.
 void setModelName(String modelName)
          Sets the Model name that this descriptor is registered within.
 void setName(String newName)
          sets the identifier for the Mule UMO created from the descriptor
 void setNestedRouter(UMONestedRouterCollection router)
           
 void setOutboundEndpoint(UMOEndpoint endpoint)
          Deprecated. use setOutboundRouter() instead (see MULE-506)
 void setOutboundRouter(UMOOutboundRouterCollection router)
          Outbound Routers control how events are published by a component once.
 void setOutboundTransformer(UMOTransformer transformer)
          Deprecated. use setOutboundRouter() instead (see MULE-506)
 void setProperties(Map props)
           
 void setResponseRouter(UMOResponseRouterCollection router)
          Response Routers control how events are returned in a request/response call.
 void setSingleton(boolean singleton)
          Determines if only a single instance of this component is created.
 void setVersion(String ver)
          The version on the Mule UMO.
 
Methods inherited from interface org.mule.umo.UMOImmutableDescriptor
getContainer, getEncoding, getExceptionListener, getImplementation, getImplementationClass, getInboundEndpoint, getInboundRouter, getInboundTransformer, getInitialState, getInterceptors, getModelName, getName, getNestedRouter, getOutboundEndpoint, getOutboundRouter, getOutboundTransformer, getProperties, getResponseRouter, getResponseTransformer, getVersion, isSingleton
 
Methods inherited from interface org.mule.umo.lifecycle.Initialisable
initialise
 

Method Detail

addInterceptor

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

void setInterceptors(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.

setExceptionListener

void setExceptionListener(ExceptionListener listener)
The exception strategy to use to handle exceptions in the Mule UMO.

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

setInboundEndpoint

void setInboundEndpoint(UMOEndpoint endpoint)
                        throws MuleException
Deprecated. use setInboundRouter() instead (see MULE-506)

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

void setName(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

void setOutboundEndpoint(UMOEndpoint endpoint)
                         throws MuleException
Deprecated. use setOutboundRouter() instead (see MULE-506)

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

void setProperties(Map 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

void setVersion(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

void setImplementation(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

void setInboundRouter(UMOInboundRouterCollection 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:
UMOInboundRouterCollection

setOutboundRouter

void setOutboundRouter(UMOOutboundRouterCollection 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:
UMOOutboundRouterCollection

setNestedRouter

void setNestedRouter(UMONestedRouterCollection router)

setResponseRouter

void setResponseRouter(UMOResponseRouterCollection 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:
UMOResponseRouterCollection

setInboundTransformer

void setInboundTransformer(UMOTransformer transformer)
Deprecated. use setInboundRouter() instead (see MULE-506)

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

setOutboundTransformer

void setOutboundTransformer(UMOTransformer transformer)
Deprecated. use setOutboundRouter() instead (see MULE-506)

The transformer to use when sending events or data.

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

setSingleton

void setSingleton(boolean singleton)
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.

Parameters:
singleton - true if this component is a singleton

setInitialState

void setInitialState(String state)
Sets the initial state of this component

Parameters:
state - the initial state of this component
See Also:
ImmutableMuleDescriptor.INITIAL_STATE_STARTED, ImmutableMuleDescriptor.INITIAL_STATE_STOPPED, ImmutableMuleDescriptor.INITIAL_STATE_PAUSED

setEncoding

void setEncoding(String encoding)

setContainer

void setContainer(String containerName)
Sets 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.

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

setModelName

void setModelName(String modelName)
Sets the Model name that this descriptor is registered within.

Parameters:
modelName - name of the model


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