com.ibm.wsspi.batch.parallel
Class Parameterizer
- java.lang.Object
com.ibm.websphere.grid.spi.SPI
com.ibm.wsspi.batch.parallel.Parameterizer
All implemented interfaces:
java.lang.Comparable
- public abstract class Parameterizer
- extends SPI
Implement the Parameterizer SPI, by extending this class and implementing the parameterize method.
Configure this SPI with the following declaration in the xd.spi.properties file:
spi.parallel.Parameterizer=<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:
- java.lang.String
- abstract
- com.ibm.wsspi.batch.parallel.Parameters
- public Parameterizer()
- public abstract com.ibm.wsspi.batch.parallel.Parameters parameterize( java.lang.String logicalJobName,
- java.lang.String logicalTXID,
- java.util.Properties props)
- 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 to create the classes directory if it does not already exist.
Constructor Summary
Constructor and Description |
---|
Parameterizer()
|
Method Summary
Modifier and Type | Method and Description |
---|---|
|
getName()
|
|
parameterize(java.lang.String logicalJobName,java.lang.String logicalTXID,java.util.Properties props)
Parameterizes a parallel job submission.
|
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
Parameterizer
Method Detail
parameterize
Parameters:
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. props
- specifies the input properties to the parallel job. These properties are user specified, but
must include the reserved property, com.ibm.wsspi.batch.parallel.subjob.name, which specifies the name of the job definition (xJCL)
in the job repository that serves as the template for all subjob instances belonging to this parallel job. Optional reserved property,
com.ibm.wsspi.batch.parallel.logicalTXID, may also be specified to provide an external identifier for the parallel job's logical transaction. Returns:
Parameters object that specifies parameterization for the current parallel job.
This includes the number of subjobs to create for this parallel job instance and an array of Properties objects,
one per subjob, that contains substitution properties for the target subjob xJCL.
The number of elements in this array must equal the specified number of subjobs.
getName
Description copied from class:
SPI
Returns the name of this SPI instance. Should return a unique identifier.
This method is invoked by ParallelJobManager at start of parallel job processing.