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, java.util.List permittedEndpoints)
           Dispatches a job
java.lang.StringgetJobID(java.lang.String jobName, java.lang.Integer jobNumber)
           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
voidprocessPGCJobStatus(com.ibm.ws.gridcontainer.communication.StatusUpdateMessage update)
           Process a job status message coming from proxy servlet
voidprocessJobStatusMessage(java.lang.String msg)
           Process a job status message coming from Global Job Ststus Listener
voidmarkFailedServerJobs(java.lang.String endpoint)
           Sets job's status in the LRS to restartable state
voidmarkFailedPGCServerJobs(java.lang.String endpoint)
           Sets job's status from PGC endpoint 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, java.lang.String message)
           log a job message
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.StringchkSection(java.lang.String jobSubDir)
           Returns job log section
java.util.ArrayListqueryJobsByClass(java.lang.String jobClass, java.lang.String jobToSearchFor)
           Query jobs by job class
voidcleanupClassList(java.lang.String partInfo)
           Remove job from class table
voidcleanupLogList(java.lang.String jobID)
           Remove job from log table
java.lang.StringgetOwningScheduler(java.lang.String jobID)
           get the job owning scheduler
voidupdateOwningScheduler(java.lang.String jobID, java.lang.String newSchedulerName)
           update the job owning scheduler
java.lang.IntegerupdateOwningScheduler(java.lang.String jobID, java.lang.String newSchedulerName, java.lang.String oldSchedulerName)
           update the job owning scheduler
voidupdateRRsOwningScheduler(com.ibm.ws.batch.RecurringRequestDO rrDO, java.lang.String oldSchedulerName)
           update a schedule's owning scheduler
com.ibm.ws.batch.JobUsageDO[]getJobUsageByJobIdOfAllStartTime(java.lang.String jobid)
           Get job usage by job id
voidprocessStepStatusMessage(java.lang.String msgTxt)
           process a job's step status message
java.util.ListgetOwnedJobsInNonFinalState(java.lang.String endpointName)
           Get list of jobs in non final state in the endpoint
voidsendStepStatusJMXNotification(java.lang.String notificationType, java.lang.String jobId, java.lang.String stepName, java.lang.String startTime, java.lang.String endTime, java.lang.Integer statusCode, java.lang.Integer rc)
           Send step status JMX notification
voidqueued(java.lang.String txc, java.lang.String app, java.lang.String module)
           PMI stat queued
voiddispatched(java.lang.String txc, java.lang.String app, java.lang.String module, java.lang.Long timeInQueue, java.lang.Long timeToDispatch)
           PMI stat dispatched
voiddispatchError(java.lang.String txc, java.lang.String app, java.lang.String module, java.lang.Long errTime)
           PMI stat dispatch error
voiddispatchFailed(java.lang.String txc, java.lang.String app, java.lang.String module, java.lang.Long timeInQueue)
           PMI stat dispatch failed
voidjobCompleted(java.lang.String txc, java.lang.String app, java.lang.String module)
           PMI stat job completed
voidremovedFromQueue(java.lang.String txc, java.lang.String app, java.lang.String module)
           PMI stat job removed from queue
voidexecuteRedoList(java.lang.String endpointName)
           Execute jobs that are currently in the redo list for this endpoint
java.lang.LonggetLastRunTimeFromDB(java.lang.String jobClass)
           get lastRunTime value from DB
voidstartThreadToRunCapacityLeakDetection(java.lang.Boolean recoverCapacity, java.lang.Boolean isFirstRun)
           Start thread to run job class capacity leak detection
voidsaveJobLogSectionFromCR(java.lang.String logSubDir, java.lang.String server, java.lang.String node, java.lang.String logDir)
           save job log section, caller is from CR

Operation Detail

requeueSubmissions

public java.lang.String requeueSubmissions()
Returns a unique jobID
Security Roles:
administrator
operator

dispatch

public java.lang.Integer dispatch(com.ibm.ws.longrun.Job job, java.util.List permittedEndpoints)
Dispatches a job
Parameters:
job - Job to dispatch
permittedEndpoints - List of permitted endpoints ordered by best equalization line
Security Roles:
administrator
operator

getJobID

