BatchGridScheduler MBean

Partial ObjectName:
WebSphere:*,type=BatchGridScheduler


MBean BatchGridScheduler

Management interface for batch/grid Scheduler.


Operation Summary

com.ibm.ws.batch.JobStatusDO[]getAllJobStatus()
           getAllJobStatus
voidcancelJob(java.lang.String jobID)
           cancelJob
voidforcedCancelJob(java.lang.String jobID)
           Forcibly cancel a job
voidrestartJob(java.lang.String jobID)
           restartJob
voidrestartJob(java.lang.String jobID, java.lang.String passedPropertiesString)
           restartJob
voidpurgeJob(java.lang.String jobID)
           purgeJob
voidsuspendJob(java.lang.String jobID, java.lang.String seconds)
           suspendJob
voidresumeJob(java.lang.String jobID)
           resumeJob
java.lang.StringfindBestNodeToDisable(java.lang.String nodeGroupName)
           Finds the best node to disable
java.lang.StringfindBestLocation(java.lang.String dcMemberName, java.lang.String oldNodeName, java.lang.Integer healthCondition)
           Finds the best new location for a DC
int[]cancelJob(java.lang.String[] jobID)
           cancelJob
int[]restartJob(java.lang.String[] jobID)
           restartJob
int[]purgeJob(java.lang.String[] jobID)
           purgeJob
int[]suspendJob(java.lang.String[] jobID, java.lang.String seconds)
           suspendJob
int[]resumeJob(java.lang.String[] jobID)
           resumeJob
voidcreateJobStatusSubject(com.ibm.ws.batch.JobStatusDO[] jsDO)
           createJobStatusSubject
java.lang.StringgetSchedulerName(java.lang.String jobID)
           Get name of scheduler who owns this job
voidupdateJobUsage(com.ibm.ws.batch.sensor.EndpointSensorJob[] jobs)
           Update job usage data in JOBUSAGE database table
java.lang.StringgetJobUsageByJob(java.lang.String jobID, java.lang.Long startTime)
           Get job usage data by job
java.lang.StringgetJobUsageBySubmitter(java.lang.String submitter)
           Get job usage data by submitter
com.ibm.websphere.batch.JobInfogetJobInfo(java.lang.String jobId)
           Get job status and usage information
com.ibm.ws.batch.EndpointInfogetEndpointInfo(java.lang.String endpointName)
           Get information related to an endpoint
java.lang.String[]getAllJobIds(java.lang.String jobIdFilter, java.lang.String submitterFilter, java.lang.Integer jobStateFilter)
           Get a list of all job ids
java.lang.StringgetAllJobUsage()
           Get all job usage data
java.lang.StringgetJobLog(java.lang.String jobid)
           Gets the name of the zipped job log
java.util.ArrayListgetLogMetaData(java.lang.String jobid, java.lang.String requestingScheduler)
           Gets the log meta data associated with the passed jobid
java.util.ArrayListgetLogPartList(java.lang.String jobid, java.lang.String logSubDirName, java.lang.String requestingScheduler)
           Gets the log part list associated with the passed jobid and log directory
java.util.ArrayListgetLogPart(java.lang.String jobid, java.lang.String logSubDirName, java.lang.String partName, java.lang.String requestingScheduler)
           Gets the log part file associated with the passed jobid, log directory, and part file name
java.util.ArrayListgetLogPartFromLine(java.lang.String jobid, java.lang.String logSubDirName, java.lang.String partName, java.lang.Integer startFromLine, java.lang.String requestingScheduler)
           Gets the log part file associated with the passed jobid, log directory, and part file name
java.lang.StringgetJobSize(java.lang.String jobid, java.lang.String logSubDirName)
           Gets the size of the job log associated with the passed jobid and log directory
java.lang.StringgetJobAge(java.lang.String jobid, java.lang.String logSubDirName)
           Gets the age of the job log associated with the passed jobid and log directory
voidremoveJobLog(java.lang.String jobid)
           remove the job log zip file associated with the passed jobid
voidremoveRemoteJobLog(java.lang.String jobid)
           remove the job log zip file associated with the passed jobid
voidpurgeJobLog(java.lang.String jobid, java.lang.String logSubDirName)
           purge the job logs associated with the passed jobid and log directory
