SchedulerSR MBean

Partial ObjectName:
WebSphere:*,type=SchedulerSR


MBean SchedulerSR

CR interface for LongRunning Scheduler functions in specific SR


Operation Summary
java.lang.StringrequeueSubmissions()
           Returns a unique jobID
java.lang.Integerdispatch(com.ibm.ws.longrun.Job job, com.ibm.ws.longrun.EndPoint endpoint)
           Dispatches a job
java.lang.StringgetJobID(java.lang.String jobName)
           Returns a unique jobID
com.ibm.ws.batch.JobStatusDOupdateJobStatus()
           Updates a job's status in the LRS
com.ibm.ws.batch.JobStatusDOsetJobState(java.lang.String jobID, java.lang.String newState)
           Sets job's status in the LRS
voidjobStatusUpdate(java.lang.String msg)
           Updates a job's status in the LRS
voidmarkFailedServerJobs(java.lang.String endpoint)
           Sets job's status in the LRS to restartable state
voidjobStatusResubscribe(java.lang.String endpoint)
           Initiates endpoint job status listener in the LRS for the job which was executing
com.ibm.ws.batch.JobStatusDO[]getAllJobsByStatus(java.lang.Integer status)
           get all jobs by status
java.lang.StringgetxJCLSource(java.lang.String jobID)
           get xJCL source based on jobid
voidrecreateRecurringRequestAlarms()
           recreate alarms for Recurring Requests in the system after a scheduler restart
java.lang.StringsubmitRecurringJobFromRepository(java.lang.String jobName, java.lang.String startTime, java.lang.String nameValuePairs, java.lang.String submitter)
           submit a recurring job based on a job in the job repository
voidscheduleJob(java.lang.String jobid, java.lang.String submitter)
           schedule a job given a jobid
com.ibm.ws.batch.RecurringRequestDO[]getAllRecurringRequests()
           get all recurring requests
com.ibm.ws.longrun.JobsetEpsCounters(com.ibm.ws.longrun.Job job)
           Sets EPS counter values for a job
voidsetSystemStreams(java.lang.String schedulerName)
           Sets System.
java.lang.BooleancreateJobProfile(java.lang.String jobClass)
           Create a new job profile if one does not exists
com.ibm.ws.batch.JobProfileDOretrieveJobProfile(java.lang.String jobClass)
           Retrieve job profile for job class
java.lang.BooleandeleteJobProfile(java.lang.String jobClass)
           Delete a job profile
voidupdateJobProfile(com.ibm.ws.batch.JobProfileDO profile, java.lang.Long lastUpdate)
           Update an existing job profile
java.lang.BooleanincrementOutStandingJobs(java.lang.String jobClass, java.lang.Integer maxCount)
           Increment number of outstanding jobs for a class
voiddecrementOutStandingJobs(java.lang.String jobClass)
           Decrement number of outstanding jobs for a class
voidaddJobToJobClassExeRecTable(java.lang.String jobID, java.lang.String jobClass, java.lang.Long time)
           Add job to class
voidremoveJobFromJobClassExeRecTable(java.lang.String[] jobID)
           Remove job from class
voidenforceJobOutputQueueLimits(java.lang.String jobClassName, java.lang.Integer maxCount, java.lang.Integer maxAge)
           Enforce queue limits
voidupdateJobUsage(com.ibm.ws.batch.sensor.EndpointSensorJob[] jobs)
           Update job usage
java.lang.StringgetJobUsageBySubmitter(java.lang.String submitter)
           Get job usage by submitter
java.lang.StringgetJobUsageByJob(java.lang.String jobid, java.lang.Long startTime)
           Get job usage by job
java.lang.StringgetAllJobUsage()
           Get all job usage
voidjobLog(java.lang.String jobID, java.lang.String message)
           log a job message
java.lang.BooleanlogUsingProbe(java.lang.String jobID, java.lang.String probe, java.lang.String className, java.lang.Object[] details)
           log a job message using classname and probe
voidlog(java.lang.String jobID, java.lang.String message)
           log a job message
java.lang.StringgetOwningScheduler(java.lang.String jobID)
           get the job owning scheduler

Operation Detail

requeueSubmissions

public java.lang.String requeueSubmissions()
Returns a unique jobID

dispatch

public java.lang.Integer dispatch(com.ibm.ws.longrun.Job job, com.ibm.ws.longrun.EndPoint endpoint)
Dispatches a job
Parameters:
job - Job to dispatch
endpoint - Target Endpoint

getJobID

public java.lang.String getJobID(java.lang.String jobName)
Returns a unique jobID
Parameters:
jobName - Job name

updateJobStatus

public com.ibm.ws.batch.JobStatusDO updateJobStatus()
Updates a job's status in the LRS

setJobState

public com.ibm.ws.batch.JobStatusDO setJobState(java.lang.String jobID, java.lang.String newState)
Sets job's status in the LRS
Parameters:
jobID - the job id
newState - the state

jobStatusUpdate

public void jobStatusUpdate(java.lang.String msg)
Updates a job's status in the LRS
Parameters:
msg - the status message

