EndpointCR MBean

Partial ObjectName:
WebSphere:*,type=EndpointCR


MBean EndpointCR

z/OS SR-CR hopper for Long-running Endpoint


Operation Summary
voidinit()
           Initializes LRS Component
voiduninit()
           Uninitializes Long-running Endpoint Component
voidjobCacheUpdate(java.lang.String jobID, java.lang.String jobType, java.lang.String stoken)
           Updates a job entry in the job cache
java.lang.StringjobCacheRemove(java.lang.String jobID)
           Removes a job entry from the job cache
voidjobCacheComplete(java.lang.String jobID)
           Sets a job's state to completed in the job cache
java.lang.String[]getAllJobInCRJobCache()
           Get all jobs id in cr job cache
voidderegister()
           Deregisters MBean
com.ibm.ws.gridcontainer.IPGCConfiggetPGCConfig()
           Get the PGC Configuration
voidcancelJob(java.lang.String jobid)
           Cancel a job
voidforcedCancelJob(java.lang.String jobid)
           Forcibly cancel a job
voidsuspendJob(java.lang.String jobid, java.lang.String seconds)
           Suspend a job
voidresumeJob(java.lang.String jobid)
           Resume a job
voidpurgeJob(java.lang.String jobid)
           Purge a job
voidpurgeJobSync(java.lang.String jobid)
           Purge a job synchronously
voidremoveLogMapping(java.lang.String jobid)
           Remove job log mapping
voidinitDirectoryCount(int maximum, java.lang.String server, java.lang.String baseDir)
           Increments the job log counter
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
voidsendLog(java.lang.String jobid, java.lang.String seq)
           Send log
voidstopJob(java.lang.String jobid)
           Stop a job
java.lang.String[]getJobLogPartList(java.lang.String jobId)
           Get the job log parts for the given job
java.lang.StringgetJobLogPart(java.lang.String jobId, java.lang.String partNo)
           Get the String corresponding to the job log part
java.lang.StringgetJobLogPartFromOffset(java.lang.String jobId, java.lang.String partNo, long offset, java.lang.String metaData)
           Get the String corresponding to the job log part starting at an offset
voidstartHeartBeating()
           start heart beating
voidstopHeartBeating()
           stop heart beating
voidsubscribe(java.lang.String subjectName, java.lang.String stoken)
           Subscribes to a Bulletin Board subject
voidunsubscribe(java.lang.String subjectName)
           Unsubscribes from a Bulletin Board subject
voidregisterSchedulerLocationListener(java.lang.String servantToken)
           Register a servant region listener to the Scheduler Location
voidregisterSchedulerLocationListenerExtended(java.lang.String servantToken)
           Register a servant region listener to the Scheduler Location - Extended

Operation Detail

init

public void init()
Initializes LRS Component
Security Roles:
administrator
operator

uninit

public void uninit()
Uninitializes Long-running Endpoint Component
Security Roles:
administrator
operator

jobCacheUpdate

public void jobCacheUpdate(java.lang.String jobID, java.lang.String jobType, java.lang.String stoken)
Updates a job entry in the job cache
Parameters:
jobID - Job ID
jobType - Job Type
stoken - SR token
Security Roles:
administrator
operator

jobCacheRemove

public java.lang.String jobCacheRemove(java.lang.String jobID)
Removes a job entry from the job cache
Parameters:
jobID - Job ID
Security Roles:
administrator
operator

jobCacheComplete

public void jobCacheComplete(java.lang.String jobID)
Sets a job's state to completed in the job cache
Parameters:
jobID - Job ID
Security Roles:
administrator
operator

getAllJobInCRJobCache

public java.lang.String[] getAllJobInCRJobCache()
Get all jobs id in cr job cache
Security Roles:
administrator
operator

deregister

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

getPGCConfig

public com.ibm.ws.gridcontainer.IPGCConfig getPGCConfig()
Get the PGC Configuration
Security Roles:
administrator
operator

cancelJob

public void cancelJob(java.lang.String jobid)
Cancel a job
Parameters:
jobid - Job ID
Security Roles:
administrator
operator

forcedCancelJob

public void forcedCancelJob(java.lang.String jobid)
Forcibly cancel a job
Parameters:
jobid - Job ID
Security Roles:
administrator
operator

suspendJob

public void suspendJob(java.lang.String jobid, java.lang.String seconds)
Suspend a job
Parameters:
jobid - Job ID
seconds - Suspend job for a certain amount of seconds
Security Roles:
administrator
operator

resumeJob

public void resumeJob(java.lang.String jobid)
Resume a job
Parameters:
jobid - Job ID
Security Roles:
administrator
operator

purgeJob

public void purgeJob(java.lang.String jobid)
Purge a job
Parameters:
jobid - Job ID
Security Roles:
administrator
operator

purgeJobSync

public void purgeJobSync(java.lang.String jobid)
Purge a job synchronously
Parameters:
jobid - Job ID
Security Roles:
administrator
operator

removeLogMapping

public void removeLogMapping(java.lang.String jobid)
Remove job log mapping
Parameters:
jobid - Job ID
Security Roles:
administrator
operator

initDirectoryCount

public void initDirectoryCount(int maximum, java.lang.String server, java.lang.String baseDir)
Increments the job log counter
Parameters:
maximum - Maximum Subdirectories
server - Server name
baseDir - Base Directory
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

sendLog

public void sendLog(java.lang.String jobid, java.lang.String seq)
Send log
Parameters:
jobid - Job ID
seq - Sequence
Security Roles:
administrator
operator

stopJob

public void stopJob(java.lang.String jobid)
Stop a job
Parameters:
jobid - Job ID
Security Roles:
administrator
operator

getJobLogPartList

public java.lang.String[] getJobLogPartList(java.lang.String jobId)
Get the job log parts for the given job
Parameters:
jobId - Job id whoose parts are requested
Security Roles:
administrator
operator

getJobLogPart

public java.lang.String getJobLogPart(java.lang.String jobId, java.lang.String partNo)
Get the String corresponding to the job log part
Parameters:
jobId - Job id whoose part is requested
partNo - Job log part requested
Security Roles:
administrator
operator

getJobLogPartFromOffset

public java.lang.String getJobLogPartFromOffset(java.lang.String jobId, java.lang.String partNo, long offset, java.lang.String metaData)
Get the String corresponding to the job log part starting at an offset
Parameters:
jobId - Job id whose part is requested
partNo - Job log part requested
offset - Job log offset
metaData - Job log metadata
Security Roles:
administrator
operator

startHeartBeating

public void startHeartBeating()
start heart beating
Security Roles:
administrator
operator

stopHeartBeating

public void stopHeartBeating()
stop heart beating
Security Roles:
administrator
operator

subscribe

public void subscribe(java.lang.String subjectName, java.lang.String stoken)
Subscribes to a Bulletin Board subject
Parameters:
subjectName - BB Subject
stoken - Servant token
Security Roles:
administrator
operator

unsubscribe

public void unsubscribe(java.lang.String subjectName)
Unsubscribes from a Bulletin Board subject
Parameters:
subjectName - BB Subject
Security Roles:
administrator
operator

registerSchedulerLocationListener

public void registerSchedulerLocationListener(java.lang.String servantToken)
Register a servant region listener to the Scheduler Location
Parameters:
servantToken - The servant token
Security Roles:
administrator
operator

registerSchedulerLocationListenerExtended

public void registerSchedulerLocationListenerExtended(java.lang.String servantToken)
Register a servant region listener to the Scheduler Location - Extended
Parameters:
servantToken - The servant token
Security Roles:
administrator
operator

Copyright IBM Corp. 1996-2005