SchedulerCR MBean

Partial ObjectName:
WebSphere:*,type=SchedulerCR


MBean SchedulerCR

z/OS SR-CR hopper for LongRunning Scheduler


Operation Summary
java.lang.Stringinit()
           Initializes LRS Component
voiduninit()
           Uninitializes LRS Component
voidderegister()
           Deregisters MBean
voidcreateJobStatus(java.lang.String jobid)
           Publishes a job's status to the Bulletin Board
voidEPSComplete(java.lang.String jobid, java.lang.String node, java.lang.String appServer, java.lang.String jobType)
           Notifies the EPS of a job's ending status
voidEPSRemove(java.lang.String jobid)
           Removes a job from the EPS
java.lang.StringgetJobID(java.lang.String jobName)
           Gets a job id assigned to a new job
voidincrementJobLogCount(java.lang.String extendedSection)
           Increments the job log counter
voiddecrementJobLogCount(java.lang.String extendedSection)
           Decrements the job log counter
java.lang.StringgetSubDirectory()
           Gets the job log subdirectory
java.lang.Booleanschedule(java.lang.String xJCL, java.lang.String jobid, java.lang.String submitter)
           Gets a job id assigned to a new job
java.lang.Booleanqueue(com.ibm.ws.longrun.Job job)
           Queues job to GAPAgent
voidinvokeEndpoint(java.lang.String node, java.lang.String server, java.lang.String opName, java.lang.Object[] parms, java.lang.String[] signature, java.lang.String epArgs)
           Invokes the Endpoint Web Service
java.lang.StringfindBestNodeToDisable(java.lang.String nodeGroupName)
           Finds the best Node to Disable in a NodeGroup
java.lang.StringfindBestLocation(java.lang.String dcMemberName, java.lang.String oldNodeGroupName, java.lang.Integer healthCondition)
           Finds the best Node
voidcreateDJQ()
           Creates a Delayed Job Queuer in the CR
voidcreateDJQAlarm()
           Creates an AlarmManager alarm in the CR for the Delayed Job Queuer
voiddjqAdd(com.ibm.ws.longrun.Job job)
           adds an element to the Delayed Job Queuer in the CR
voiddjqRemove(java.lang.String jobID)
           Remove an element from the Delayed Job Queuer in the CR
java.lang.IntegerdjqSize()
           returns the size of the Delayed Job Queue
voidcreateRecurringRequestAlarm(java.lang.String reqId, java.lang.Long nextStartTime, com.ibm.ws.batch.RecurringRequestAlarmListener rrAL)
           Creates an AlarmManager alarm in the CR for Recurring Request
com.ibm.ws.batch.RecurringRequestAlarmListenercreateRecurringRequestListener(com.ibm.ws.batch.RecurringRequestDO rrDO)
           Creates an alarm listener for Recurring Request Alarm in the CR
voidcancelRecurringRequestAlarm(java.lang.String reqId)
           Cancels a Recurring Request Alarm alarm in the CR
voidrecreateRecurringRequestAlarms(com.ibm.ws.batch.RecurringRequestDO[] rrDO)
           Creates an alarm in the CR to reinit existing Recurring Requests
voidcreateJobStatusSubject(com.ibm.ws.batch.JobStatusDO[] jsDO)
           createJobStatusSubject
voiddsjQueueAdd(com.ibm.ws.batch.DelayedSubmitJob dsj)
           dsjQueueAdd
voiddsjQueueRemove(com.ibm.ws.batch.DelayedSubmitJob dsj)
           dsjQueueRemove
voiddisplayDSJQueueContents()
           displayDSJQueueContents
voidcreateRecurringRequest(com.ibm.ws.batch.RecurringRequestDO rrDO, java.lang.Long durationToStart)
           createRecurringRequest
voidremoveJobStatusSubscription(java.lang.String jobID)
           Invoke Global Job Status listener to remove a job status Subscription
voidcleanupJobClassInfo(java.util.ArrayList jobsToRemoveList)
           Clean up job calss info.
voidinvokeGridEndpoint(java.lang.String opName, java.lang.String jobID)
           Perform operation on Grid Utility job.
java.lang.BooleanisApplicationInstalled(java.lang.String applicationName)
           Verify if the application is installed
java.lang.BooleanisSchedulerActive(java.lang.String schedulerNameInBBformat)
           Verify if the a scheduler is active
com.ibm.ws.longrun.EndPointgetGAPEndpoint(java.lang.String endpointName)
           Retrieve an EndPoint object from GAPNodesTable.
