public abstract class SubJobAnalyzer extends SPI
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>
<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 and Description |
---|
SubJobAnalyzer() |
Modifier and Type | Method and Description |
---|---|
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()
Returns the name of this SPI instance.
|
abstract int |
getReturnCode(java.lang.String logicalJobName,
java.lang.String logicalTXID)
Returns the final return code for the specified parallel job.
|
compareTo, getInvocationOrder, setInvocationOrder, toString
public abstract void analyze(java.lang.String logicalJobName, java.lang.String logicalTXID, java.lang.String subJobID, java.io.Externalizable subJobData) throws com.ibm.wsspi.batch.parallel.logicalTX.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.com.ibm.wsspi.batch.parallel.logicalTX.RollbackLogicalTXException
public abstract void analyze(java.lang.String logicalJobName, java.lang.String logicalTXID, java.lang.String subJobID, int subJobReturnCode) throws com.ibm.wsspi.batch.parallel.logicalTX.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.com.ibm.wsspi.batch.parallel.logicalTX.RollbackLogicalTXException
public abstract int getReturnCode(java.lang.String logicalJobName, java.lang.String logicalTXID) throws com.ibm.wsspi.batch.parallel.logicalTX.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.com.ibm.wsspi.batch.parallel.logicalTX.RollbackLogicalTXException