|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.mule.impl.ImmutableMuleDescriptor
MuleDescriptor
describes all the properties for a Mule UMO. New
Mule UMOs can be initialised as needed from their descriptor.
Field Summary | |
protected String |
container
The name of the container that the component implementation resides in If null, the container is not known, if 'none' the component is instanciated from its implementation class name. |
protected boolean |
containerManaged
Deprecated. Use container instead. |
protected String |
encoding
|
protected ExceptionListener |
exceptionListener
holds the exception stategy for this UMO |
protected Object |
implementationReference
The implementationReference used to create the Object UMO instance. |
protected UMOEndpoint |
inboundEndpoint
Deprecated. Please use inboundRouter instead. |
protected UMOInboundRouterCollection |
inboundRouter
|
protected UMOTransformer |
inboundTransformer
Deprecated. Please use inboundRouter instead. |
static String |
INITIAL_STATE_PAUSED
|
static String |
INITIAL_STATE_STARTED
|
static String |
INITIAL_STATE_STOPPED
The initial states that the component can be started in |
protected List |
initialisationCallbacks
|
protected String |
initialState
Determines the initial state of this component when the model starts. |
protected List |
intecerptorList
A list of UMOinteceptors that will be executed when the Mule UMO executed |
protected String |
modelName
|
protected static String |
MULE_PROPERTY_DOT_PROPERTIES
Property that allows for a property file to be used to load properties instead of listing them directly in the mule-configuration file |
protected String |
name
The descriptor name |
protected UMONestedRouterCollection |
nestedRouter
|
protected UMOEndpoint |
outboundEndpoint
Deprecated. Please use outboundRouter instead. |
protected UMOOutboundRouterCollection |
outboundRouter
|
protected UMOTransformer |
outboundTransformer
Deprecated. Please use outboundRouter instead. |
protected PoolingProfile |
poolingProfile
the pooling configuration used when initialising the component described by this descriptor. |
protected Map |
properties
The properties for the Mule UMO. |
protected QueueProfile |
queueProfile
The queuing profile for events received for this component |
protected UMOResponseRouterCollection |
responseRouter
|
protected UMOTransformer |
responseTransformer
Deprecated. Please use responseRouter instead. |
protected boolean |
singleton
Determines if this component is a singleton |
protected ThreadingProfile |
threadingProfile
The threading profile to use for this component. |
protected String |
version
The descriptors version |
Constructor Summary | |
protected |
ImmutableMuleDescriptor()
Default constructor used by mutable versions of this class to provide defaults for certain properties |
|
ImmutableMuleDescriptor(ImmutableMuleDescriptor descriptor)
Default constructor. |
Method Summary | |
void |
fireInitialisationCallbacks(Object component)
|
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 |
protected Class |
getImplementationForReference(String reference)
A helper method that will resolved a component for a given reference id. |
UMOEndpoint |
getInboundEndpoint()
The inbound Provider to use when receiveing an event. |
UMOInboundRouterCollection |
getInboundRouter()
Inbound Routers control how events are received by a component. |
UMOTransformer |
getInboundTransformer()
The transformer to use when receiving events or data. |
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()
The outbound Provider to use when sending an event. |
UMOOutboundRouterCollection |
getOutboundRouter()
Outbound Routers control how events are published by a component once. |
UMOTransformer |
getOutboundTransformer()
The transformer to use when sending events or data. |
PoolingProfile |
getPoolingProfile()
|
Map |
getProperties()
Returns any properties configured on this descriptor. |
QueueProfile |
getQueueProfile()
|
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. |
ThreadingProfile |
getThreadingProfile()
The threading profile used by the UMO when managing a component. |
String |
getVersion()
The version on the Mule UMO. |
void |
initialise()
Method used to perform any initialisation work. |
boolean |
isContainerManaged()
|
boolean |
isSingleton()
Determines if only a single instance of this component is created. |
String |
toString()
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final String INITIAL_STATE_STOPPED
public static final String INITIAL_STATE_STARTED
public static final String INITIAL_STATE_PAUSED
protected static final String MULE_PROPERTY_DOT_PROPERTIES
protected ExceptionListener exceptionListener
protected Object implementationReference
protected String name
protected Map properties
protected String version
protected List intecerptorList
protected UMOInboundRouterCollection inboundRouter
protected UMOOutboundRouterCollection outboundRouter
protected UMONestedRouterCollection nestedRouter
protected UMOResponseRouterCollection responseRouter
protected String modelName
protected UMOEndpoint inboundEndpoint
inboundRouter
instead.
MULE-506
protected UMOTransformer inboundTransformer
inboundRouter
instead.
MULE-506
protected UMOEndpoint outboundEndpoint
outboundRouter
instead.
MULE-506
protected UMOTransformer outboundTransformer
outboundRouter
instead.
MULE-506
protected UMOTransformer responseTransformer
responseRouter
instead.
MULE-506
protected ThreadingProfile threadingProfile
protected PoolingProfile poolingProfile
protected QueueProfile queueProfile
protected boolean containerManaged
container
instead.
MULE-812
protected String initialState
protected boolean singleton
protected List initialisationCallbacks
protected String encoding
protected String container
Constructor Detail |
public ImmutableMuleDescriptor(ImmutableMuleDescriptor descriptor)
MuleConfiguration
protected ImmutableMuleDescriptor()
Method Detail |
public void initialise() throws InitialisationException
Initialisable
InitialisationException
should be thrown,
causing the Mule instance to shutdown. If the error is recoverable, say by
retrying to connect, a RecoverableException
should be thrown.
There is no guarantee that by throwing a Recoverable exception that the Mule
instance will not shut down.
initialise
in interface Initialisable
InitialisationException
- if a fatal error occurs causing the Mule
instance to shutdownpublic ExceptionListener getExceptionListener()
UMOImmutableDescriptor
getExceptionListener
in interface UMOImmutableDescriptor
public UMOTransformer getInboundTransformer()
UMOImmutableDescriptor
getInboundTransformer
in interface UMOImmutableDescriptor
public String getName()
UMOImmutableDescriptor
getName
in interface UMOImmutableDescriptor
public UMOTransformer getOutboundTransformer()
UMOImmutableDescriptor
getOutboundTransformer
in interface UMOImmutableDescriptor
public UMOTransformer getResponseTransformer()
UMOImmutableDescriptor
getResponseTransformer
in interface UMOImmutableDescriptor
public Map getProperties()
UMOImmutableDescriptor
getProperties
in interface UMOImmutableDescriptor
public String getVersion()
UMOImmutableDescriptor
getVersion
in interface UMOImmutableDescriptor
public List getInterceptors()
UMOImmutableDescriptor
getInterceptors
in interface UMOImmutableDescriptor
public String getEncoding()
getEncoding
in interface UMOImmutableDescriptor
public String toString()
public Object getImplementation()
UMOImmutableDescriptor
getImplementation
in interface UMOImmutableDescriptor
public UMOInboundRouterCollection getInboundRouter()
UMOImmutableDescriptor
getInboundRouter
in interface UMOImmutableDescriptor
UMOInboundRouterCollection
public UMOOutboundRouterCollection getOutboundRouter()
UMOImmutableDescriptor
getOutboundRouter
in interface UMOImmutableDescriptor
UMOOutboundRouterCollection
public UMONestedRouterCollection getNestedRouter()
getNestedRouter
in interface UMOImmutableDescriptor
public ThreadingProfile getThreadingProfile()
public PoolingProfile getPoolingProfile()
public QueueProfile getQueueProfile()
public boolean isContainerManaged()
public Class getImplementationClass() throws UMOException
UMOImmutableDescriptor
getImplementationClass
in interface UMOImmutableDescriptor
UMOException
protected Class getImplementationForReference(String reference) throws ContainerException
reference
- the reference to use when resolving the component
ContainerException
public void fireInitialisationCallbacks(Object component) throws InitialisationException
InitialisationException
public UMOEndpoint getInboundEndpoint()
getInboundEndpoint
in interface UMOImmutableDescriptor
UMOEndpoint
public UMOEndpoint getOutboundEndpoint()
getOutboundEndpoint
in interface UMOImmutableDescriptor
UMOEndpoint
public UMOResponseRouterCollection getResponseRouter()
UMOImmutableDescriptor
getResponseRouter
in interface UMOImmutableDescriptor
UMOResponseRouterCollection
public boolean isSingleton()
UMOImmutableDescriptor
isSingleton
in interface UMOImmutableDescriptor
public String getInitialState()
UMOImmutableDescriptor
getInitialState
in interface UMOImmutableDescriptor
public String getContainer()
getContainer
in interface UMOImmutableDescriptor
public String getModelName()
UMOImmutableDescriptor
getModelName
in interface UMOImmutableDescriptor
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |