com.ibm.websphere.batch
Class JobStatusJMXNotificationData

java.lang.Object
  extended by com.ibm.websphere.batch.JobStatusJMXNotificationData
All Implemented Interfaces:
java.io.Externalizable, java.io.Serializable

public class JobStatusJMXNotificationData
extends java.lang.Object
implements java.io.Externalizable

Components can register to SchedulerMBean to be notified on job state changes. At least three notifications will be provided for every job during its lifecycle. These are of the types

After a successful submission of a job, job.state.submitted notification will be fired. This notification will contain the job id, job type, submitter id and job status com.ibm.websphere.longrun.JobStatusConstants.SUBMITTED.

When a job is dispatched to an endpoint and begun processing on that endpoint, job.state.started notification will be fired. This notification will include the endpoint name and the start time along with all the information provided as part of the submitted notification.

And when a job reaches a final state (ended or restartable or execution failed state) job.state.ended notification will be fired with end time and return code along with all the information provided in job.state.started notification.

See Also:
Serialized Form

Field Summary
static java.lang.String JOB_STATE_CANCEL_PENDING
           
static java.lang.String JOB_STATE_ENDED
           
static java.lang.String JOB_STATE_RESUME_PENDING
           
static java.lang.String JOB_STATE_STARTED
           
static java.lang.String JOB_STATE_STOP_PENDING
           
static java.lang.String JOB_STATE_STOPPED
           
static java.lang.String JOB_STATE_SUBMIT_PENDING
           
static java.lang.String JOB_STATE_SUBMITTED
           
static java.lang.String JOB_STATE_SUSPEND_PENDING
           
static java.lang.String JOB_STATE_SUSPENDED
           
 
Constructor Summary
JobStatusJMXNotificationData()
           
 
Method Summary
 java.lang.String getEndpointName()
          Gets the name of the endpoint processing this job
 java.lang.String getEndTime()
          Gets the time on endpoint when the job processing ended
 java.lang.String getJobId()
          Gets the job id associated with this notification data
 java.lang.String getJobType()
          Gets the job type associated with this notification data - batch or CI or native execution
 int getRC()
          Gets the return code of the job associated with this notification
 java.lang.String getStartTime()
          Gets the clock time on endpoint when the job processing started
 int getStatus()
          Gets the status of the job associated with this notification
 java.lang.String getStatusText()
          Gets the status in text form of the job associated with this notification
 java.lang.String getSubmitterId()
          Gets the identity of the submitter of this job
 java.lang.String getSuspendedUntil()
          Gets the clock time until which this job is suspended
 void readExternal(java.io.ObjectInput in)
           
 void setEndpointName(java.lang.String endpointName)
           
 void setEndTime(java.lang.String endTime)
           
 void setJobId(java.lang.String jobid)
           
 void setJobType(java.lang.String jobType)
           
 void setRC(int rc)
           
 void setStartTime(java.lang.String startTime)
           
 void setStatus(int status)
           
 void setStatusText(java.lang.String statusText)
           
 void setSubmitter(java.lang.String submitter)
           
 void setSuspendedUtil(java.lang.String suspendedUntil)
           
 java.lang.String toString()
           
 void writeExternal(java.io.ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

JOB_STATE_SUBMITTED

public static final java.lang.String JOB_STATE_SUBMITTED
See Also:
Constant Field Values

JOB_STATE_STARTED

public static final java.lang.String JOB_STATE_STARTED
See Also:
Constant Field Values

JOB_STATE_ENDED

public static final java.lang.String JOB_STATE_ENDED
See Also:
Constant Field Values

JOB_STATE_SUSPEND_PENDING

public static final java.lang.String JOB_STATE_SUSPEND_PENDING
See Also:
Constant Field Values

JOB_STATE_CANCEL_PENDING

public static final java.lang.String JOB_STATE_CANCEL_PENDING
See Also:
Constant Field Values

JOB_STATE_RESUME_PENDING

public static final java.lang.String JOB_STATE_RESUME_PENDING
See Also:
Constant Field Values

JOB_STATE_SUSPENDED

public static final java.lang.String JOB_STATE_SUSPENDED
See Also:
Constant Field Values

JOB_STATE_STOP_PENDING

public static final java.lang.String JOB_STATE_STOP_PENDING
See Also:
Constant Field Values

JOB_STATE_SUBMIT_PENDING

public static final java.lang.String JOB_STATE_SUBMIT_PENDING
See Also:
Constant Field Values

JOB_STATE_STOPPED

public static final java.lang.String JOB_STATE_STOPPED
See Also:
Constant Field Values
Constructor Detail

JobStatusJMXNotificationData

public JobStatusJMXNotificationData()
Method Detail

getJobId

public java.lang.String getJobId()
Gets the job id associated with this notification data


getJobType

public java.lang.String getJobType()
Gets the job type associated with this notification data - batch or CI or native execution


getSubmitterId

public java.lang.String getSubmitterId()
Gets the identity of the submitter of this job


getStatus

public int getStatus()
Gets the status of the job associated with this notification


getEndpointName

public java.lang.String getEndpointName()
Gets the name of the endpoint processing this job


getStartTime

public java.lang.String getStartTime()
Gets the clock time on endpoint when the job processing started


getSuspendedUntil

public java.lang.String getSuspendedUntil()
Gets the clock time until which this job is suspended


getEndTime

public java.lang.String getEndTime()
Gets the time on endpoint when the job processing ended


getRC

public int getRC()
Gets the return code of the job associated with this notification


getStatusText

public java.lang.String getStatusText()
Gets the status in text form of the job associated with this notification


toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
Specified by:
readExternal in interface java.io.Externalizable
Throws:
java.io.IOException
java.lang.ClassNotFoundException

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
Specified by:
writeExternal in interface java.io.Externalizable
Throws:
java.io.IOException

setJobId

public void setJobId(java.lang.String jobid)

setStatus

public void setStatus(int status)

setStatusText

public void setStatusText(java.lang.String statusText)

setRC

public void setRC(int rc)

setSubmitter

public void setSubmitter(java.lang.String submitter)

setJobType

public void setJobType(java.lang.String jobType)

setEndpointName

public void setEndpointName(java.lang.String endpointName)

setStartTime

public void setStartTime(java.lang.String startTime)

setEndTime

public void setEndTime(java.lang.String endTime)

setSuspendedUtil

public void setSuspendedUtil(java.lang.String suspendedUntil)