com.ibm.wsspi.batch.parallel.status
Class SubJobCollector
- java.lang.Object
com.ibm.websphere.grid.spi.SPI
com.ibm.wsspi.batch.parallel.status.SubJobCollector
All implemented interfaces:
java.lang.Comparable
- public abstract class SubJobCollector
- extends SPI
Implement the SubJobCollector SPI, by extending this class and implementing the collect method.
Configure this SPI with the following declaration in the xd.spi.properties file:
spi.parallel.status.SubJobCollector=<fully-qualified implementation class name>
Notes:
- The xd.spi.properties file is located in:
- The jar file containing the implementation of this SPI should be stored in:
- abstract
- java.io.Externalizable
- java.lang.String
- public SubJobCollector()
- public abstract java.io.Externalizable collect( java.lang.String parallelJobName,
- java.lang.String logicalTXID,
- java.lang.String subJobID)
- public java.lang.String getName( )
<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
Constructor and Description |
---|
SubJobCollector()
|
Method Summary
Modifier and Type | Method and Description |
---|---|
|
collect(java.lang.String parallelJobName,java.lang.String logicalTXID,java.lang.String subJobID)
Collects data for the specified subjob.
|
|
getName()
|
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
SubJobCollector
Method Detail
collect
Collects data for the specified subjob. This data is then transmitted to the ParallelJobManager
for delivery to the SubJobAnalyzer SPI. This method is called immediately before a checkpoint
is taken.
Parameters:
parallelJobName
- 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. Returns:
Externalizable containing data to be delivered by ParallelJobManager to SubJobAnalyzer SPI.
If return value is null, delivery is cancelled and SubJobAnalyzer will not be called.
See Also:
SubJobAnalyzer
getName
Description copied from class:
SPI
Returns the name of this SPI instance. Should return a unique identifier.