public class JobStepContext
extends com.ibm.ws.batch.context.JobStepContextBase
Constructor and Description |
---|
JobStepContext() |
Modifier and Type | Method and Description |
---|---|
void |
addRetryListener(RetryListener retryListener) |
java.lang.String |
getJobID()
Returns job name of current job.
|
java.io.Externalizable |
getJobLevelPersistentUserData()
Return the persistent job-level user data object for this job
|
java.util.Properties |
getJobLevelProperties() |
java.lang.Object |
getJobLevelTransientUserData()
Return the transient job-level user data object for this job
|
java.lang.Object |
getJobLevelUserData()
Deprecated.
Please use getJobLevelTransientUserData APIs instead.
|
java.util.Properties |
getJobListenerProperties()
Return the job-level properties object
|
JobStepID |
getJobStepID()
Returns JobStepID object for current step.
|
RecordMetrics |
getRecordMetrics(java.lang.String bdsname)
Return the bds-level metrics (skip and records per second)
|
int |
getReturnCode()
Return the return code explicitly set by the user using setReturnCode.
|
java.sql.Connection |
getSharedSQLConnection() |
java.lang.String |
getStepID()
Returns step name of current step.
|
java.io.Externalizable |
getStepLevelPersistentData()
Deprecated.
Please use getJobLevelPersistentUserData API instead.
|
java.lang.Object |
getStepLevelTransientUserData()
Returns the transient user data stored in this context for this step
|
StepMetrics |
getStepMetrics()
Return the step-level metrics (time and retry)
|
java.lang.String |
getSubmitterID()
Return the user id of the user who submits this job
|
java.lang.String |
getUserAccountingId()
Return the accounting id set by the user in the submitted xJCL
|
com.ibm.batch.spi.IUserControlledTransaction |
getUserControlledTransaction() |
java.lang.Object |
getUserData()
Deprecated.
Please use getStepLevelTransientUserData API instead.
|
java.lang.Object |
getUserException()
Return any exception thrown during processJobStep saved by the runtime
|
void |
setJobLevelPersistentUserData(java.io.Externalizable ext)
Return the persistent job-level user data object for this job
|
void |
setJobLevelTransientUserData(java.lang.Object obj)
Set the transient job-level user data object for this job
|
void |
setJobLevelUserData(java.lang.Object o)
Deprecated.
Please use setJobLevelTransientUserData API instead.
|
void |
setReturnCode(int rc)
To be used mainly by CI jobs to communicate return code back to the caller.
|
void |
setStepLevelPersistentData(java.io.Externalizable o)
Deprecated.
Please use setJobLevelPesistentUserData API instead.
|
void |
setStepLevelTransientUserData(java.lang.Object obj)
Set the transient user data stored in this context for this step
|
void |
setUserAccountingId(java.lang.String o)
Deprecated.
This interface will likely be removed in a future release.
|
void |
setUserControlledTransaction(com.ibm.batch.spi.IUserControlledTransaction uTran) |
void |
setUserData(java.lang.Object o)
Deprecated.
Please use setStepLevelTransientUserData API instead.
|
void |
setUserException(java.lang.Object o)
Exceptions thrown while executing user code can be saved in the context
using this method
|
clearRecordMetrics, getPOJOStep, getProperties, getRecordMetrics, getRetryHandler, isReturnCodeSet, serializeRecordMetrics, serializeStepLevelData, setIsReturnCodeSet, setJobID, setJobLevelProperties, setJobListenerProperties, setPOJOStep, setProperties, setRecordMetrics, setRecordMetricsFromBlob, setRetryHandler, setSharedSQLConnection, setStepID, setStepLevelDataFromBlob, setStepMetrics, setSubmitterID
public com.ibm.batch.spi.IUserControlledTransaction getUserControlledTransaction()
getUserControlledTransaction
in interface com.ibm.batch.api.context.JobStepContext
getUserControlledTransaction
in class com.ibm.ws.batch.context.JobStepContextBase
public void setUserControlledTransaction(com.ibm.batch.spi.IUserControlledTransaction uTran)
setUserControlledTransaction
in class com.ibm.ws.batch.context.JobStepContextBase
@Deprecated public java.lang.Object getUserData()
getUserData
in interface com.ibm.batch.api.context.JobStepContext
getUserData
in class com.ibm.ws.batch.context.JobStepContextBase
@Deprecated public void setUserData(java.lang.Object o)
setUserData
in interface com.ibm.batch.api.context.JobStepContext
setUserData
in class com.ibm.ws.batch.context.JobStepContextBase
user
- data objectpublic java.lang.String getJobID()
getJobID
in interface com.ibm.batch.api.context.JobStepContext
getJobID
in class com.ibm.ws.batch.context.JobStepContextBase
public java.lang.String getStepID()
getStepID
in interface com.ibm.batch.api.context.JobStepContext
getStepID
in class com.ibm.ws.batch.context.JobStepContextBase
public JobStepID getJobStepID()
getJobStepID
in interface com.ibm.batch.api.context.JobStepContext
getJobStepID
in class com.ibm.ws.batch.context.JobStepContextBase
public java.lang.Object getUserException()
getUserException
in interface com.ibm.batch.api.context.JobStepContext
getUserException
in class com.ibm.ws.batch.context.JobStepContextBase
public void setUserException(java.lang.Object o)
setUserException
in class com.ibm.ws.batch.context.JobStepContextBase
o
- public int getReturnCode()
getReturnCode
in interface com.ibm.batch.api.context.JobStepContext
getReturnCode
in class com.ibm.ws.batch.context.JobStepContextBase
public void setReturnCode(int rc)
setReturnCode
in interface com.ibm.batch.api.context.JobStepContext
setReturnCode
in class com.ibm.ws.batch.context.JobStepContextBase
rc
- public java.lang.String getUserAccountingId()
getUserAccountingId
in interface com.ibm.batch.api.context.JobStepContext
getUserAccountingId
in class com.ibm.ws.batch.context.JobStepContextBase
@Deprecated public void setUserAccountingId(java.lang.String o)
setUserAccountingId
in class com.ibm.ws.batch.context.JobStepContextBase
o
- public java.util.Properties getJobListenerProperties()
getJobListenerProperties
in interface com.ibm.batch.api.context.JobStepContext
getJobListenerProperties
in class com.ibm.ws.batch.context.JobStepContextBase
@Deprecated public java.lang.Object getJobLevelUserData()
getJobLevelUserData
in interface com.ibm.batch.api.context.JobStepContext
getJobLevelUserData
in class com.ibm.ws.batch.context.JobStepContextBase
@Deprecated public void setJobLevelUserData(java.lang.Object o)
setJobLevelUserData
in interface com.ibm.batch.api.context.JobStepContext
setJobLevelUserData
in class com.ibm.ws.batch.context.JobStepContextBase
job-level
- user data object@Deprecated public java.io.Externalizable getStepLevelPersistentData()
getStepLevelPersistentData
in interface com.ibm.batch.api.context.JobStepContext
getStepLevelPersistentData
in class com.ibm.ws.batch.context.JobStepContextBase
@Deprecated public void setStepLevelPersistentData(java.io.Externalizable o)
setStepLevelPersistentData
in interface com.ibm.batch.api.context.JobStepContext
setStepLevelPersistentData
in class com.ibm.ws.batch.context.JobStepContextBase
step-level
- user data objectpublic StepMetrics getStepMetrics()
getStepMetrics
in interface com.ibm.batch.api.context.JobStepContext
getStepMetrics
in class com.ibm.ws.batch.context.JobStepContextBase
public RecordMetrics getRecordMetrics(java.lang.String bdsname)
getRecordMetrics
in interface com.ibm.batch.api.context.JobStepContext
getRecordMetrics
in class com.ibm.ws.batch.context.JobStepContextBase
public void addRetryListener(RetryListener retryListener)
addRetryListener
in interface com.ibm.batch.api.context.JobStepContext
addRetryListener
in class com.ibm.ws.batch.context.JobStepContextBase
public java.util.Properties getJobLevelProperties()
getJobLevelProperties
in interface com.ibm.batch.api.context.JobStepContext
getJobLevelProperties
in class com.ibm.ws.batch.context.JobStepContextBase
public java.sql.Connection getSharedSQLConnection()
getSharedSQLConnection
in interface com.ibm.batch.api.context.JobStepContext
getSharedSQLConnection
in class com.ibm.ws.batch.context.JobStepContextBase
public java.lang.Object getJobLevelTransientUserData()
public void setJobLevelTransientUserData(java.lang.Object obj)
user
- data objectpublic java.lang.Object getStepLevelTransientUserData()
public void setStepLevelTransientUserData(java.lang.Object obj)
user
- data objectpublic java.io.Externalizable getJobLevelPersistentUserData()
public void setJobLevelPersistentUserData(java.io.Externalizable ext)
persistent
- job-level user data objectpublic java.lang.String getSubmitterID()
getSubmitterID
in interface com.ibm.batch.api.context.JobStepContext
getSubmitterID
in class com.ibm.ws.batch.context.JobStepContextBase