public java.lang.String getJobID(java.lang.String jobName, java.lang.Integer jobNumber)
Returns a unique jobID
Parameters:
jobName - Job name
jobNumber - Job sequence number
Security Roles:
administrator
operator

updateJobStatus

public com.ibm.ws.batch.JobStatusDO updateJobStatus()
Updates a job's status in the LRS
Security Roles:
administrator
operator

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
Security Roles:
administrator
operator

processPGCJobStatus

public void processPGCJobStatus(com.ibm.ws.gridcontainer.communication.StatusUpdateMessage update)
Process a job status message coming from proxy servlet
Parameters:
update - the status object
Security Roles:
administrator
operator

processJobStatusMessage

public void processJobStatusMessage(java.lang.String msg)
Process a job status message coming from Global Job Ststus Listener
Parameters:
msg - the status message
Security Roles:
administrator
operator

markFailedServerJobs

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

markFailedPGCServerJobs

public void markFailedPGCServerJobs(java.lang.String endpoint)
Sets job's status from PGC endpoint in the LRS to restartable state
Parameters:
endpoint - The failing endpoint name
Security Roles:
administrator
operator

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
Security Roles:
administrator
operator

getAllJobsByStatus

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

getxJCLSource

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

recreateRecurringRequestAlarms

public void recreateRecurringRequestAlarms()
recreate alarms for Recurring Requests in the system after a scheduler restart
Security Roles:
administrator
operator

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
Security Roles:
administrator
operator

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
Security Roles:
administrator
operator

getAllRecurringRequests

public com.ibm.ws.batch.RecurringRequestDO[] getAllRecurringRequests()
get all recurring requests
Security Roles:
administrator
operator

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
Security Roles:
administrator
operator

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
Security Roles:
administrator
operator

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
Security Roles:
administrator
operator

retrieveJobProfile

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

deleteJobProfile

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

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
Security Roles:
administrator
operator

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
Security Roles:
administrator
operator

decrementOutStandingJobs

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

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
Security Roles:
administrator
operator

removeJobFromJobClassExeRecTable

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

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
Security Roles:
administrator
operator

updateJobUsage

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

getJobUsageBySubmitter

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

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
Security Roles:
administrator
operator

getAllJobUsage

public java.lang.String getAllJobUsage()
Get all job usage
Security Roles:
administrator
operator

jobLog

public void jobLog(java.lang.String jobID, java.lang.String message, java.lang.String message)
log a job message
Parameters:
jobID - job identifier
message - message text
message - scheduler name
Security Roles:
administrator
operator

jobLog

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

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
Security Roles:
administrator
operator

log

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

chkSection

public java.lang.String chkSection(java.lang.String jobSubDir)
Returns job log section
Parameters:
jobSubDir - Job log subdirectory
Security Roles:
administrator
operator

queryJobsByClass

public java.util.ArrayList queryJobsByClass(java.lang.String jobClass, java.lang.String jobToSearchFor)
Query jobs by job class
Parameters:
jobClass - Job Class
jobToSearchFor - Job ID
Security Roles:
administrator
operator

cleanupClassList

public void cleanupClassList(java.lang.String partInfo)
Remove job from class table
Parameters:
partInfo - Job ID
Security Roles:
administrator
operator

cleanupLogList

public void cleanupLogList(java.lang.String jobID)
Remove job from log table
Parameters:
jobID - Job ID
Security Roles:
administrator
operator

getOwningScheduler

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

updateOwningScheduler

public void updateOwningScheduler(java.lang.String jobID, java.lang.String newSchedulerName)
update the job owning scheduler
Parameters:
jobID - job identifier
newSchedulerName - new job scheduler name
Security Roles:
administrator
operator

updateOwningScheduler

public java.lang.Integer updateOwningScheduler(java.lang.String jobID, java.lang.String newSchedulerName, java.lang.String oldSchedulerName)
update the job owning scheduler
Parameters:
jobID - job identifier
newSchedulerName - new job scheduler name
oldSchedulerName - old job scheduler name
Security Roles:
administrator
operator

updateRRsOwningScheduler

