UMOChain

Overview

Package

Class

Use

Deprecated

Index

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 UMOChain

All Superinterfaces:: UMOEventListener

All Known Subinterfaces:: UniversalMessageObject

public interface UMOChain
extends UMOEventListener

UMOChain encapsulates the lowest execution object for a Universal Message Object By implementing this interface an objects can be linked together into an execution chain.

Version:: $Revision: 1.7 $

Method Summary

void breakChain()
          Stops execution of any further object in the chain

void doChain(UMOEvent event)
          Passes an event to the next object in the chain

UMOEvent doSyncChain(UMOEvent event)
          Passes an event to the next object in the chain and returns a resulting event This method is only called in a synchronous environment

UMOChain getFirst()


UMOChain getLast()


java.lang.String getName()


UMOChain getNext()


UniversalMessageObject getOwner()
          As well as being part of a chaina UMOChain can have an owner that must implement the UniversalMEssageObject interface.

UMOChain getPrevious()


void initialise(java.util.Properties props)
          Mule UMO extending this class can do all their initialisation in this method.

boolean isBreakChain()


void setName(java.lang.String newName)
          Sets the identifying name for the chain object

void setNext(UMOChain next)
          Sets the next element in the chain

void setOwner(UniversalMessageObject umo)


void setPrevious(UMOChain previous)
          Sets the previous element in the chain

void startChain(UMOEvent event)
          This event is fired when a new message is recieved by the UMO via a configured UMOMessageReceiver.

UMOEvent startSyncChain(UMOEvent event)
          This event is fired when a new message is recieved by the UMO via a configured UMOMessageReceiver.

Methods inherited from interface org.mule.umo.UMOEventListener

onEvent

Method Detail

initialise

public void initialise(java.util.Properties props)
                throws UMOException

Mule UMO extending this class can do all their initialisation in this method.

doChain

public void doChain(UMOEvent event)
             throws UMOException

Passes an event to the next object in the chain

doSyncChain

public UMOEvent doSyncChain(UMOEvent event)
                     throws UMOException

Passes an event to the next object in the chain and returns a resulting event This method is only called in a synchronous environment

setNext

public void setNext(UMOChain next)

Sets the next element in the chain

getNext

public UMOChain getNext()

setPrevious

public void setPrevious(UMOChain previous)

Sets the previous element in the chain

getPrevious

public UMOChain getPrevious()

startChain

public void startChain(UMOEvent event)
                throws UMOException

This event is fired when a new message is recieved by the UMO via a configured UMOMessageReceiver. The UMOMessageReceiver calls this method to start event processing

startSyncChain

public UMOEvent startSyncChain(UMOEvent event)
                        throws UMOException

This event is fired when a new message is recieved by the UMO via a configured UMOMessageReceiver. The UMOMessageReceiver calls this method to start event processing. This method is only called in a synchronous environment

getName

public java.lang.String getName()

setName

public void setName(java.lang.String newName)

Sets the identifying name for the chain object

getOwner

public UniversalMessageObject getOwner()

As well as being part of a chaina UMOChain can have an owner that must implement the UniversalMEssageObject interface. Through it's owner a UMOChain can have greater control over it's environment.

setOwner

public void setOwner(UniversalMessageObject umo)

breakChain

public void breakChain()
                throws UMOException

Stops execution of any further object in the chain

isBreakChain

public boolean isBreakChain()

getFirst

public UMOChain getFirst()

getLast

public UMOChain getLast()