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
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
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.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

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.

Operation Detail

getAllJobStatus

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

cancelJob

public void cancelJob(java.lang.String jobID)
cancelJob
Parameters:
jobID - jobID

forcedCancelJob

public void forcedCancelJob(java.lang.String jobID)
Forcibly cancel a job
Parameters:
jobID - jobID

restartJob

public void restartJob(java.lang.String jobID)
restartJob
Parameters:
jobID - jobID

purgeJob

public void purgeJob(java.lang.String jobID)
purgeJob
Parameters:
jobID - jobID

suspendJob

public void suspendJob(java.lang.String jobID, java.lang.String seconds)
suspendJob
Parameters:
jobID - jobID
seconds - seconds to suspend

resumeJob

public void resumeJob(java.lang.String jobID)
resumeJob
Parameters:
jobID - jobID

findBestNodeToDisable

public java.lang.String findBestNodeToDisable(java.lang.String nodeGroupName)
Finds the best node to disable
Parameters:
nodeGroupName - node group name

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

cancelJob

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

restartJob

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

purgeJob

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

suspendJob

public int[] suspendJob(java.lang.String[] jobID, java.lang.String seconds)
suspendJob
Parameters:
jobID - jobID
seconds - seconds to suspend

resumeJob

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

createJobStatusSubject

public void createJobStatusSubject(com.ibm.ws.batch.JobStatusDO[] jsDO)
createJobStatusSubject
Parameters:
jsDO - array of job status data object

getSchedulerName

public java.lang.String getSchedulerName(java.lang.String jobID)
Get name of scheduler who owns this job
Parameters:
jobID - jobID

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

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

getJobUsageBySubmitter

public java.lang.String getJobUsageBySubmitter(java.lang.String submitter)
Get job usage data by submitter
Parameters:
submitter - submitter id

getAllJobUsage

public java.lang.String getAllJobUsage()
Get all job usage data

getJobLog

public java.lang.String getJobLog(java.lang.String jobid)
Gets the name of the zipped job log
Parameters:
jobid - job identifier

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

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

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

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

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

removeJobLog

public void removeJobLog(java.lang.String jobid)
remove the job log zip file associated with the passed jobid
Parameters:
jobid - job identifier

removeRemoteJobLog

public void removeRemoteJobLog(java.lang.String jobid)
remove the job log zip file associated with the passed jobid
Parameters:
jobid - job identifier

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

quiesceLogging

public void quiesceLogging(java.lang.String jobid)
quiesce job logging for the passed jobid
Parameters:
jobid - job identifier

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

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

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)

Copyright IBM Corp. 1996 - 2007