|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.websphere.grid.spi.SPI
com.ibm.wsspi.batch.parallel.status.SubJobAnalyzer
public abstract class SubJobAnalyzer
SubJobAnalyzer is the abstract base class for the ParallelJobManager SubJobAnalyzer System Programming Interface (SPI). Use the SubJobAnalyzer to receive and process information about subjobs. The SubJobAnalyzer receives the following subjob information:
The SubJobAnalyzer SPI can additionally set the final return code for a parallel job.
Implement the SubJobAnalyzer SPI, by extending this class and implementing the analyze methods.
Configure this SPI with the following declaration in the xd.spi.properties file:
spi.parallel.status.SubJobAnalyzer=<fully-qualified implementation class name>
Notes:
<WAS install root>/properties. E.g. /WebSphere/AppServer/properties
<WAS install root>/lib/classes. E.g. /WebSphere/AppServer/lib/classes
You are responsible for creating the classes directory if it does not already exist.
Constructor Summary | |
---|---|
SubJobAnalyzer()
|
Method Summary | |
---|---|
abstract void |
analyze(java.lang.String logicalJobName,
java.lang.String logicalTXID,
java.lang.String subJobID,
java.io.Externalizable subJobData)
Analyzes data collected from a running subjob. |
abstract void |
analyze(java.lang.String logicalJobName,
java.lang.String logicalTXID,
java.lang.String subJobID,
int subJobReturnCode)
Analyzes subjob return code. |
java.lang.String |
getName()
|
abstract int |
getReturnCode(java.lang.String logicalJobName,
java.lang.String logicalTXID)
Returns the final return code for the specified parallel job. |
Methods inherited from class com.ibm.websphere.grid.spi.SPI |
---|
compareTo, getInvocationOrder, setInvocationOrder, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public SubJobAnalyzer()
Method Detail |
---|
public abstract void analyze(java.lang.String logicalJobName, java.lang.String logicalTXID, java.lang.String subJobID, java.io.Externalizable subJobData) throws RollbackLogicalTXException
logicalJobName
- specifies name of the current parallel job.
This name is the same each time you submit the same parallel job.logicalTXID
- specifies a unique identifier for the current parallel job instance.
This identifier defines a logical unit of work in which all subjobs for the current parallel job execute.subJobID
- specifies the unique identifier of a subjob belonging to the current parallel job.subJobData
- specifies the subjob data collected for the specified subjob.
RollbackLogicalTXException
public abstract void analyze(java.lang.String logicalJobName, java.lang.String logicalTXID, java.lang.String subJobID, int subJobReturnCode) throws RollbackLogicalTXException
logicalJobName
- specifies name of the current parallel job.
This name is the same each time you submit the same parallel job.logicalTXID
- specifies a unique identifier for the current parallel job instance.
This identifier defines a logical unit of work in which all subjobs for the current parallel job execute.subJobID
- specifies the unique identifier of a subjob belonging to the current parallel job.subJobReturnCode
- specifies the return code from the specified subjob.
RollbackLogicalTXException
public abstract int getReturnCode(java.lang.String logicalJobName, java.lang.String logicalTXID) throws RollbackLogicalTXException
logicalJobName
- specifies name of the current parallel job.
This name is the same each time you submit the same parallel job.logicalTXID
- specifies a unique identifier for the current parallel job instance.
This identifier defines a logical unit of work in which all subjobs for the current parallel job execute.
RollbackLogicalTXException
public java.lang.String getName()
getName
in class com.ibm.websphere.grid.spi.SPI
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |