|
TIBCO ActiveMatrix Mediation Implementation Type v3.3.1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.tibco.mediation.task.rt.Task<I,U,N,A,S,T,X>
public abstract class Task<I,U,N extends I,A extends I,S,T,X>
Class Task
is the root of the custom task runtime class hierarchy.
Every custom task runtime class has Task
as a superclass.
Constructor Summary | |
---|---|
Task()
|
Method Summary | |
---|---|
abstract void |
destroy()
The destroy method is called once by the Process Engine before the instance is destroyed. |
abstract N |
execute(N input,
Exchange<N> exchange)
The Process engine invokes this method to execute a task. |
TaskContext<I,U,N,A,S,T,X> |
getContext()
The getContext() method returns the context of the task |
org.slf4j.Logger |
getLogger()
The getLogger() method returns the Logger for the task |
abstract void |
init()
The init method is called once by the Process Engine after the instance is created. |
void |
setContext(TaskContext<I,U,N,A,S,T,X> context)
The setContext method is called once by the Process Engine after the instance is created. |
void |
setLogger(org.slf4j.Logger logger)
The setLogger method is called once by the Process Engine after the instance is created. |
java.lang.String |
toString()
Returns a string representation of the task. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Task()
Method Detail |
---|
public final void setContext(TaskContext<I,U,N,A,S,T,X> context)
The setContext method is called once by the Process Engine after the instance is created. Subclasses of Task can not over-ride the method or reset the context of a task. Calling this method after the first time does not have any effect i.e. it does not reset the task context
public final TaskContext<I,U,N,A,S,T,X> getContext()
TaskContext
public final void setLogger(org.slf4j.Logger logger)
The setLogger method is called once by the Process Engine after the instance is created. Subclasses of Task can not over-ride the method or reset the Logger for a task. Calling this method after the first time does not have any effect i.e. it does not reset the Logger
public final org.slf4j.Logger getLogger()
Logger
public abstract void init() throws TaskLifeCycleFault
The init method is called once by the Process Engine after the instance is created. This method may be implemented to acquire any resources required for the task runtime.
TaskLifeCycleFault
- Thrown by the method to indicate a failure caused by
the implementation of the initialization stepspublic abstract void destroy() throws TaskLifeCycleFault
The destroy method is called once by the Process Engine before the instance is destroyed. This method may be implemented to release any resources acquired by the init method.
TaskLifeCycleFault
- - Thrown by the method to indicate a failure caused by
the implementation of the resource release stepspublic abstract N execute(N input, Exchange<N> exchange) throws TaskFault
input
- The input to the task may be a XML document or null
if the task does not require an inputexchange
- The exchange carries the information flowing through the process
flow
TaskFault
- Thrown by the method to indicate a failure in executing the
implementationpublic java.lang.String toString()
Object.toString() + [name={name}]
toString
in class java.lang.Object
|
TIBCO ActiveMatrix Mediation Implementation Type v3.3.1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |