|
|||||||||
| Home >> All >> org >> mule >> [ umo overview ] | PREV CLASS NEXT CLASS | ||||||||
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD |
DETAIL: FIELD | CONSTR | METHOD | ||||||||
org.mule.umo
Interface UniversalMessageObject
- All Superinterfaces:
- UMOChain, UMOEventListener
- public interface UniversalMessageObject
- extends UMOChain
UniversalMessageObject describes the methods for a Universal Message Object.
It provides methods for initialisation, dispatching, sending, and creating events.
The UniversalMEssageObject interface implements the UMOChain interface so that other UMOChain
implementations can be chained to it.
- Version:
- $Revision: 1.7 $
| Method Summary | |
UMOEvent |
createOutboundEvent(java.lang.Object data)
Will create a UMOEvent based on the current settings of the UMODescriptor and the data passed |
UMOEvent |
createOutboundEvent(java.lang.Object data,
UMOProviderDescriptor provider,
java.util.HashMap properties)
Will create a UMOEvent based on the current settings of the UMODescriptor and the data passed |
void |
destroy()
A stub method where the user can execute any code to destroy connections and resources |
void |
dispatchEvent(java.lang.Object message,
UMOProviderDescriptor pdescriptor,
java.util.HashMap props)
Dispatches an event asynchronously over a configured provider |
void |
dispatchEvent(UMOEvent event)
Dispatches an event asynchronously over a configured provider |
UMODescriptor |
getDescriptor()
|
org.mule.MuleManager |
getManager()
|
java.lang.String |
getName()
|
UMOSession |
getSession()
|
void |
handleException(java.lang.Object source,
java.lang.Throwable exception)
When an exception occurs this method can be called to invoke the the configured UMOExceptionStrategy on this component |
void |
init(UMODescriptor descriptor,
org.mule.MuleManager manager)
|
boolean |
isStarted()
|
boolean |
isStopped()
|
UMOEvent |
receiveEvent(UMOProviderDescriptor provider,
long timeout)
Requests a synchronous receive of an event on the session |
void |
resume()
Is called when the component should resume processing |
java.lang.Object |
sendEvent(java.lang.Object message,
UMOProviderDescriptor pdescriptor,
java.util.HashMap props)
Sends an event synchronously over a configured provider |
UMOEvent |
sendEvent(UMOEvent event)
Sends an event synchronously over a configured provider |
void |
start()
A stub method where the user can execute any initialisation code |
void |
stop()
A stub method where the user can execute any code to stop connections and resources |
void |
suspend()
Is called when the component should suspend processing, i.e a umo in a pool might want to clear any local resuorces before being returned to the pool |
| Methods inherited from interface org.mule.umo.UMOChain |
breakChain, doChain, doSyncChain, getFirst, getLast, getNext, getOwner, getPrevious, initialise, isBreakChain, setName, setNext, setOwner, setPrevious, startChain, startSyncChain |
| Methods inherited from interface org.mule.umo.UMOEventListener |
onEvent |
| Method Detail |
init
public void init(UMODescriptor descriptor, org.mule.MuleManager manager) throws UMOException
dispatchEvent
public void dispatchEvent(UMOEvent event) throws java.lang.Exception
- Dispatches an event asynchronously over a configured provider
dispatchEvent
public void dispatchEvent(java.lang.Object message, UMOProviderDescriptor pdescriptor, java.util.HashMap props) throws java.lang.Exception
- Dispatches an event asynchronously over a configured provider
sendEvent
public UMOEvent sendEvent(UMOEvent event) throws java.lang.Exception
- Sends an event synchronously over a configured provider
sendEvent
public java.lang.Object sendEvent(java.lang.Object message, UMOProviderDescriptor pdescriptor, java.util.HashMap props) throws java.lang.Exception
- Sends an event synchronously over a configured provider
receiveEvent
public UMOEvent receiveEvent(UMOProviderDescriptor provider, long timeout) throws java.lang.Exception
- Requests a synchronous receive of an event on the session
createOutboundEvent
public UMOEvent createOutboundEvent(java.lang.Object data) throws UMOException
- Will create a UMOEvent based on the current settings of the UMODescriptor
and the data passed
createOutboundEvent
public UMOEvent createOutboundEvent(java.lang.Object data, UMOProviderDescriptor provider, java.util.HashMap properties) throws UMOException
- Will create a UMOEvent based on the current settings of the UMODescriptor
and the data passed
getDescriptor
public UMODescriptor getDescriptor()
getName
public java.lang.String getName()
getManager
public org.mule.MuleManager getManager()
suspend
public void suspend()
- Is called when the component should suspend processing, i.e a umo in a pool
might want to clear any local resuorces before being returned to the pool
resume
public void resume()
- Is called when the component should resume processing
start
public void start()
throws UMOException
- A stub method where the user can execute any initialisation code
stop
public void stop()
throws UMOException
- A stub method where the user can execute any code to stop connections and resources
destroy
public void destroy()
throws UMOException
- A stub method where the
user can execute any code to destroy connections and resources
isStarted
public boolean isStarted()
isStopped
public boolean isStopped()
handleException
public void handleException(java.lang.Object source, java.lang.Throwable exception)
- When an exception occurs this method can be called to invoke the the
configured UMOExceptionStrategy on this component
getSession
public UMOSession getSession() throws UMOException
|
|||||||||
| Home >> All >> org >> mule >> [ umo overview ] | PREV CLASS NEXT CLASS | ||||||||
|
SUMMARY: JAVADOC | SOURCE | DOWNLOAD | NESTED | FIELD | CONSTR | METHOD |
DETAIL: FIELD | CONSTR | METHOD | ||||||||