voidquiesceLogging(java.lang.String jobid)
           quiesce job logging for the passed jobid
java.lang.String[]cancelBatchJobs(java.lang.String node, java.lang.String server, java.lang.String application)
           get the states of server applications
voidwriteSMF(com.ibm.ws.batch.JobUsageDO[] juDO, java.lang.Integer recordCount)
           writeSMF
voidtakeOverSchedulerJobs(java.lang.String schedulerNodeName, java.lang.String schedulerServerName)
           take over jobs from scheduler
voidsendStepNotification(java.lang.String type, com.ibm.websphere.batch.StepStatusJMXNotificationData StepStatusJMXNotificationData)
           send job step JMX notification from scheduler

Notification Summary

job.state.started
           Indicates a compute grid job has started.
step.state.started
           Indicates a compute grid job step has started.
step.state.ended
           Indicates a compute grid job step has ended.
job.state.ended
           Indicates a compute grid job has ended.
job.state.suspend.pending
           Job in suspend pending
job.state.resume.pending
           Job in resume pending
job.state.cancel.pending
           Job in cancel pending
job.state.submit.pending
           Job in submit pending
job.state.stop.pending
           Job in stop pending
job.state.suspended
           Job is suspended
job.state.submitted
           Job is submitted
job.state.cancelled
           Job is cancelled
job.state.stopped
           Job is stopped
parallel.job.complete
           parallel.

Operation Detail

getAllJobStatus

public com.ibm.ws.batch.JobStatusDO[] getAllJobStatus()

     getAllJobStatus

Security Roles:

     administrator
     operator


cancelJob

public void cancelJob(java.lang.String jobID)

     cancelJob

Parameters:

     jobID - jobID

Security Roles:

     administrator
     operator


forcedCancelJob

public void forcedCancelJob(java.lang.String jobID)

     Forcibly cancel a job

Parameters:

     jobID - jobID

Security Roles:

     administrator
     operator


restartJob

public void restartJob(java.lang.String jobID)

     restartJob

Parameters:

     jobID - jobID

Security Roles:

     administrator
     operator


restartJob

public void restartJob(java.lang.String jobID, java.lang.String passedPropertiesString)

     restartJob

Parameters:

     jobID - jobID
     passedPropertiesString - passedPropertiesString

Security Roles:

     administrator
     operator


purgeJob

public void purgeJob(java.lang.String jobID)

     purgeJob

Parameters:

     jobID - jobID

Security Roles:

     administrator
     operator


suspendJob

public void suspendJob(java.lang.String jobID, java.lang.String seconds)

     suspendJob

Parameters:

     jobID - jobID
     seconds - seconds to suspend

Security Roles:

     administrator
     operator


resumeJob

public void resumeJob(java.lang.String jobID)

     resumeJob

Parameters:

     jobID - jobID

Security Roles:

     administrator
     operator


findBestNodeToDisable

public java.lang.String findBestNodeToDisable(java.lang.String nodeGroupName)

     Finds the best node to disable

Parameters:

     nodeGroupName - node group name

Security Roles:

     administrator
     operator


findBestLocation

public java.lang.String findBestLocation(java.lang.String dcMemberName, java.lang.String oldNodeName, java.lang.Integer healthCondition)

     Finds the best new location for a DC

Parameters:

     dcMemberName - DC Member name
     oldNodeName - old node name
     healthCondition - health condition encountered

Security Roles:

     administrator
     operator


cancelJob

public int[] cancelJob(java.lang.String[] jobID)

     cancelJob

Parameters:

     jobID - jobID

Security Roles:

     administrator
     operator


restartJob

public int[] restartJob(java.lang.String[] jobID)

     restartJob

Parameters:

     jobID - jobID

Security Roles:

     administrator
     operator


purgeJob

public int[] purgeJob(java.lang.String[] jobID)

     purgeJob

Parameters:

     jobID - jobID

Security Roles:

     administrator
     operator


suspendJob

public int[] suspendJob(java.lang.String[] jobID, java.lang.String seconds)

     suspendJob

Parameters:

     jobID - jobID
     seconds - seconds to suspend

Security Roles:

     administrator
     operator


