guarana.toolkit.task.routers
Class Dispatcher

java.lang.Object
  extended by guarana.util.observer.smart.SmartObservable
      extended by guarana.framework.task.Task
          extended by guarana.toolkit.task.routers.Router
              extended by guarana.toolkit.task.routers.Dispatcher
All Implemented Interfaces:
ISource, guarana.util.observer.smart.ISmartObserver

public abstract class Dispatcher
extends Router

Dispatches an inbound message to exactly one output gateway. The output gateway which will receive the outbound message must be returned by the implementation of the method dispatch(). All outbound gateways from this task can be accessed at the property output[], which is an array of gateways.
Important: Please, note that just one output gateway from the eligible list will receive the outbound message. A dispatcher does not change the state of inbound messages, just route them to exactly one output slot! It means the MESSAGE_ID is kept the same!

Graphical notation:


This is an Integration Pattern implementation

Problem:

Solution:

Details:

Since:
Guaranį SDK 1.0.0
Author:
Rafael Z. Frantz

Field Summary
 
Fields inherited from class guarana.framework.task.Task
input, output
 
Constructor Summary
Dispatcher(String name, int numberOfOutputs)
          Constructs a new dispatcher task.
Dispatcher(String name, int numberOfInputs, int numberOfOutputs)
          Constructs a new dispatcher task.
 
Method Summary
abstract  void doWork(Exchange exchange)
          This method implements the business logic of this task.
 void update(guarana.util.observer.smart.SmartObservable slot, Object arg)
          This method is automatically called by the observable slot to notify the slot has received a message.
 
Methods inherited from class guarana.framework.task.Task
execute, getName, getTriggerInterval, isTriggerTask, setName, setTriggerInterval
 
Methods inherited from class guarana.util.observer.smart.SmartObservable
addSmartObserver, containsSmartObserver, containsSmartObserver, countSmartObservers, deleteSmartObserver, deleteSmartObservers, hasChanged, notifySmartObservers, notifySmartObservers
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Dispatcher

public Dispatcher(String name,
                  int numberOfOutputs)
Constructs a new dispatcher task.

Parameters:
name - The name of the dispatcher task.
numberOfOutputs - The number of output gateways this dispatcher have.

Dispatcher

public Dispatcher(String name,
                  int numberOfInputs,
                  int numberOfOutputs)
Constructs a new dispatcher task.

Parameters:
name - The name of this task.
numberOfInputs - The number of input gateways this task must have.
numberOfOutputs - The number of output gateways this task must have.
Method Detail

doWork

public abstract void doWork(Exchange exchange)
                     throws TaskExecutionException
This method implements the business logic of this task.
Dispatches an inbound message to exactly one output gateway.

Overrides:
doWork in class Task
Parameters:
exchange - An exchange object that holds the inbound messages of this task.
Throws:
TaskExecutionException - to report any exception that has occurred during the execution of this method.

update

public void update(guarana.util.observer.smart.SmartObservable slot,
                   Object arg)
This method is automatically called by the observable slot to notify the slot has received a message. For all those tasks that can execute with one or more messages in its input slots, this method will add the task to the executable task reporter, so it can be executed. In this case the task execution will consume messages from all input slots.
Please, do not call this method by yourself. Overrides the implementation at Task for performance reasons.

Specified by:
update in interface guarana.util.observer.smart.ISmartObserver
Overrides:
update in class Task
Parameters:
slot - The Slot associated with this task.
arg - THIS PARAMETHER IS NOT USED.


Guaranį DSL Home