voidsetJobEndpoint(java.lang.String jobid, com.ibm.ws.longrun.EndPoint endpoint)
           Set the selected Endpoint for a job.
voidwriteSMF(com.ibm.ws.batch.JobUsageDO[] juDO, java.lang.Integer recordCount)
           writeSMF
voidremoveXJCLJobFromCache(java.lang.String jobId)
           removeXJCLJobFromCache
java.lang.String[]getJobLogPartListFromPGCEndpoint(java.lang.String jobId, com.ibm.ws.longrun.EndPoint endpoint)
           Get the job log parts for the given job
java.lang.StringgetJobLogPartFromPGCEndpoint(java.lang.String jobId, java.lang.String partNo, com.ibm.ws.longrun.EndPoint endpoint)
           Get the String corresponding to the job log part
voidupdateOwningSchedulerOnPGCEndpoint(java.util.Map endpointToJobMap, java.lang.String schedulerName)
           Inform the Endpoint of the new owner of the given list of jobs
voidinvokePortableGridEndpoint(com.ibm.ws.longrun.EndPoint endpoint, java.lang.String node, java.lang.String server, java.lang.String opName, java.lang.Object[] params, java.lang.String[] signature, java.lang.String epArgs)
           Invoke the given command on the given PGC endpoint
voidprocessMessagesFromPGCEndpoint(java.util.List messages)
           Process job status messages from PGC endpoint
voidprocessPGCEndpointStatusUpdate(com.ibm.ws.gridcontainer.communication.HeartBeatMessage msg)
           Process heart beat message from PGC endpoint
com.ibm.ws.longrun.EndPointprocessJobWithoutDispatch(com.ibm.ws.longrun.Job job, java.lang.String node, java.lang.String server)
           Process job without dispatch
java.lang.StringIOAPAR_getJobLogPartFromPGCEndpoint(java.lang.String jobId, java.lang.String partNo, com.ibm.ws.longrun.EndPoint endpoint, java.lang.String partNo, java.lang.String metaData)
           Get the String corresponding to the job log part
voidnotifyGAPAboutJobClassCapacityUpdate(java.lang.String jobClass, java.lang.Integer newCapacityCount)
           notify Gap
voidresetDetectionRunFlag(java.lang.Boolean flag)
           reset flag

Operation Detail

init

public java.lang.String init()
Initializes LRS Component
Security Roles:
administrator
operator

uninit

public void uninit()
Uninitializes LRS Component
Security Roles:
administrator
operator

deregister

public void deregister()
Deregisters MBean
Security Roles:
administrator
operator

createJobStatus

public void createJobStatus(java.lang.String jobid)
Publishes a job's status to the Bulletin Board
Parameters:
jobid - Job ID
Security Roles:
administrator
operator

EPSComplete

public void EPSComplete(java.lang.String jobid, java.lang.String node, java.lang.String appServer, java.lang.String jobType)
Notifies the EPS of a job's ending status
Parameters:
jobid - Job ID
node - node name
appServer - server name
jobType - job type
Security Roles:
administrator
operator

EPSRemove

public void EPSRemove(java.lang.String jobid)
Removes a job from the EPS
Parameters:
jobid - Job ID
Security Roles:
administrator
operator

getJobID

public java.lang.String getJobID(java.lang.String jobName)
Gets a job id assigned to a new job
Parameters:
jobName - Job name
Security Roles:
administrator
operator

incrementJobLogCount

public void incrementJobLogCount(java.lang.String extendedSection)
Increments the job log counter
Parameters:
extendedSection - Section
Security Roles:
administrator
operator

decrementJobLogCount

public void decrementJobLogCount(java.lang.String extendedSection)
Decrements the job log counter
Parameters:
extendedSection - Section
Security Roles:
administrator
operator

getSubDirectory

public java.lang.String getSubDirectory()
Gets the job log subdirectory
Security Roles:
administrator
operator

schedule

public java.lang.Boolean schedule(java.lang.String xJCL, java.lang.String jobid, java.lang.String submitter)
Gets a job id assigned to a new job
Parameters:
xJCL - xJCL
jobid - Job ID
submitter - Job Submitter ID
Security Roles:
administrator
operator

queue

public java.lang.Boolean queue(com.ibm.ws.longrun.Job job)
Queues job to GAPAgent
Parameters:
job - Job to be dispatched
Security Roles:
administrator
operator

invokeEndpoint

public void invokeEndpoint(java.lang.String node, java.lang.String server, java.lang.String opName, java.lang.Object[] parms, java.lang.String[] signature, java.lang.String epArgs)
Invokes the Endpoint Web Service
Parameters:
node - node of target
server - target server
opName - operation
parms - parms
signature - signature of parms
epArgs - arguments for EPS
Security Roles:
administrator
operator