markFailedServerJobs

public void markFailedServerJobs(java.lang.String endpoint)
Sets job's status in the LRS to restartable state
Parameters:
endpoint - The failing endpoint name

jobStatusResubscribe

public void jobStatusResubscribe(java.lang.String endpoint)
Initiates endpoint job status listener in the LRS for the job which was executing
Parameters:
endpoint - The endpoint name which was executing the job when the scheduler failed

getAllJobsByStatus

public com.ibm.ws.batch.JobStatusDO[] getAllJobsByStatus(java.lang.Integer status)
get all jobs by status
Parameters:
status - job status

getxJCLSource

public java.lang.String getxJCLSource(java.lang.String jobID)
get xJCL source based on jobid
Parameters:
jobID - the job id

recreateRecurringRequestAlarms

public void recreateRecurringRequestAlarms()
recreate alarms for Recurring Requests in the system after a scheduler restart

submitRecurringJobFromRepository

public java.lang.String submitRecurringJobFromRepository(java.lang.String jobName, java.lang.String startTime, java.lang.String nameValuePairs, java.lang.String submitter)
submit a recurring job based on a job in the job repository
Parameters:
jobName - the job name
startTime - time to start job
nameValuePairs - symbolic variable name value pairs
submitter - submitter

scheduleJob

public void scheduleJob(java.lang.String jobid, java.lang.String submitter)
schedule a job given a jobid
Parameters:
jobid - the job id
submitter - the job submitter id

getAllRecurringRequests

public com.ibm.ws.batch.RecurringRequestDO[] getAllRecurringRequests()
get all recurring requests

setEpsCounters

public com.ibm.ws.longrun.Job setEpsCounters(com.ibm.ws.longrun.Job job)
Sets EPS counter values for a job
Parameters:
job - Job for counters

setSystemStreams

public void setSystemStreams(java.lang.String schedulerName)
Sets System.out and System.err streams for Batch File Logging
Parameters:
schedulerName - The Job Scheduler name

createJobProfile

public java.lang.Boolean createJobProfile(java.lang.String jobClass)
Create a new job profile if one does not exists
Parameters:
jobClass - Name of job class

retrieveJobProfile

public com.ibm.ws.batch.JobProfileDO retrieveJobProfile(java.lang.String jobClass)
Retrieve job profile for job class
Parameters:
jobClass - Name of job class

deleteJobProfile

public java.lang.Boolean deleteJobProfile(java.lang.String jobClass)
Delete a job profile
Parameters:
jobClass - Name of job class

updateJobProfile

public void updateJobProfile(com.ibm.ws.batch.JobProfileDO profile, java.lang.Long lastUpdate)
Update an existing job profile
Parameters:
profile - updated profile
lastUpdate - last update time

incrementOutStandingJobs

public java.lang.Boolean incrementOutStandingJobs(java.lang.String jobClass, java.lang.Integer maxCount)
Increment number of outstanding jobs for a class
Parameters:
jobClass - Job Class
maxCount - max count

decrementOutStandingJobs

public void decrementOutStandingJobs(java.lang.String jobClass)
Decrement number of outstanding jobs for a class
Parameters:
jobClass - Job Class

addJobToJobClassExeRecTable

public void addJobToJobClassExeRecTable(java.lang.String jobID, java.lang.String jobClass, java.lang.Long time)
Add job to class
Parameters:
jobID - Job ID
jobClass - Job Class
time - time

removeJobFromJobClassExeRecTable

public void removeJobFromJobClassExeRecTable(java.lang.String[] jobID)
Remove job from class
Parameters:
jobID - Array of Job IDs

enforceJobOutputQueueLimits

public void enforceJobOutputQueueLimits(java.lang.String jobClassName, java.lang.Integer maxCount, java.lang.Integer maxAge)
Enforce queue limits
Parameters:
jobClassName - Job Class name
maxCount - max count
maxAge - max age

updateJobUsage

public void updateJobUsage(com.ibm.ws.batch.sensor.EndpointSensorJob[] jobs)
Update job usage
Parameters:
jobs - update job usage

getJobUsageBySubmitter

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

getJobUsageByJob

public java.lang.String getJobUsageByJob(java.lang.String jobid, java.lang.Long startTime)
Get job usage by job
Parameters:
jobid - job id
startTime - job start time

getAllJobUsage

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

jobLog

public void jobLog(java.lang.String jobID, java.lang.String message)
log a job message
Parameters:
jobID - job identifier
message - message text

logUsingProbe

public java.lang.Boolean logUsingProbe(java.lang.String jobID, java.lang.String probe, java.lang.String className, java.lang.Object[] details)
log a job message using classname and probe
Parameters:
jobID - job identifier
probe - probe identifier
className - caller class name
details - array of message substitution details

log

public void log(java.lang.String jobID, java.lang.String message)
log a job message
Parameters:
jobID - job identifier
message - message text

getOwningScheduler

public java.lang.String getOwningScheduler(java.lang.String jobID)
get the job owning scheduler
Parameters:
jobID - job identifier

Copyright IBM Corp. 1996 - 2007