guarana.toolkit.task.modifiers
Class CustomModifier
java.lang.Object
guarana.util.observer.smart.SmartObservable
guarana.framework.task.Task
guarana.toolkit.task.modifiers.Modifier
guarana.toolkit.task.modifiers.CustomModifier
- All Implemented Interfaces:
- ISource, guarana.util.observer.smart.ISmartObserver
public abstract class CustomModifier
- extends Modifier
Allows for the creation of a customised modifier task with a different semantics from
the predefined tasks already provided by this package.
This custom modifier task can modify the inbound message's header and/or body.
The outbound message has a new MESSAGE_ID and the inbound message as its parent.
Graphical notation:
This is an Integration Pattern implementation
Problem: How do you modify a message according to a particular need?
Solution: Use a custom modifier.
Details:
- Number of Inputs: 1
- Number of Outputs: 1
- Java Object of the inbound message is modified and reused for the outbound message!
- Since:
- Guaranį SDK 1.0.0
- Author:
- Rafael Z. Frantz
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.util.observer.smart.SmartObservable |
addSmartObserver, containsSmartObserver, containsSmartObserver, countSmartObservers, deleteSmartObserver, deleteSmartObservers, hasChanged, notifySmartObservers, notifySmartObservers |
CustomModifier
public CustomModifier(String name)
- Constructs a new custom modifier task.
- Parameters:
name
- The name of the custom modifier task.
CustomModifier
public CustomModifier(String name,
int numberOfInputs,
int numberOfOutputs)
- Constructs a new custom modifier 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.
doWork
public abstract void doWork(Exchange exchange)
throws TaskExecutionException
- This method implements the business logic of this task.
Used to implement the custom message modification.
This method receives an inbound message so a custom modification can be applied to its header and/or body.
- 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