public void updateRRsOwningScheduler(com.ibm.ws.batch.RecurringRequestDO rrDO, java.lang.String oldSchedulerName)
update a schedule's owning scheduler
Parameters:
rrDO - schedule information
oldSchedulerName - old job scheduler name
Security Roles:
administrator
operator

getJobUsageByJobIdOfAllStartTime

public com.ibm.ws.batch.JobUsageDO[] getJobUsageByJobIdOfAllStartTime(java.lang.String jobid)
Get job usage by job id
Parameters:
jobid - job id
Security Roles:
administrator
operator

processStepStatusMessage

public void processStepStatusMessage(java.lang.String msgTxt)
process a job's step status message
Parameters:
msgTxt - the status message
Security Roles:
administrator
operator

getOwnedJobsInNonFinalState

public java.util.List getOwnedJobsInNonFinalState(java.lang.String endpointName)
Get list of jobs in non final state in the endpoint
Parameters:
endpointName - EP name
Security Roles:
administrator
operator

sendStepStatusJMXNotification

public void sendStepStatusJMXNotification(java.lang.String notificationType, java.lang.String jobId, java.lang.String stepName, java.lang.String startTime, java.lang.String endTime, java.lang.Integer statusCode, java.lang.Integer rc)
Send step status JMX notification
Parameters:
notificationType - type of notification
jobId - job id of this step
stepName - job step name
startTime - time job step starts
endTime - time job step ends
statusCode - job step status code
rc - job step return code
Security Roles:
administrator
operator

queued

public void queued(java.lang.String txc, java.lang.String app, java.lang.String module)
PMI stat queued
Parameters:
txc - transaction class
app - application name
module - module name
Security Roles:
administrator
operator

dispatched

public void dispatched(java.lang.String txc, java.lang.String app, java.lang.String module, java.lang.Long timeInQueue, java.lang.Long timeToDispatch)
PMI stat dispatched
Parameters:
txc - transaction class
app - application name
module - module name
timeInQueue - time in queue
timeToDispatch - time to dispatch
Security Roles:
administrator
operator

dispatchError

public void dispatchError(java.lang.String txc, java.lang.String app, java.lang.String module, java.lang.Long errTime)
PMI stat dispatch error
Parameters:
txc - transaction class
app - application name
module - module name
errTime - dispatch error time
Security Roles:
administrator
operator

dispatchFailed

public void dispatchFailed(java.lang.String txc, java.lang.String app, java.lang.String module, java.lang.Long timeInQueue)
PMI stat dispatch failed
Parameters:
txc - transaction class
app - application name
module - module name
timeInQueue - time in queue
Security Roles:
administrator
operator

jobCompleted

public void jobCompleted(java.lang.String txc, java.lang.String app, java.lang.String module)
PMI stat job completed
Parameters:
txc - transaction class
app - application name
module - module name
Security Roles:
administrator
operator

removedFromQueue

public void removedFromQueue(java.lang.String txc, java.lang.String app, java.lang.String module)
PMI stat job removed from queue
Parameters:
txc - transaction class
app - application name
module - module name
Security Roles:
administrator
operator

executeRedoList

public void executeRedoList(java.lang.String endpointName)
Execute jobs that are currently in the redo list for this endpoint
Parameters:
endpointName - EP name
Security Roles:
administrator
operator

getLastRunTimeFromDB

public java.lang.Long getLastRunTimeFromDB(java.lang.String jobClass)
get lastRunTime value from DB
Parameters:
jobClass - Job Class
Security Roles:
administrator
operator

startThreadToRunCapacityLeakDetection

public void startThreadToRunCapacityLeakDetection(java.lang.Boolean recoverCapacity, java.lang.Boolean isFirstRun)
Start thread to run job class capacity leak detection
Parameters:
recoverCapacity - determine if recover action should be performed
isFirstRun - indicate if this is the first run
Security Roles:
administrator
operator

saveJobLogSectionFromCR

public void saveJobLogSectionFromCR(java.lang.String logSubDir, java.lang.String server, java.lang.String node, java.lang.String logDir)
save job log section, caller is from CR
Parameters:
logSubDir - log sub dir
server - server name
node - node
logDir - log dir
Security Roles:
administrator
operator

Copyright IBM Corp. 1996-2005