findBestNodeToDisable

public java.lang.String findBestNodeToDisable(java.lang.String nodeGroupName)
Finds the best Node to Disable in a NodeGroup
Parameters:
nodeGroupName - the Node Group
Security Roles:
administrator
operator

findBestLocation

public java.lang.String findBestLocation(java.lang.String dcMemberName, java.lang.String oldNodeGroupName, java.lang.Integer healthCondition)
Finds the best Node
Parameters:
dcMemberName - the DC Name
oldNodeGroupName - the Node Group Name
healthCondition - the health indicator
Security Roles:
administrator
operator

createDJQ

public void createDJQ()
Creates a Delayed Job Queuer in the CR
Security Roles:
administrator
operator

createDJQAlarm

public void createDJQAlarm()
Creates an AlarmManager alarm in the CR for the Delayed Job Queuer
Security Roles:
administrator
operator

djqAdd

public void djqAdd(com.ibm.ws.longrun.Job job)
adds an element to the Delayed Job Queuer in the CR
Parameters:
job - the Job to add
Security Roles:
administrator
operator

djqRemove

public void djqRemove(java.lang.String jobID)
Remove an element from the Delayed Job Queuer in the CR
Parameters:
jobID - The Job ID to Remove
Security Roles:
administrator
operator

djqSize

public java.lang.Integer djqSize()
returns the size of the Delayed Job Queue
Security Roles:
administrator
operator

createRecurringRequestAlarm

public void createRecurringRequestAlarm(java.lang.String reqId, java.lang.Long nextStartTime, com.ibm.ws.batch.RecurringRequestAlarmListener rrAL)
Creates an AlarmManager alarm in the CR for Recurring Request
Parameters:
reqId - name of request
nextStartTime - alarm activation time
rrAL - listener for this alarm
Security Roles:
administrator
operator

createRecurringRequestListener

public com.ibm.ws.batch.RecurringRequestAlarmListener createRecurringRequestListener(com.ibm.ws.batch.RecurringRequestDO rrDO)
Creates an alarm listener for Recurring Request Alarm in the CR
Parameters:
rrDO - Recurring Request Data Object
Security Roles:
administrator
operator

cancelRecurringRequestAlarm

public void cancelRecurringRequestAlarm(java.lang.String reqId)
Cancels a Recurring Request Alarm alarm in the CR
Parameters:
reqId - name of request
Security Roles:
administrator
operator

recreateRecurringRequestAlarms

public void recreateRecurringRequestAlarms(com.ibm.ws.batch.RecurringRequestDO[] rrDO)
Creates an alarm in the CR to reinit existing Recurring Requests
Parameters:
rrDO - recurring request data objects
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

dsjQueueAdd

public void dsjQueueAdd(com.ibm.ws.batch.DelayedSubmitJob dsj)
dsjQueueAdd
Parameters:
dsj - name of delayed submit job to add
Security Roles:
administrator
operator

dsjQueueRemove

public void dsjQueueRemove(com.ibm.ws.batch.DelayedSubmitJob dsj)
dsjQueueRemove
Parameters:
dsj - name of delayed submit job to remove
Security Roles:
administrator
operator

displayDSJQueueContents

public void displayDSJQueueContents()
displayDSJQueueContents
Security Roles:
administrator
operator

createRecurringRequest

public void createRecurringRequest(com.ibm.ws.batch.RecurringRequestDO rrDO, java.lang.Long durationToStart)
createRecurringRequest
Parameters:
rrDO - recurring request data object
durationToStart - duration to start recurring jobs
Security Roles:
administrator
operator

removeJobStatusSubscription

public void removeJobStatusSubscription(java.lang.String jobID)
Invoke Global Job Status listener to remove a job status Subscription
Parameters:
jobID - jobid
Security Roles:
administrator
operator

cleanupJobClassInfo

public void cleanupJobClassInfo(java.util.ArrayList jobsToRemoveList)
Clean up job calss info.
Parameters:
jobsToRemoveList - List of jobs.
Security Roles:
administrator
operator

invokeGridEndpoint

public void invokeGridEndpoint(java.lang.String opName, java.lang.String jobID)
Perform operation on Grid Utility job.
Parameters:
opName - Operation Type.
jobID - Job ID.
Security Roles:
administrator
operator

isApplicationInstalled

public java.lang.Boolean isApplicationInstalled(java.lang.String applicationName)
Verify if the application is installed
Parameters:
applicationName - Name of the application
Security Roles:
administrator
operator