resumeJob

public int[] resumeJob(java.lang.String[] jobID)

     resumeJob

Parameters:

     jobID - jobID

Security Roles:

     administrator
     operator


createJobStatusSubject

public void createJobStatusSubject(com.ibm.ws.batch.JobStatusDO[] jsDO)

     createJobStatusSubject

Parameters:

     jsDO - array of job status data object

Security Roles:

     administrator
     operator


getSchedulerName

public java.lang.String getSchedulerName(java.lang.String jobID)

     Get name of scheduler who owns this job

Parameters:

     jobID - jobID

Security Roles:

     administrator
     operator


updateJobUsage

public void updateJobUsage(com.ibm.ws.batch.sensor.EndpointSensorJob[] jobs)

     Update job usage data in JOBUSAGE database table

Parameters:

     jobs - an array of job usage data to be created or updated

Security Roles:

     administrator
     operator


getJobUsageByJob

public java.lang.String getJobUsageByJob(java.lang.String jobID, java.lang.Long startTime)

     Get job usage data by job

Parameters:

     jobID - jobID
     startTime - time job started

Security Roles:

     administrator
     operator


getJobUsageBySubmitter

public java.lang.String getJobUsageBySubmitter(java.lang.String submitter)

     Get job usage data by submitter

Parameters:

     submitter - submitter id

Security Roles:

     administrator
     operator


getJobInfo

public com.ibm.websphere.batch.JobInfo getJobInfo(java.lang.String jobId)

     Get job status and usage information

Parameters:

     jobId - job id

Security Roles:

     administrator
     operator


getEndpointInfo

public com.ibm.ws.batch.EndpointInfo getEndpointInfo(java.lang.String endpointName)

     Get information related to an endpoint

Parameters:

     endpointName - endpoint Name

Security Roles:

     administrator
     operator


getAllJobIds

public java.lang.String[] getAllJobIds(java.lang.String jobIdFilter, java.lang.String submitterFilter, java.lang.Integer jobStateFilter)

     Get a list of all job ids

Parameters:

     jobIdFilter - job identifier filter
     submitterFilter - job submitter id filter
     jobStateFilter - job state filter

Security Roles:

     administrator
     operator


getAllJobUsage

public java.lang.String getAllJobUsage()

     Get all job usage data

Security Roles:

     administrator
     operator


getJobLog

public java.lang.String getJobLog(java.lang.String jobid)

     Gets the name of the zipped job log

Parameters:

     jobid - job identifier

Security Roles:

     administrator
     operator


getLogMetaData

public java.util.ArrayList getLogMetaData(java.lang.String jobid, java.lang.String requestingScheduler)

     Gets the log meta data associated with the passed jobid

Parameters:

     jobid - job identifier
     requestingScheduler - requesting scheduler name

Security Roles:

     administrator
     operator


getLogPartList

public java.util.ArrayList getLogPartList(java.lang.String jobid, java.lang.String logSubDirName, java.lang.String requestingScheduler)

     Gets the log part list associated with the passed jobid and log directory

Parameters:

     jobid - job identifier
     logSubDirName - log subdirectory name
     requestingScheduler - requesting scheduler name

Security Roles:

     administrator
     operator


getLogPart

public java.util.ArrayList getLogPart(java.lang.String jobid, java.lang.String logSubDirName, java.lang.String partName, java.lang.String requestingScheduler)

     Gets the log part file associated with the passed jobid, log directory, and part file name

Parameters:

     jobid - job identifier
     logSubDirName - log subdirectory name
     partName - log part file name
     requestingScheduler - requesting scheduler name

Security Roles:

     administrator
     operator


getLogPartFromLine

public java.util.ArrayList getLogPartFromLine(java.lang.String jobid, java.lang.String logSubDirName, java.lang.String partName, java.lang.Integer startFromLine, java.lang.String requestingScheduler)

     Gets the log part file associated with the passed jobid, log directory, and part file name

Parameters:

     jobid - job identifier
     logSubDirName - log subdirectory name
     partName - log part file name
     startFromLine - start line to retrieve log
     requestingScheduler - requesting scheduler name

Security Roles:

     administrator
     operator


getJobSize

