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
voidpublish(java.lang.String subjectName, java.lang.String value, java.lang.String stoken)
           Publishes a Bulletin Board subject with a post
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
voidjobCacheUpdate(java.lang.String jobID, java.lang.String jndiName, java.lang.String stoken, java.lang.String jobType)
           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.StringjobCacheGetJndiName(java.lang.String jobID)
           Gets a job's application JNDI name
voidderegister()
           Deregisters MBean
java.lang.StringgetSchedulerContext()
           Retrieves the Scheduler's context from the CR
voidcloseSubject(java.lang.String subjectName)
           Closes a job subject subscription
voidcreateSubject(java.lang.String subjectName)
           Creates a job subject subscription
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
voidsendLog(java.lang.String jobid, java.lang.String seq)
           Send log
voidcloseSubjects(java.lang.String jobid)
           Close job status subject
voidstopJob(java.lang.String jobid)
           Stop a job
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
java.lang.String[]getRemoteDirList(java.lang.String dirName)
           Return the dir listing
java.lang.StringgetRemoteFileContent(java.lang.String fileName)
           Return the contents of the file as a String

Operation Detail

init

public void init()
Initializes LRS Component

uninit

public void uninit()
Uninitializes Long-running Endpoint Component

publish

public void publish(java.lang.String subjectName, java.lang.String value, java.lang.String stoken)
Publishes a Bulletin Board subject with a post
Parameters:
subjectName - BB Subject
value - BB post contents
stoken - Servant token

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

unsubscribe

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

jobCacheUpdate

public void jobCacheUpdate(java.lang.String jobID, java.lang.String jndiName, java.lang.String stoken, java.lang.String jobType)
Updates a job entry in the job cache
Parameters:
jobID - Job ID
jndiName - EJB's JNDI name
stoken - SR token
jobType - Job type

jobCacheRemove

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

jobCacheComplete

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

jobCacheGetJndiName

public java.lang.String jobCacheGetJndiName(java.lang.String jobID)
Gets a job's application JNDI name
Parameters:
jobID - Job ID

deregister

public void deregister()
Deregisters MBean

getSchedulerContext

public java.lang.String getSchedulerContext()
Retrieves the Scheduler's context from the CR

closeSubject

public void closeSubject(java.lang.String subjectName)
Closes a job subject subscription
Parameters:
subjectName - Subject Name

createSubject

public void createSubject(java.lang.String subjectName)
Creates a job subject subscription
Parameters:
subjectName - Subject Name

cancelJob

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

forcedCancelJob

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

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

resumeJob

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

purgeJob

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

sendLog

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

closeSubjects

public void closeSubjects(java.lang.String jobid)
Close job status subject
Parameters:
jobid - Job ID

stopJob

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

registerSchedulerLocationListener

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

registerSchedulerLocationListenerExtended

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

getRemoteDirList

public java.lang.String[] getRemoteDirList(java.lang.String dirName)
Return the dir listing
Parameters:
dirName - Remote directory name

getRemoteFileContent

public java.lang.String getRemoteFileContent(java.lang.String fileName)
Return the contents of the file as a String
Parameters:
fileName - Remote file Contents

Copyright IBM Corp. 1996 - 2007