isSchedulerActive

public java.lang.Boolean isSchedulerActive(java.lang.String schedulerNameInBBformat)
Verify if the a scheduler is active
Parameters:
schedulerNameInBBformat - Scheduler Name In BB format
Security Roles:
administrator
operator

getGAPEndpoint

public com.ibm.ws.longrun.EndPoint getGAPEndpoint(java.lang.String endpointName)
Retrieve an EndPoint object from GAPNodesTable.
Parameters:
endpointName - Name of the endpoint (nodeName/serverName)
Security Roles:
administrator
operator

setJobEndpoint

public void setJobEndpoint(java.lang.String jobid, com.ibm.ws.longrun.EndPoint endpoint)
Set the selected Endpoint for a job.
Parameters:
jobid - Job ID
endpoint - Selected endpoint
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

removeXJCLJobFromCache

public void removeXJCLJobFromCache(java.lang.String jobId)
removeXJCLJobFromCache
Parameters:
jobId - job id to remove from cache
Security Roles:
administrator
operator

getJobLogPartListFromPGCEndpoint

public java.lang.String[] getJobLogPartListFromPGCEndpoint(java.lang.String jobId, com.ibm.ws.longrun.EndPoint endpoint)
Get the job log parts for the given job
Parameters:
jobId - Job id whoose parts are requested
endpoint - Endpoint where job is running
Security Roles:
administrator
operator

getJobLogPartFromPGCEndpoint

public java.lang.String getJobLogPartFromPGCEndpoint(java.lang.String jobId, java.lang.String partNo, com.ibm.ws.longrun.EndPoint endpoint)
Get the String corresponding to the job log part
Parameters:
jobId - Job id whoose part is requested
partNo - Job log part requested
endpoint - Endpoint where job is running
Security Roles:
administrator
operator

updateOwningSchedulerOnPGCEndpoint

public void updateOwningSchedulerOnPGCEndpoint(java.util.Map endpointToJobMap, java.lang.String schedulerName)
Inform the Endpoint of the new owner of the given list of jobs
Parameters:
endpointToJobMap - endpoint to Job map
schedulerName - The new owning scheduler
Security Roles:
administrator
operator

invokePortableGridEndpoint

public void invokePortableGridEndpoint(com.ibm.ws.longrun.EndPoint endpoint, java.lang.String node, java.lang.String server, java.lang.String opName, java.lang.Object[] params, java.lang.String[] signature, java.lang.String epArgs)
Invoke the given command on the given PGC endpoint
Parameters:
endpoint - The target endpoint
node - node name
server - server name
opName - operation name
params - Parameters for the operation
signature - Signature of the operation
epArgs - Arguments for the endpoint
Security Roles:
administrator
operator

processMessagesFromPGCEndpoint

public void processMessagesFromPGCEndpoint(java.util.List messages)
Process job status messages from PGC endpoint
Parameters:
messages - List of job status updates
Security Roles:
administrator
operator

processPGCEndpointStatusUpdate

public void processPGCEndpointStatusUpdate(com.ibm.ws.gridcontainer.communication.HeartBeatMessage msg)
Process heart beat message from PGC endpoint
Parameters:
msg - Heat beat
Security Roles:
administrator
operator

processJobWithoutDispatch

public com.ibm.ws.longrun.EndPoint processJobWithoutDispatch(com.ibm.ws.longrun.Job job, java.lang.String node, java.lang.String server)
Process job without dispatch
Parameters:
job - Job
node - node
server - server
Security Roles:
administrator
operator

IOAPAR_getJobLogPartFromPGCEndpoint

public java.lang.String IOAPAR_getJobLogPartFromPGCEndpoint(java.lang.String jobId, java.lang.String partNo, com.ibm.ws.longrun.EndPoint endpoint, java.lang.String partNo, java.lang.String metaData)
Get the String corresponding to the job log part
Parameters:
jobId - Job id whoose part is requested
partNo - Job log part requested
endpoint - Endpoint where job is running
partNo - Job log part requested
metaData - Metadata of Job log part requested
Security Roles:
administrator
operator

notifyGAPAboutJobClassCapacityUpdate

public void notifyGAPAboutJobClassCapacityUpdate(java.lang.String jobClass, java.lang.Integer newCapacityCount)
notify Gap
Parameters:
jobClass - job class
newCapacityCount - count
Security Roles:
administrator
operator

resetDetectionRunFlag

public void resetDetectionRunFlag(java.lang.Boolean flag)
reset flag
Parameters:
flag - true or false
Security Roles:
administrator
operator

Copyright IBM Corp. 1996-2005