public java.lang.String getJobSize(java.lang.String jobid, java.lang.String logSubDirName)

     Gets the size of the job log associated with the passed jobid and log directory

Parameters:

     jobid - job identifier
     logSubDirName - log subdirectory name

Security Roles:

     administrator
     operator


getJobAge

public java.lang.String getJobAge(java.lang.String jobid, java.lang.String logSubDirName)

     Gets the age of the job log associated with the passed jobid and log directory

Parameters:

     jobid - job identifier
     logSubDirName - log subdirectory name

Security Roles:

     administrator
     operator


removeJobLog

public void removeJobLog(java.lang.String jobid)

     remove the job log zip file associated with the passed jobid

Parameters:

     jobid - job identifier

Security Roles:

     administrator
     operator


removeRemoteJobLog

public void removeRemoteJobLog(java.lang.String jobid)

     remove the job log zip file associated with the passed jobid

Parameters:

     jobid - job identifier

Security Roles:

     administrator
     operator


purgeJobLog

public void purgeJobLog(java.lang.String jobid, java.lang.String logSubDirName)

     purge the job logs associated with the passed jobid and log directory

Parameters:

     jobid - job identifier
     logSubDirName - log subdirectory name

Security Roles:

     administrator
     operator


quiesceLogging

public void quiesceLogging(java.lang.String jobid)

     quiesce job logging for the passed jobid

Parameters:

     jobid - job identifier

Security Roles:

     administrator
     operator


cancelBatchJobs

public java.lang.String[] cancelBatchJobs(java.lang.String node, java.lang.String server, java.lang.String application)

     get the states of server applications

Parameters:

     node - node name
     server - server name
     application - application name

Security Roles:

     administrator
     operator


writeSMF

public void writeSMF(com.ibm.ws.batch.JobUsageDO[] juDO, java.lang.Integer recordCount)

     writeSMF

Parameters:

     juDO - array of job usage data object
     recordCount - count of job usage data objects for ended jobs

Security Roles:

     administrator
     operator


takeOverSchedulerJobs

public void takeOverSchedulerJobs(java.lang.String schedulerNodeName, java.lang.String schedulerServerName)

     take over jobs from scheduler

Parameters:

     schedulerNodeName - name of the down scheduler node
     schedulerServerName - name of the down scheduler server

Security Roles:

     administrator
     operator


sendStepNotification

public void sendStepNotification(java.lang.String type, com.ibm.websphere.batch.StepStatusJMXNotificationData StepStatusJMXNotificationData)

     send job step JMX notification from scheduler

Parameters:

     type - notification type
     StepStatusJMXNotificationData - step status notification object

Security Roles:

     administrator
     operator


Notification Detail

job.state.started

     Indicates a compute grid job has started.

Severity:

6  (Normal, Cleared, or Informative)


step.state.started

     Indicates a compute grid job step has started.

Severity:

6  (Normal, Cleared, or Informative)


step.state.ended

     Indicates a compute grid job step has ended.

Severity:

6  (Normal, Cleared, or Informative)


job.state.ended

     Indicates a compute grid job has ended.

Severity:

6  (Normal, Cleared, or Informative)


job.state.suspend.pending

     Job in suspend pending

Severity:

6  (Normal, Cleared, or Informative)


job.state.resume.pending

     Job in resume pending

Severity:

6  (Normal, Cleared, or Informative)


job.state.cancel.pending

     Job in cancel pending

Severity:

6  (Normal, Cleared, or Informative)


job.state.submit.pending

     Job in submit pending

Severity:

6  (Normal, Cleared, or Informative)


job.state.stop.pending

     Job in stop pending

Severity:

6  (Normal, Cleared, or Informative)


job.state.suspended

     Job is suspended

Severity:

6  (Normal, Cleared, or Informative)


job.state.submitted

     Job is submitted

Severity:

6  (Normal, Cleared, or Informative)


job.state.cancelled

     Job is cancelled

Severity:

6  (Normal, Cleared, or Informative)


job.state.stopped

     Job is stopped

Severity:

6  (Normal, Cleared, or Informative)


parallel.job.complete

     parallel.job.complete

Severity:

6  (Normal, Cleared, or Informative)


Copyright IBM Corporation 2002, 2012