public interface JobScheduler
extends javax.ejb.EJBObject
InitialContext ctxt = new InitialContext();
Hashtable env = new Hashtable();
env.put (Context.INITIAL_CONTEXT_FACTORY, "com.ibm.websphere.naming.WsnInitialContextFactory");
env.put(Context.PROVIDER_URL, "corbaloc:iiop:
ctxt = new InitialContext(env);
// In order to lookup the Job Scheduler EJB from the cell context in the namespace,
// the name context to the application server or cluster to which the Job Scheduler
// application is deployed has to be provided.
// Eg: "nodes/myNode/servers/myServer" or "clusters/myCluster".
String jobSchedulerContext = clusters/myCluster;
JobSchedulerHome zjsHome = (JobSchedulerHome) PortableRemoteObject.narrow(ctxt.lookup(jobSchedulerContext +
"/ejb/com/ibm/websphere/longrun/JobSchedulerHome"),JobSchedulerHome.class);
JobScheduler js = zjsHome.create();
Modifier and Type | Method and Description |
---|---|
void |
cancelJob(java.lang.String jobid)
Cancels the job identified by the job ID
|
int[] |
cancelJob(java.lang.String[] jobid)
Cancels the jobs identified by the list of job IDs
|
void |
cancelRecurringRequest(java.lang.String reqId)
Note: Not supported in WebSphere Batch FeaturePack
Cancel an existing job schedule
|
int[] |
cancelRecurringRequest(java.lang.String[] reqId)
Note: Not supported in WebSphere Batch FeaturePack
Cancel existing job schedules
|
void |
forcedCancelJob(java.lang.String jobid)
Note: Not supported in WebSphere Batch FeaturePack
Forcibly cancels the job identified by the job ID
Supported on z/OS only.
|
java.lang.String[] |
getAdminAddresses()
Return the JMX addresses of the scheduler cluster
|
int |
getBatchJobRC(java.lang.String jobid)
Returns the return code of the Batch job.
|
java.lang.String |
getJobDetails(java.lang.String jobid)
Returns the job details for the given job ID.
|
java.lang.String |
getJobLog(java.lang.String jobid)
Returns the zipped job log associated with the requested job ID
|
java.lang.String[] |
getJobLogMetaDataByAgeForClass(java.lang.String jobClass)
Returns the job log list associated with the requested job class sorted by job log age
|
java.lang.String[] |
getJobLogMetaDataBySizeForClass(java.lang.String jobClass)
Returns the job log list associated with the requested job class sorted by job log size
|
java.lang.String |
getJobOutput(java.lang.String jobid)
Returns the job output for a given job ID that displays the job's progress.
|
java.lang.String[] |
getJobsByClass(java.lang.String jobClass)
Returns the job log list associated with the requested job class
|
java.lang.String[] |
getJobsId(java.lang.String jobFilter,
java.lang.String submitterFilter,
java.lang.String nodeFilter,
java.lang.String appServerFilter,
java.lang.Integer[] stateFilter,
java.lang.String sortBy,
boolean ascending)
Returns a list of job IDs that match the specified criteria.
|
java.lang.String[] |
getJobsId(java.lang.String jobFilter,
java.lang.String submitterFilter,
java.lang.String nodeFilter,
java.lang.String appServerFilter,
java.lang.Integer[] stateFilter,
java.lang.String sortBy,
boolean ascending,
java.lang.String groupFilter)
Returns a list of job IDs that match the specified criteria.
|
java.lang.String[] |
getJobsName(java.lang.String jobNameFilter,
java.lang.String jobDescFilter,
java.lang.String sortBy,
boolean ascending)
Returns a list of job names in the job repository that match the specified criteria.
|
java.lang.String[] |
getJobsName(java.lang.String jobNameFilter,
java.lang.String jobDescFilter,
java.lang.String sortBy,
boolean ascending,
java.lang.String groupFilter)
Returns a list of job names in the job repository that match the specified criteria.
|
java.lang.String |
getJobsStatus(java.lang.String[] jobid)
Returns job status in XML format for the given job IDs.
|
int |
getJobStatus(java.lang.String jobid)
Returns the job status for the given job ID.
|
int |
getJobsTotal() |
int |
getLogAge(java.lang.String jobid,
java.lang.String logSubDirName)
Returns the age of the job log file associated with the requested job ID and log subdirectory
|
java.lang.String[] |
getLogMetaData(java.lang.String jobid)
Returns the job log meta-data associated with the requested job ID (list of distinct job log subdirectories for the job ID)
|
java.lang.String[] |
getLogPart(java.lang.String jobid,
java.lang.String logSubDirName,
java.lang.String partNumber)
Returns the contents of the job log file associated with the requested job ID, log subdirectory and part number
|
java.lang.String[] |
getLogPartList(java.lang.String jobid,
java.lang.String logSubDirName)
Returns the job log part list associated with the requested job ID and log subdirectory
|
java.lang.String |
getLogSize(java.lang.String jobid,
java.lang.String logSubDirName)
Returns the size in bytes of the job log file associated with the requested job ID
|
java.lang.String |
getRecurringRequestDetails(java.lang.String reqId)
Note: Not supported in WebSphere Batch FeaturePack
Returns details of an existing job schedule.
|
java.lang.String |
getRequests(java.lang.String[] requestid)
Note: Not supported in WebSphere Batch FeaturePack
Returns job schedule information in XML format for the given job schedule names.
|
java.lang.String[] |
getRequestsId(java.lang.String requestIdFilter,
java.lang.String startTimeFilter,
java.lang.String submitterFilter,
java.lang.String[] intervalFilter,
java.lang.Integer[] statusFilter,
java.lang.String sortBy,
boolean ascending)
Note: Not supported in WebSphere Batch FeaturePack
Returns a list of job schedule names that match the specified criteria.
|
java.lang.String[] |
getRequestsId(java.lang.String requestIdFilter,
java.lang.String startTimeFilter,
java.lang.String submitterFilter,
java.lang.String[] intervalFilter,
java.lang.Integer[] statusFilter,
java.lang.String sortBy,
boolean ascending,
java.lang.String groupFilter)
Note: Not supported in WebSphere Batch FeaturePack
Returns a list of job schedule names that match the specified criteria.
|
java.lang.String |
getSymbolicVariables(java.lang.String clientXJCL)
Parses the xJCL to produce a map of all symbolic variables used in the xJCL which are not system properties
|
java.lang.String |
getSymbolicVariablesForExistingJob(java.lang.String jobId)
Parses the xJCL corresponding to the jobid which is saved in the database
to produce a map of all symbolic variables used in the xJCL which are not system properties
Typically this method is invoked during a restart scenario from JMC to determine
the list of symbolic variables that the user can substitute during a restart.
|
java.lang.String[] |
getUserPrefs(java.lang.String userId,
java.lang.String prefScope)
Retrieves a list of user preferences for the given user ID and the given scope.
|
boolean |
isAuditRepositoryUpdateEnforced()
Returns true if audit is enabled via SPI
|
boolean |
isSAF()
Returns true if SAF authorization is enabled.
|
void |
modifyModifiableRecurringRequest(java.lang.String reqId,
java.lang.String xJCL,
java.lang.String startTime,
java.lang.String interval,
java.lang.String nameValuePairs)
Note: Not supported in WebSphere Batch FeaturePack
Modify an existing job schedule.
|
void |
modifyRecurringRequest(java.lang.String reqId,
java.lang.String xJCL,
java.lang.String startTime,
java.lang.String interval)
Note: Not supported in WebSphere Batch FeaturePack
Modify an existing job schedule.
|
java.lang.String |
privateGetJobID(int jobNumber) |
int |
privateReserveJobNumber() |
java.lang.String |
privateReserveJobNumberString() |
java.lang.String |
privateSubmitJob(java.lang.String xJCL,
int jobNumber) |
java.lang.String |
privateSubmitJob(java.lang.String xJCL,
int jobNumber,
java.lang.String proxySchedulerLockName) |
java.lang.String |
privateSubmitJobFromRepository(java.lang.String job,
int jobNumber) |
java.lang.String |
privateSubmitJobFromRepository(java.lang.String job,
int jobNumber,
java.lang.String proxySchedulerLockName) |
java.lang.String |
privateSubmitModifiableJob(java.lang.String xJCL,
java.lang.String nameValuePairs,
int jobNumber) |
java.lang.String |
privateSubmitModifiableJob(java.lang.String xJCL,
java.lang.String nameValuePairs,
int jobNumber,
java.lang.String proxySchedulerLockName) |
java.lang.String |
privateSubmitModifiableJobFromRepository(java.lang.String job,
java.lang.String nameValuePairs,
int jobNumber) |
java.lang.String |
privateSubmitModifiableJobFromRepository(java.lang.String job,
java.lang.String nameValuePairs,
int jobNumber,
java.lang.String proxySchedulerLockName) |
void |
purgeJob(java.lang.String jobid)
Purges the job, identified by the job ID, from the job scheduler and the grid endpoint environments.
|
int[] |
purgeJob(java.lang.String[] jobid)
Purges the jobs, identified by the list of job IDs, from the job scheduler and the grid endpoint environments.
|
void |
purgeJobLog(java.lang.String jobid,
java.lang.String logSubDirName)
Purges the job log file associated with the requested job ID and log subDirectory
|
void |
quiesceLogging(java.lang.String jobid)
Stops user job logging
|
com.ibm.ws.batch.parallel.JobBlockResponse |
registerJobBlock(com.ibm.ws.batch.parallel.JobBlockRequest jobBlockRequest)
Submits a block of jobs to the scheduler, and dispatches them to an endpoint
determined by the JobBlockDescriptor within the request.
|
void |
removeJobFromRepository(java.lang.String job)
Note: Not supported in WebSphere Batch FeaturePack
Removes the xJCL for the specifed job from the xJCL repository
|
void |
removeJobLog(java.lang.String jobid)
Removes the zipped job log associated with the requested job ID [ this is the required complimentary action to {@link JobScheduler#getJobLog(String) getJobLog(jobid) ]
|
java.lang.String[] |
reserveJobNumberBlock(int count)
Allocates a block of job numbers.
|
void |
restartJob(java.lang.String jobid)
Restarts the job identified by the job ID.
|
int[] |
restartJob(java.lang.String[] jobid)
Restarts the jobs identified by the list of job IDs.
|
void |
restartJob(java.lang.String jobid,
java.lang.Object proxySchedulerLockName)
Restarts the job identified by the job ID and proxy lock name.
|
void |
restartJob(java.lang.String jobid,
java.lang.String passedPropertiesString)
Restarts the job identified by the job ID with the given substitution parameters.
|
void |
restartJob(java.lang.String jobid,
java.lang.String passedPropertiesString,
java.lang.Object proxySchedulerLockName)
Restarts the job identified by the job ID with the given substitution parameters and proxy scheduler lock name.
|
void |
resumeJob(java.lang.String jobid)
Resumes execution of the specified job.
|
int[] |
resumeJob(java.lang.String[] jobid)
Resumes execution of the jobs identified by the list of job IDs.
|
java.lang.String |
saveDelayedJobToRepositoryAndSubmit(java.lang.String xJCL,
java.lang.String job,
boolean replace,
java.lang.String startTime)
Note: Not supported in WebSphere Batch FeaturePack
Submits the delayed job specified by the xJCL passed in to the job scheduler and
saves the xJCL to the xJCL repository.
|
void |
saveJobToRepository(java.lang.String xJCL,
java.lang.String job,
boolean replace)
Note: Not supported in WebSphere Batch FeaturePack
Saves the xJCL passed in to the xJCL Repository.
|
void |
saveJobToRepository(java.lang.String xJCL,
java.lang.String job,
boolean replace,
java.lang.String auditString)
Note: Not supported in WebSphere Batch FeaturePack
Saves the xJCL passed in to the xJCL Repository.
|
java.lang.String |
saveJobToRepositoryAndSubmit(java.lang.String xJCL,
java.lang.String job,
boolean replace)
Note: Not supported in WebSphere Batch FeaturePack
Submits the job specified by the xJCL passed in to the job scheduler and
saves the xJCL to the xJCL repository.
|
java.lang.String |
saveModifiableDelayedJobToRepositoryAndSubmit(java.lang.String xJCL,
java.lang.String job,
boolean replace,
java.lang.String startTime,
java.lang.String nameValuePairs)
Note: Not supported in WebSphere Batch FeaturePack
Submits the delayed job, which is defined by the xJCL and any name/value pairs specified, to the job scheduler and
saves the xJCL to the xJCL repository.
|
java.lang.String |
saveModifiableJobToRepositoryAndSubmit(java.lang.String xJCL,
java.lang.String job,
boolean replace,
java.lang.String nameValuePairs)
Note: Not supported in WebSphere Batch FeaturePack
Submits the job, which is defined by the xJCL and any name/value pairs specified, to the job scheduler and
saves the xJCL to the xJCL repository.
|
void |
saveUserPrefs(java.lang.String userId,
java.lang.String prefScope,
java.lang.String[] prefNameValue)
Saves the list of user preferences for the given user ID and the given scope.
|
void |
sendCheckpointNotification(java.lang.String jobid,
java.lang.String Status) |
java.lang.String[] |
showAllJobs()
Shows all jobs in the job scheduler
|
java.lang.String[] |
showAllRecurringRequests()
Note: Not supported in WebSphere Batch FeaturePack
Lists all existing job schedules
|
java.lang.String |
showJobFromRepository(java.lang.String job)
Note: Not supported in WebSphere Batch FeaturePack
Returns the xJCL from the xJCL repository for the given job name.
|
java.lang.String[] |
showRecurringJobs(java.lang.String reqId)
Note: Not supported in WebSphere Batch FeaturePack
Show all jobs in the specified job schedule
|
void |
stopJob(java.lang.String jobid)
Stops the job identified by the job ID
|
int[] |
stopJob(java.lang.String[] jobid)
Stops the jobs identified by the list of job IDs
|
java.lang.String |
submitDelayedJob(java.lang.String xJCL,
java.lang.String startTime)
Note: Not supported in WebSphere Batch FeaturePack
Submits the job, which is defined by the xJCL, to the job scheduler at the specified start time.
|
java.lang.String |
submitDelayedJobFromRepository(java.lang.String job,
java.lang.String startTime)
Note: Not supported in WebSphere Batch FeaturePack
Submits the job, saved in the xJCL repository, to the job scheduler at the specified start time.
|
java.lang.String |
submitJob(java.lang.String xJCL)
Submits the job, which is defined by the xJCL, to the job scheduler
|
java.lang.String |
submitJobFromRepository(java.lang.String job)
Note: Not supported in WebSphere Batch FeaturePack
Submits the specified job, saved in the xJCL repository, to the job scheduler
|
java.lang.String |
submitModifiableDelayedJob(java.lang.String xJCL,
java.lang.String startTime,
java.lang.String nameValuePairs)
Note: Not supported in WebSphere Batch FeaturePack
Submits the job, which is defined by the xJCL and any name/value pairs specified, to the job scheduler at the specified
start time.
|
java.lang.String |
submitModifiableDelayedJobFromRepository(java.lang.String job,
java.lang.String startTime,
java.lang.String nameValuePairs)
Note: Not supported in WebSphere Batch FeaturePack
Submits the specified job, saved in the xJCL repository, and any name/value pairs specified to the job scheduler at the specified
start time.
|
java.lang.String |
submitModifiableJob(java.lang.String xJCL,
java.lang.String nameValuePairs)
Submits the job, which is defined by the xJCL and any name/value pairs specified, to the job scheduler
|
java.lang.String |
submitModifiableJobFromRepository(java.lang.String job,
java.lang.String nameValuePairs)
Note: Not supported in WebSphere Batch FeaturePack
Submits the specified job, saved in the xJCL repository, and any name/value pairs specified to the job scheduler
|
void |
submitModifiableRecurringRequest(java.lang.String reqId,
java.lang.String xJCL,
java.lang.String startTime,
java.lang.String interval,
java.lang.String nameValuePairs)
Note: Not supported in WebSphere Batch FeaturePack
Creates a job schedule to submit jobs at the specified time interval.
|
void |
submitModifiableRecurringRequestFromRepository(java.lang.String jobName,
java.lang.String reqId,
java.lang.String startTime,
java.lang.String interval,
java.lang.String nameValuePairs)
Note: Not supported in WebSphere Batch FeaturePack
Creates a job schedule to submit jobs at the specified time interval.
|
void |
submitRecurringRequest(java.lang.String reqId,
java.lang.String xJCL,
java.lang.String startTime,
java.lang.String interval)
Note: Not supported in WebSphere Batch FeaturePack
Creates a job schedule to submit the job, defined by the xJCL, at the specified time and interval.
|
void |
submitRecurringRequestFromRepository(java.lang.String jobName,
java.lang.String reqId,
java.lang.String startTime,
java.lang.String interval)
Note: Not supported in WebSphere Batch FeaturePack
Creates a job schedule to submit the specified job, saved in the xJCL repository, at the specified time and interval.
|
int[] |
suspendJob(java.lang.String[] jobid,
java.lang.String seconds)
Suspends the specified jobs for the number of seconds specified.
|
void |
suspendJob(java.lang.String jobid,
java.lang.String seconds)
Suspends the specified job for the number of seconds specified.
|
java.lang.String submitJobFromRepository(java.lang.String job) throws InvalidJobNameException, SchedulerException, JCLException, com.ibm.websphere.longrun.JobSubmissionException, java.rmi.RemoteException
job
- The name of the job that was stored to the xJCL repositoryInvalidJobNameException
- if job is not found in the xJCL repository.SchedulerException
- if an unexpected error is thrown by the job scheduler while submitting the jobJCLException
- if the xJCL stored in the repository is corrupted or not valid.JobSubmissionException
- if an error occurs while submitting the jobjava.rmi.RemoteException
java.lang.String privateSubmitJobFromRepository(java.lang.String job, int jobNumber) throws InvalidJobNameException, SchedulerException, JCLException, com.ibm.websphere.longrun.JobSubmissionException, java.rmi.RemoteException
InvalidJobNameException
SchedulerException
JCLException
com.ibm.websphere.longrun.JobSubmissionException
java.rmi.RemoteException
java.lang.String privateSubmitJobFromRepository(java.lang.String job, int jobNumber, java.lang.String proxySchedulerLockName) throws InvalidJobNameException, SchedulerException, JCLException, com.ibm.websphere.longrun.JobSubmissionException, java.rmi.RemoteException
InvalidJobNameException
SchedulerException
JCLException
com.ibm.websphere.longrun.JobSubmissionException
java.rmi.RemoteException
java.lang.String submitJob(java.lang.String xJCL) throws SchedulerException, JCLException, com.ibm.websphere.longrun.JobSubmissionException, java.rmi.RemoteException
xJCL
- The xJCL for the jobSchedulerException
- if an unexpected error is thrown by the job scheduler while submitting the jobJCLException
- if the xJCL stored in the repository is corrupted or not valid.JobSubmissionException
- if an error occurs while submitting the jobjava.rmi.RemoteException
java.lang.String privateSubmitJob(java.lang.String xJCL, int jobNumber) throws SchedulerException, JCLException, com.ibm.websphere.longrun.JobSubmissionException, java.rmi.RemoteException
SchedulerException
JCLException
com.ibm.websphere.longrun.JobSubmissionException
java.rmi.RemoteException
java.lang.String privateSubmitJob(java.lang.String xJCL, int jobNumber, java.lang.String proxySchedulerLockName) throws SchedulerException, JCLException, com.ibm.websphere.longrun.JobSubmissionException, java.rmi.RemoteException
SchedulerException
JCLException
com.ibm.websphere.longrun.JobSubmissionException
java.rmi.RemoteException
java.lang.String saveJobToRepositoryAndSubmit(java.lang.String xJCL, java.lang.String job, boolean replace) throws InvalidOperationException, SchedulerException, JCLException, com.ibm.websphere.longrun.JobSubmissionException, java.rmi.RemoteException
xJCL
- The xJCL for the jobjob
- The name given to the saved job in the xJCL repository. This name can be used when invoking the submitJobFromRepository
method.replace
- A boolean indicating if the xJCL in the repository should be replaced, in case a job by that name already exists
in the xJCL repository.InvalidOperationException
- if the job already exists in the xJCL repository and the replace parameter specified is falseSchedulerException
- if an unexpected error is thrown by the job scheduler while submitting the jobJCLException
- if the xJCL stored in the repository is corrupted or not valid.JobSubmissionException
- if an error occurs while submitting the jobjava.rmi.RemoteException
java.lang.String[] reserveJobNumberBlock(int count) throws SchedulerException, java.rmi.RemoteException
SchedulerException
java.rmi.RemoteException
com.ibm.ws.batch.parallel.JobBlockResponse registerJobBlock(com.ibm.ws.batch.parallel.JobBlockRequest jobBlockRequest) throws SchedulerException, com.ibm.websphere.longrun.JobSubmissionException, java.rmi.RemoteException
jobBlockRequest
- SchedulerException
JobSubmissionException
RemoteException
void purgeJob(java.lang.String jobid) throws InvalidJobIDException, SchedulerException, java.rmi.RemoteException
jobid
- The ID of the job to be purgedInvalidJobIDException
- if no job by the specified job ID exists in the job schedulerSchedulerException
- if an unexpected error is thrown by the job scheduler while purging the jobjava.rmi.RemoteException
void cancelJob(java.lang.String jobid) throws InvalidOperationException, InvalidJobIDException, SchedulerException, java.rmi.RemoteException
jobid
- The ID of the jobInvalidOperationException
- if the operation is currently not allowed on the jobInvalidJobIDException
- if no job by the specified job id exists in the job schedulerSchedulerException
- if an unexpected error is thrown by the job scheduler while canceling the jobjava.rmi.RemoteException
void forcedCancelJob(java.lang.String jobid) throws InvalidOperationException, InvalidJobIDException, SchedulerException, java.rmi.RemoteException
jobid
- The ID of the jobInvalidOperationException
- if the operation is currently not allowed on the jobInvalidJobIDException
- if no job by the specified job ID exists in the job schedulerSchedulerException
- if an unexpected error is thrown by the job scheduler while canceling the jobjava.rmi.RemoteException
void restartJob(java.lang.String jobid, java.lang.String passedPropertiesString, java.lang.Object proxySchedulerLockName) throws SchedulerException, InvalidJobIDException, InvalidOperationException, JCLException, com.ibm.websphere.longrun.JobSubmissionException, java.rmi.RemoteException
jobid
- The ID of the jobInvalidJobIDException
- if no job by the specified job ID exists in the job schedulerInvalidOperationException
- if the operation is currently not allowed on the jobSchedulerException
- if an unexpected error is thrown by the job scheduler while restarting the jobJCLException
- if the xJCL for the job is corrupted or not valid.JobSubmissionException
- if an error occurs while submitting the jobjava.rmi.RemoteException
void restartJob(java.lang.String jobid, java.lang.Object proxySchedulerLockName) throws InvalidJobIDException, InvalidOperationException, SchedulerException, JCLException, com.ibm.websphere.longrun.JobSubmissionException, java.rmi.RemoteException
jobid
- The ID of the jobInvalidJobIDException
- if no job by the specified job ID exists in the job schedulerInvalidOperationException
- if the operation is currently not allowed on the jobSchedulerException
- if an unexpected error is thrown by the job scheduler while restarting the jobJCLException
- if the xJCL for the job is corrupted or not valid.JobSubmissionException
- if an error occurs while submitting the jobjava.rmi.RemoteException
void restartJob(java.lang.String jobid, java.lang.String passedPropertiesString) throws SchedulerException, InvalidJobIDException, InvalidOperationException, JCLException, com.ibm.websphere.longrun.JobSubmissionException, java.rmi.RemoteException
jobid
- The ID of the jobInvalidJobIDException
- if no job by the specified job ID exists in the job schedulerInvalidOperationException
- if the operation is currently not allowed on the jobSchedulerException
- if an unexpected error is thrown by the job scheduler while restarting the jobJCLException
- if the xJCL for the job is corrupted or not valid.JobSubmissionException
- if an error occurs while submitting the jobjava.rmi.RemoteException
void restartJob(java.lang.String jobid) throws InvalidJobIDException, InvalidOperationException, SchedulerException, JCLException, com.ibm.websphere.longrun.JobSubmissionException, java.rmi.RemoteException
jobid
- The ID of the jobInvalidJobIDException
- if no job by the specified job ID exists in the job schedulerInvalidOperationException
- if the operation is currently not allowed on the jobSchedulerException
- if an unexpected error is thrown by the job scheduler while restarting the jobJCLException
- if the xJCL for the job is corrupted or not valid.JobSubmissionException
- if an error occurs while submitting the jobjava.rmi.RemoteException
int getJobStatus(java.lang.String jobid) throws InvalidJobIDException, SchedulerException, java.rmi.RemoteException
JobStatusConstants
for a
list of the job status codes returned by this method.jobid
- The ID of the jobInvalidJobIDException
- if no job by the specified job ID exists in the job schedulerSchedulerException
- if an unexpected error is thrown by the job scheduler while processing the commandjava.rmi.RemoteException
java.lang.String getJobOutput(java.lang.String jobid) throws InvalidJobIDException, SchedulerException, java.rmi.RemoteException
jobid
- The ID of the jobInvalidJobIDException
- if no job by the specified job ID exists in the job schedulerSchedulerException
- if an unexpected error is thrown by the job scheduler while processing the commandjava.rmi.RemoteException
java.lang.String getJobDetails(java.lang.String jobid) throws InvalidJobIDException, SchedulerException, java.rmi.RemoteException
InvalidJobIDException
- if no job by the specified job ID exists in the job schedulerSchedulerException
- if an unexpected error is thrown by the job scheduler while processing the commandjava.rmi.RemoteException
void saveJobToRepository(java.lang.String xJCL, java.lang.String job, boolean replace) throws InvalidOperationException, SchedulerException, JCLException, java.rmi.RemoteException
xJCL
- The xJCL for the jobjob
- The name given to the saved job in the xJCL repository. This name can be used when invoking the submitJobFromRepository
method.replace
- A boolean indicating if the xJCL in the repository should be replaced, in case a job by that name already exists
in the xJCL repository.InvalidOperationException
- if the job already exists in the xJCL repository and the replace parameter specified is falseSchedulerException
- if an unexpected error is thrown by the job scheduler while processing the commandJCLException
- if the xJCL stored in the repository is corrupted or not valid.java.rmi.RemoteException
void saveJobToRepository(java.lang.String xJCL, java.lang.String job, boolean replace, java.lang.String auditString) throws InvalidOperationException, SchedulerException, JCLException, java.rmi.RemoteException
xJCL
- The xJCL for the jobjob
- The name given to the saved job in the xJCL repository. This name can be used when invoking the submitJobFromRepository
method.replace
- A boolean indicating if the xJCL in the repository should be replaced, in case a job by that name already exists
in the xJCL repository.auditString
- text string for audit purposesInvalidOperationException
- if the job already exists in the xJCL repository and the replace parameter specified is falseSchedulerException
- if an unexpected error is thrown by the job scheduler while processing the commandJCLException
- if the xJCL stored in the repository is corrupted or not valid.java.rmi.RemoteException
java.lang.String showJobFromRepository(java.lang.String job) throws InvalidJobNameException, SchedulerException, java.rmi.RemoteException
job
- The name given to the saved job in xJCL repository. This name can be used when invoking the submitJobFromRepository
method.InvalidJobNameException
- if job is not found in the xJCL repository.SchedulerException
- if an unexpected error is thrown by the job scheduler while processing the commandjava.rmi.RemoteException
void removeJobFromRepository(java.lang.String job) throws InvalidJobNameException, SchedulerException, java.rmi.RemoteException
job
- The name given to the saved job in the xJCL repository.InvalidJobNameException
- if the job is not found in the xJCL repository.SchedulerException
- if an unexpected error is thrown by the job scheduler while processing the commandjava.rmi.RemoteException
java.lang.String[] showAllJobs() throws SchedulerException, java.rmi.RemoteException
SchedulerException
- if an unexpected error is thrown by the job scheduler while processing the commandjava.rmi.RemoteException
void suspendJob(java.lang.String jobid, java.lang.String seconds) throws InvalidOperationException, InvalidJobIDException, SchedulerException, java.rmi.RemoteException
jobid
- The ID of the job to suspendseconds
- The number of seconds to suspend the jobInvalidJobIDException
- if no job by the specified job ID exists in the job schedulerInvalidOperationException
- if the operation is currently not allowed on the jobSchedulerException
- if an unexpected error is thrown by the job scheduler while suspending the jobjava.rmi.RemoteException
void resumeJob(java.lang.String jobid) throws InvalidOperationException, InvalidJobIDException, SchedulerException, java.rmi.RemoteException
jobid
- The ID of the job to resumeInvalidJobIDException
- if no job by the specified job ID exists in the job schedulerInvalidOperationException
- if the operation is currently not allowed on the jobSchedulerException
- if an unexpected error is thrown by the job scheduler while resuming the jobjava.rmi.RemoteException
int getBatchJobRC(java.lang.String jobid) throws InvalidOperationException, InvalidJobIDException, SchedulerException, java.rmi.RemoteException
jobid
- The ID of the jobInvalidJobIDException
- if no job by the specified job ID exists in the job schedulerInvalidOperationException
- if the operation is currently not allowed on the jobSchedulerException
- if an unexpected error is thrown by the job scheduler while processing the commandjava.rmi.RemoteException
java.lang.String submitDelayedJob(java.lang.String xJCL, java.lang.String startTime) throws SchedulerException, JCLException, com.ibm.websphere.longrun.JobSubmissionException, InvalidStartDateTimeFormatException, StaleTimeException, java.rmi.RemoteException
xJCL
- The xJCL for the jobstartTime
- The time at which the job will be submitted. The format of the submit time is yyyy-mm-dd hh:mm:ss.SchedulerException
- if an unexpected error is thrown by the job scheduler while submitting the jobJCLException
- if the xJCL for the job is corrupted or not valid.JobSubmissionException
- if an error occurs while submitting the jobInvalidStartDateTimeFormatException
- if the start date and/or time is not in the required formatStaleTimeException
- if the start date and/or time is in the past based on current timejava.rmi.RemoteException
java.lang.String submitDelayedJobFromRepository(java.lang.String job, java.lang.String startTime) throws InvalidJobNameException, SchedulerException, JCLException, com.ibm.websphere.longrun.JobSubmissionException, InvalidStartDateTimeFormatException, StaleTimeException, java.rmi.RemoteException
job
- The name of the job that was stored to the job repositorystartTime
- The time at which the job will be submitted. The format of the submit time is yyyy-mm-dd hh:mm:ss.InvalidJobNameException
- if job is not found in the xJCL repository.SchedulerException
- if an unexpected error is thrown by the job scheduler while submitting the jobJCLException
- if the xJCL for the job is corrupted or not valid.JobSubmissionException
- if an error occurs while submitting the jobInvalidStartDateTimeFormatException
- if the start date and/or time is not in the required formatStaleTimeException
- if the start date and/or time is in the past based on current timejava.rmi.RemoteException
java.lang.String saveDelayedJobToRepositoryAndSubmit(java.lang.String xJCL, java.lang.String job, boolean replace, java.lang.String startTime) throws InvalidOperationException, SchedulerException, JCLException, com.ibm.websphere.longrun.JobSubmissionException, InvalidStartDateTimeFormatException, StaleTimeException, java.rmi.RemoteException
xJCL
- The xJCL for the jobstartTime
- The time at which the job will be submitted. The format of the submit time is yyyy-mm-dd hh:mm:ss.job
- The name given to the saved job in the xJCL repository. This name can be used when invoking the submitJobFromRepository
method.replace
- A boolean indicating if the xJCL in the repository should be replaced, in case a job by that name already exists
in the job repository.InvalidOperationException
- if the operation is currently not allowed on the jobSchedulerException
- if an unexpected error is thrown by the job scheduler while submitting the jobJCLException
- if the xJCL for the job is corrupted or not valid.JobSubmissionException
- if an error occurs while submitting the jobInvalidStartDateTimeFormatException
- if the start date and/or time is not in the required formatStaleTimeException
- if the start date and/or time is in the past based on current timejava.rmi.RemoteException
void submitRecurringRequest(java.lang.String reqId, java.lang.String xJCL, java.lang.String startTime, java.lang.String interval) throws InvalidOperationException, SchedulerException, JCLException, InvalidStartDateTimeFormatException, InvalidIntervalException, StaleTimeException, java.rmi.RemoteException
reqId
- The name of the recurring job requestxJCL
- The xJCL for the jobstartTime
- The time at which the first job will be submitted. The format of the submit time is yyyy-mm-dd hh:mm:ss.interval
- The time interval between jobs (e.g. daily, weekly, monthly)InvalidOperationException
- if the operation is currently not allowed on the jobSchedulerException
- if an unexpected error is thrown by the job scheduler while submitting the jobJCLException
- if the xJCL for the job is corrupted or not valid.InvalidStartDateTimeFormatException
- if the start date and/or time is not in the required formatStaleTimeException
- if the start date and/or time is in the past based on current timeInvalidIntervalException
- if the interval specified is not one of the supported time intervaljava.rmi.RemoteException
void submitRecurringRequestFromRepository(java.lang.String jobName, java.lang.String reqId, java.lang.String startTime, java.lang.String interval) throws InvalidOperationException, SchedulerException, JCLException, InvalidStartDateTimeFormatException, InvalidIntervalException, StaleTimeException, InvalidJobNameException, java.rmi.RemoteException
jobName
- The name of the job that was stored to the job repositoryreqId
- The name of the recurring job requeststartTime
- The time at which the job will be submitted. The format of the submit time is yyyy-mm-dd hh:mm:ss..interval
- The time interval between jobs (e.g. daily, weekly, monthly)InvalidOperationException
- if the operation is currently not allowed on the jobSchedulerException
- if an unexpected error is thrown by the job scheduler while submitting the jobJCLException
- if the xJCL for the job is corrupted or not valid.InvalidStartDateTimeFormatException
- if the start date and/or time is not in the required formatStaleTimeException
- if the start date and/or time is in the past based on current timeInvalidIntervalException
- if the interval specified is not one of the supported time intervalInvalidJobNameException
- if job is not found in the xJCL repository.java.rmi.RemoteException
void cancelRecurringRequest(java.lang.String reqId) throws InvalidOperationException, SchedulerException, java.rmi.RemoteException
reqId
- The name of the job scheduleInvalidOperationException
- if the operation is currently not allowed on the jobSchedulerException
- if an unexpected error is thrown by the job scheduler while canceling the jobjava.rmi.RemoteException
java.lang.String getRecurringRequestDetails(java.lang.String reqId) throws SchedulerException, InvalidOperationException, java.rmi.RemoteException
reqId
- The name of the job schedule to be returnedSchedulerException
- if an unexpected error is thrown by the job scheduler while processing the commandInvalidOperationException
- if the operation is currently not allowed on the jobjava.rmi.RemoteException
void modifyRecurringRequest(java.lang.String reqId, java.lang.String xJCL, java.lang.String startTime, java.lang.String interval) throws SchedulerException, JCLException, InvalidOperationException, InvalidStartDateTimeFormatException, StaleTimeException, InvalidIntervalException, java.rmi.RemoteException
reqId
- The name of the job schedule to be modifiedxJCL
- The xJCL for the jobstartTime
- The time at which the first job will be submitted. The format of the submit time is yyyy-mm-dd hh:mm:ss.interval
- The time interval between jobs (e.g. daily, weekly, monthly)SchedulerException
- if an unexpected error is thrown by the job scheduler while processing the commandJCLException
- if the xJCL for the job is corrupted or not valid.InvalidOperationException
- if the operation is currently not allowed on the jobInvalidStartDateTimeFormatException
- if the start date and/or time is not in the required formatStaleTimeException
- if the start date and/or time is in the past based on current timeInvalidIntervalException
- if the interval specified is not one of the supported time intervaljava.rmi.RemoteException
java.lang.String[] showAllRecurringRequests() throws SchedulerException, java.rmi.RemoteException
SchedulerException
- if an unexpected error is thrown by the job scheduler while processing the commandjava.rmi.RemoteException
java.lang.String[] showRecurringJobs(java.lang.String reqId) throws SchedulerException, InvalidOperationException, java.rmi.RemoteException
reqId
- the name of the job scheduleSchedulerException
- if an unexpected error is thrown by the job scheduler while processing the commandInvalidOperationException
- if the operation is currently not allowed on the jobjava.rmi.RemoteException
java.lang.String getJobsStatus(java.lang.String[] jobid) throws SchedulerException, java.rmi.RemoteException
jobid
- List of job IDsSchedulerException
- if an unexpected error is thrown by the job scheduler while processing the commandjava.rmi.RemoteException
java.lang.String[] getJobsId(java.lang.String jobFilter, java.lang.String submitterFilter, java.lang.String nodeFilter, java.lang.String appServerFilter, java.lang.Integer[] stateFilter, java.lang.String sortBy, boolean ascending) throws SchedulerException, java.rmi.RemoteException
jobFilter
- SQL filter value to apply to the job ID (e.g. Postings% )submitterFilter
- SQL filter value to apply to the submitternodeFilter
- SQL filter value to apply to the names of the nodes where the jobs executed (e.g. node_ )appServerFilter
- SQL filter value to apply to the names of the application servers where the jobs executedstateFilter
- List of job states. Refer to JobStatusConstants
for a
list of the possible job states.sortBy
- - Field used to sort results (e.g. JOBID, STATUS, APPSERVER)ascending
- - flag indicating whether the results should be returned in ascending or descending order
of the sortBy field.SchedulerException
- if an unexpected error is thrown by the job scheduler while processing the commandjava.rmi.RemoteException
java.lang.String[] getJobsId(java.lang.String jobFilter, java.lang.String submitterFilter, java.lang.String nodeFilter, java.lang.String appServerFilter, java.lang.Integer[] stateFilter, java.lang.String sortBy, boolean ascending, java.lang.String groupFilter) throws SchedulerException, java.rmi.RemoteException
jobFilter
- SQL filter value to apply to the job ID (e.g. Postings% )submitterFilter
- SQL filter value to apply to the submitternodeFilter
- SQL filter value to apply to the names of the nodes where the jobs executed (e.g. node_ )appServerFilter
- SQL filter value to apply to the names of the application servers where the jobs executedstateFilter
- List of job states. Refer to JobStatusConstants
for a
list of the possible job states.sortBy
- - Field used to sort results (e.g. JOBID, STATUS, APPSERVER)ascending
- - flag indicating whether the results should be returned in ascending or descending order
of the sortBy field.groupFilter
- SQL filter value to apply to the group of the job.SchedulerException
- if an unexpected error is thrown by the job scheduler while processing the commandjava.rmi.RemoteException
int[] cancelJob(java.lang.String[] jobid) throws SchedulerException, java.rmi.RemoteException
jobid
- The list of job IDs to cancelJobSchedulerConstants
for a list of the possible return codes.SchedulerException
- if an unexpected error is thrown by the job scheduler while canceling the jobjava.rmi.RemoteException
int getJobsTotal() throws SchedulerException, java.rmi.RemoteException
SchedulerException
java.rmi.RemoteException
int[] purgeJob(java.lang.String[] jobid) throws SchedulerException, java.rmi.RemoteException
jobid
- The list of job IDs to purgeJobSchedulerConstants
for a list of the possible return codes.SchedulerException
- if an unexpected error is thrown by the job scheduler while purging the jobjava.rmi.RemoteException
int[] restartJob(java.lang.String[] jobid) throws SchedulerException, java.rmi.RemoteException
jobid
- The list of job IDs to restartJobSchedulerConstants
for a list of the possible return codes.SchedulerException
- if an unexpected error is thrown by the job scheduler while restarting the jobjava.rmi.RemoteException
int[] resumeJob(java.lang.String[] jobid) throws SchedulerException, java.rmi.RemoteException
jobid
- The list of job IDs to resumeJobSchedulerConstants
for a list of the possible return codes.SchedulerException
- if an unexpected error is thrown by the job scheduler while resuming the jobjava.rmi.RemoteException
int[] suspendJob(java.lang.String[] jobid, java.lang.String seconds) throws SchedulerException, InvalidOperationException, java.rmi.RemoteException
jobid
- The ID of the job to suspendseconds
- The number of seconds to suspend the jobJobSchedulerConstants
for a list of the possible return codes.InvalidOperationException
- if the operation is currently not allowed on the jobSchedulerException
- if an unexpected error is thrown by the job scheduler while suspending the jobjava.rmi.RemoteException
java.lang.String submitModifiableDelayedJobFromRepository(java.lang.String job, java.lang.String startTime, java.lang.String nameValuePairs) throws InvalidJobNameException, SchedulerException, JCLException, com.ibm.websphere.longrun.JobSubmissionException, InvalidStartDateTimeFormatException, StaleTimeException, java.rmi.RemoteException
job
- The name of the job that was stored to the xJCL repositorystartTime
- The time at which the job will be submitted. The format of the submit time is yyyy-mm-dd hh:mm:ss.nameValuePairs
- The space delimited name=value pairs which are used to modify the xJCL e.g.. "host=myhost port=myport")
Any values that contain special characters or spaces must be URL encoded with an encoding scheme of UTF-8 before being passed in on the request.InvalidJobNameException
- if the job is not found in the xJCL repository.SchedulerException
- if an unexpected error is thrown by the job scheduler while submitting the jobJCLException
- if the xJCL for the job is corrupted or not valid.JobSubmissionException
- if an error occurs while submitting the jobInvalidStartDateTimeFormatException
- if the start date and/or time is not in the required formatStaleTimeException
- if the start date and/or time is in the past based on current timejava.rmi.RemoteException
java.lang.String submitModifiableDelayedJob(java.lang.String xJCL, java.lang.String startTime, java.lang.String nameValuePairs) throws SchedulerException, JCLException, com.ibm.websphere.longrun.JobSubmissionException, InvalidStartDateTimeFormatException, StaleTimeException, java.rmi.RemoteException
xJCL
- The xJCL for the jobstartTime
- The time at which the job will be submitted. The format of the submit time is yyyy-mm-dd hh:mm:ss.nameValuePairs
- The space delimited name=value pairs which are used to modify the xJCL e.g.. "host=myhost port=myport")
Any values that contain special characters or spaces must be URL encoded with an encoding scheme of UTF-8 before being passed in on the request.SchedulerException
- if an unexpected error is thrown by the job scheduler while submitting the jobJCLException
- if the xJCL for the job is corrupted or not valid.JobSubmissionException
- if an error occurs while submitting the jobInvalidStartDateTimeFormatException
- if the start date and/or time is not in the required formatStaleTimeException
- if the start date and/or time is in the past based on current timejava.rmi.RemoteException
java.lang.String saveModifiableDelayedJobToRepositoryAndSubmit(java.lang.String xJCL, java.lang.String job, boolean replace, java.lang.String startTime, java.lang.String nameValuePairs) throws InvalidOperationException, SchedulerException, JCLException, com.ibm.websphere.longrun.JobSubmissionException, InvalidStartDateTimeFormatException, StaleTimeException, java.rmi.RemoteException
xJCL
- The xJCL for the jobstartTime
- The time at which the job will be submitted. The format of the submit time is yyyy-mm-dd hh:mm:ss.job
- The name given to the saved job in the xJCL repository. This name can be used when invoking the submitJobFromRepository
method.replace
- A boolean indicating if the xJCL in the repository should be replaced, in case a job by that name already exists
in the job repository.nameValuePairs
- The space delimited name=value pairs which are used to modify the xJCL e.g.. "host=myhost port=myport")
Any values that contain special characters or spaces must be URL encoded with an encoding scheme of UTF-8 before being passed in on the request.InvalidOperationException
- if the operation is currently not allowed on the jobSchedulerException
- if an unexpected error is thrown by the job scheduler while submitting the jobJCLException
- if the xJCL for the job is corrupted or not valid.JobSubmissionException
- if an error occurs while submitting the jobInvalidStartDateTimeFormatException
- if the start date and/or time is not in the required formatStaleTimeException
- if the start date and/or time is in the past based on current timejava.rmi.RemoteException
void submitModifiableRecurringRequest(java.lang.String reqId, java.lang.String xJCL, java.lang.String startTime, java.lang.String interval, java.lang.String nameValuePairs) throws InvalidOperationException, SchedulerException, JCLException, InvalidStartDateTimeFormatException, InvalidIntervalException, StaleTimeException, java.rmi.RemoteException
reqId
- The name of the job schedulexJCL
- The xJCL for the jobstartTime
- The time at which the job will be submitted. The format of the submit time is yyyy-mm-dd hh:mm:ss.interval
- The time interval between jobs (e.g. daily, weekly, monthly)nameValuePairs
- The space delimited name=value pairs which are used to modify the xJCL e.g.. "host=myhost port=myport")
Any values that contain special characters or spaces must be URL encoded with an encoding scheme of UTF-8 before being passed in on the request.InvalidOperationException
- if the operation is currently not allowed on the jobSchedulerException
- if an unexpected error is thrown by the job scheduler while submitting the jobJCLException
- if the xJCL for the job is corrupted or not valid.InvalidStartDateTimeFormatException
- if the start date and/or time is not in the required formatStaleTimeException
- if the start date and/or time is in the past based on current timeInvalidIntervalException
- if the interval specified is not one of the supported time intervaljava.rmi.RemoteException
void submitModifiableRecurringRequestFromRepository(java.lang.String jobName, java.lang.String reqId, java.lang.String startTime, java.lang.String interval, java.lang.String nameValuePairs) throws InvalidOperationException, SchedulerException, JCLException, InvalidStartDateTimeFormatException, InvalidIntervalException, StaleTimeException, InvalidJobNameException, java.rmi.RemoteException
jobName
- The name of the job that was stored to the job repositoryreqId
- The name of the recurring job requeststartTime
- The time at which the job will be submitted. The format of the submit time is yyyy-mm-dd hh:mm:ss.interval
- The time interval between jobs (e.g. daily, weekly, monthly)nameValuePairs
- The space delimited name=value pairs which are used to modify the xJCL e.g.. "host=myhost port=myport")
Any values that contain special characters or spaces must be URL encoded with an encoding scheme of UTF-8 before being passed in on the request.InvalidOperationException
- if the operation is currently not allowed on the jobSchedulerException
- if an unexpected error is thrown by the job scheduler while submitting the jobJCLException
- if the xJCL for the job is corrupted or not valid.InvalidStartDateTimeFormatException
- if the start date and/or time is not in the required formatStaleTimeException
- if the start date and/or time is in the past based on current timeInvalidIntervalException
- if the interval specified is not one of the supported time intervalInvalidJobNameException
- if job is not found in the xJCL repository.java.rmi.RemoteException
java.lang.String saveModifiableJobToRepositoryAndSubmit(java.lang.String xJCL, java.lang.String job, boolean replace, java.lang.String nameValuePairs) throws InvalidOperationException, SchedulerException, JCLException, com.ibm.websphere.longrun.JobSubmissionException, java.rmi.RemoteException
xJCL
- The xJCL for the jobjob
- The name given to the saved job in xJCL repository. This name can be used when invoking the submitJobFromRepository
method.replace
- A boolean indicating if the xJCL in the repository should be replaced, in case a job by that name already exists
in the xJCL repository.nameValuePairs
- The space delimited name=value pairs which are used to modify the xJCL e.g.. "host=myhost port=myport")
Any values that contain special characters or spaces must be URL encoded with an encoding scheme of UTF-8 before being passed in on the request.InvalidOperationException
- if the job already exists in the xJCL repository and the replace parameter specified is falseSchedulerException
- if an unexpected error is thrown by the job scheduler while submitting the jobJCLException
- if the xJCL stored in the repository is corrupted or not valid.JobSubmissionException
- if an error occurs while submitting the jobjava.rmi.RemoteException
java.lang.String submitModifiableJobFromRepository(java.lang.String job, java.lang.String nameValuePairs) throws InvalidJobNameException, SchedulerException, JCLException, com.ibm.websphere.longrun.JobSubmissionException, java.rmi.RemoteException
job
- The name of the job that was stored to the xJCL repositorynameValuePairs
- The space delimited name=value pairs which are used to modify the xJCL (e.g.. "host=myhost port=myport")
Any values that contain special characters or spaces must be URL encoded with an encoding scheme of UTF-8 before being passed in on the request.InvalidJobNameException
- if job is not found in the xJCL repository.SchedulerException
- if an unexpected error is thrown by the job scheduler while submitting the jobJCLException
- if the xJCL stored in the repository is corrupted or not valid.JobSubmissionException
- if an error occurs while submitting the jobjava.rmi.RemoteException
java.lang.String privateSubmitModifiableJobFromRepository(java.lang.String job, java.lang.String nameValuePairs, int jobNumber) throws InvalidJobNameException, SchedulerException, JCLException, com.ibm.websphere.longrun.JobSubmissionException, java.rmi.RemoteException
InvalidJobNameException
SchedulerException
JCLException
com.ibm.websphere.longrun.JobSubmissionException
java.rmi.RemoteException
java.lang.String privateSubmitModifiableJobFromRepository(java.lang.String job, java.lang.String nameValuePairs, int jobNumber, java.lang.String proxySchedulerLockName) throws InvalidJobNameException, SchedulerException, JCLException, com.ibm.websphere.longrun.JobSubmissionException, java.rmi.RemoteException
InvalidJobNameException
SchedulerException
JCLException
com.ibm.websphere.longrun.JobSubmissionException
java.rmi.RemoteException
java.lang.String submitModifiableJob(java.lang.String xJCL, java.lang.String nameValuePairs) throws SchedulerException, JCLException, com.ibm.websphere.longrun.JobSubmissionException, java.rmi.RemoteException
xJCL
- The xJCL for the jobnameValuePairs
- The space delimited name=value pairs which are used to modify the xJCL (e.g. "host=myhost port=myport")
Any values that contain special characters or spaces must be URL encoded with an encoding scheme of UTF-8 before being passed in on the request.SchedulerException
- if an unexpected error is thrown by the job scheduler while submitting the jobJCLException
- if the xJCL stored in the repository is corrupted or not valid.JobSubmissionException
- if an error occurs while submitting the jobjava.rmi.RemoteException
java.lang.String privateSubmitModifiableJob(java.lang.String xJCL, java.lang.String nameValuePairs, int jobNumber) throws SchedulerException, JCLException, com.ibm.websphere.longrun.JobSubmissionException, java.rmi.RemoteException
SchedulerException
JCLException
com.ibm.websphere.longrun.JobSubmissionException
java.rmi.RemoteException
java.lang.String privateSubmitModifiableJob(java.lang.String xJCL, java.lang.String nameValuePairs, int jobNumber, java.lang.String proxySchedulerLockName) throws SchedulerException, JCLException, com.ibm.websphere.longrun.JobSubmissionException, java.rmi.RemoteException
SchedulerException
JCLException
com.ibm.websphere.longrun.JobSubmissionException
java.rmi.RemoteException
int privateReserveJobNumber() throws SchedulerException, java.rmi.RemoteException
SchedulerException
java.rmi.RemoteException
java.lang.String privateReserveJobNumberString() throws SchedulerException, java.rmi.RemoteException
SchedulerException
java.rmi.RemoteException
java.lang.String privateGetJobID(int jobNumber) throws SchedulerException, java.rmi.RemoteException
SchedulerException
java.rmi.RemoteException
void modifyModifiableRecurringRequest(java.lang.String reqId, java.lang.String xJCL, java.lang.String startTime, java.lang.String interval, java.lang.String nameValuePairs) throws SchedulerException, JCLException, InvalidOperationException, InvalidStartDateTimeFormatException, StaleTimeException, InvalidIntervalException, java.rmi.RemoteException
reqId
- The name of the job schedule to be modifiedxJCL
- The xJCL for the jobstartTime
- The time at which the first job will be submitted. The format of the submit time is yyyy-mm-dd hh:mm:ss.interval
- The time interval between jobs (e.g. daily, weekly, monthly)nameValuePairs
- The space delimited name=value pairs which are used to modify the xJCL (e.g. "host=myhost port=myport")
Any values that contain special characters or spaces must be URL encoded with an encoding scheme of UTF-8 before being passed in on the request.SchedulerException
- if an unexpected error is thrown by the job scheduler while processing the commandJCLException
- if the xJCL for the job is corrupted or not valid.InvalidOperationException
- if the operation is currently not allowed on the jobInvalidStartDateTimeFormatException
- if the start date and/or time is not in the required formatStaleTimeException
- if the start date and/or time is in the past based on current timeInvalidIntervalException
- if the interval specified is not one of the supported time intervaljava.rmi.RemoteException
java.lang.String[] getJobsName(java.lang.String jobNameFilter, java.lang.String jobDescFilter, java.lang.String sortBy, boolean ascending) throws SchedulerException, java.rmi.RemoteException
jobNameFilter
- SQL filter value to apply to the job names (e.g. Postings% )jobDescFilter
- not usedsortBy
- - Field used to sort results (e.g. JOBNAME, TXT)ascending
- - flag indicating whether the results should be returned in ascending or descending order
of the sortBy field.SchedulerException
- if an unexpected error is thrown by the job scheduler while processing the requestjava.rmi.RemoteException
java.lang.String[] getJobsName(java.lang.String jobNameFilter, java.lang.String jobDescFilter, java.lang.String sortBy, boolean ascending, java.lang.String groupFilter) throws SchedulerException, java.rmi.RemoteException
jobNameFilter
- SQL filter value to apply to the job names (e.g. Postings% )jobDescFilter
- not usedsortBy
- - Field used to sort results (e.g. JOBNAME, TXT)ascending
- - flag indicating whether the results should be returned in ascending or descending order
of the sortBy field.groupFilter
- SQL filter value to apply to the group name.SchedulerException
- if an unexpected error is thrown by the job scheduler while processing the requestjava.rmi.RemoteException
void stopJob(java.lang.String jobid) throws InvalidOperationException, InvalidJobIDException, SchedulerException, java.rmi.RemoteException
jobid
- The ID of the jobInvalidOperationException
- if the operation is currently not allowed on the jobInvalidJobIDException
- if no job by the specified job ID exists in the job schedulerSchedulerException
- if an unexpected error is thrown by the job scheduler while processing the requestjava.rmi.RemoteException
int[] stopJob(java.lang.String[] jobid) throws SchedulerException, java.rmi.RemoteException
jobid
- The list of job IDs to stopJobSchedulerConstants
for a list of the possible return codes.SchedulerException
- if an unexpected error is thrown by the job scheduler while purging the jobjava.rmi.RemoteException
java.lang.String getSymbolicVariablesForExistingJob(java.lang.String jobId) throws SchedulerException, JCLException, java.rmi.RemoteException
jobid
- jobId of the job whoose symbolic variables need to be fetchedjobId
- SchedulerException
- if an unexpected error is thrown by the job scheduler while processing the commandJCLException
- if the xJCL stored in the repository is corrupted or not valid.java.rmi.RemoteException
SchedulerException
JCLException
java.lang.String getSymbolicVariables(java.lang.String clientXJCL) throws SchedulerException, JCLException, java.rmi.RemoteException
xJCL
- The xJCL for the jobSchedulerException
- if an unexpected error is thrown by the job scheduler while processing the commandJCLException
- if the xJCL stored in the repository is corrupted or not valid.java.rmi.RemoteException
java.lang.String getRequests(java.lang.String[] requestid) throws SchedulerException, java.rmi.RemoteException
requestid
- List of job schedule namesSchedulerException
- if an unexpected error is thrown by the job scheduler while processing the commandjava.rmi.RemoteException
java.lang.String[] getRequestsId(java.lang.String requestIdFilter, java.lang.String startTimeFilter, java.lang.String submitterFilter, java.lang.String[] intervalFilter, java.lang.Integer[] statusFilter, java.lang.String sortBy, boolean ascending) throws SchedulerException, java.rmi.RemoteException
requestIdFilter
- SQL filter value to apply to the name of the job schedule (e.g. %Postings% )startTimeFilter
- SQL filter value to apply to the initial submit time of the jobs. The format of the submit time is yyyy-mm-dd hh:mm:ss.submitterFilter
- SQL filter value to apply to the submitterintervalFilter
- List of time periods between job submissions (e.g. daily, weekly, monthly)statusFilter
- List of job states. Refer to JobStatusConstants
for a
list of the possible job states.sortBy
- - Field used to sort results (e.g. REQUESTID, STARTTIME, INTERVAL)ascending
- - flag indicating whether the results should be returned in ascending or descending order
of the sortBy field.SchedulerException
- if an unexpected error is thrown by the job scheduler while processing the commandjava.rmi.RemoteException
java.lang.String[] getRequestsId(java.lang.String requestIdFilter, java.lang.String startTimeFilter, java.lang.String submitterFilter, java.lang.String[] intervalFilter, java.lang.Integer[] statusFilter, java.lang.String sortBy, boolean ascending, java.lang.String groupFilter) throws SchedulerException, java.rmi.RemoteException
requestIdFilter
- SQL filter value to apply to the name of the job schedule (e.g. %Postings% )startTimeFilter
- SQL filter value to apply to the initial submit time of the jobs. The format of the submit time is yyyy-mm-dd hh:mm:ss.submitterFilter
- SQL filter value to apply to the submitterintervalFilter
- List of time periods between job submissions (e.g. daily, weekly, monthly)statusFilter
- List of job states. Refer to JobStatusConstants
for a
list of the possible job states.sortBy
- - Field used to sort results (e.g. REQUESTID, STARTTIME, INTERVAL)ascending
- - flag indicating whether the results should be returned in ascending or descending order
of the sortBy field.groupFilter
- SQL filter value to apply to the name of the group of a jobSchedulerException
- if an unexpected error is thrown by the job scheduler while processing the commandjava.rmi.RemoteException
int[] cancelRecurringRequest(java.lang.String[] reqId) throws SchedulerException, java.rmi.RemoteException
reqId
- The list of job schedule names to cancelJobSchedulerConstants
for a list of the possible return codes.SchedulerException
- if an unexpected error is thrown by the job scheduler while canceling the jobjava.rmi.RemoteException
java.lang.String getJobLog(java.lang.String jobid) throws SchedulerException, InvalidJobIDException, InvalidOperationException, java.rmi.RemoteException
jobid
- The ID of the job whose log file name is to be returnedSchedulerException
- if an unexpected error is thrown by the Job Scheduler while processing the commandInvalidJobIDException
- if no job logs for the specified job ID are found by the Job SchedulerInvalidOperationException
- if the operation is currently not allowed on the jobjava.rmi.RemoteException
java.lang.String[] getLogMetaData(java.lang.String jobid) throws SchedulerException, InvalidJobIDException, InvalidOperationException, java.rmi.RemoteException
jobid
- The ID of the job whose meta-data is to be returnedSchedulerException
- if an unexpected error is thrown by the Job Scheduler while processing the commandInvalidJobIDException
- if no job log meta-data for the specified job ID is found by the Job SchedulerInvalidOperationException
- if the operation is currently not allowed on the jobjava.rmi.RemoteException
java.lang.String[] getLogPartList(java.lang.String jobid, java.lang.String logSubDirName) throws SchedulerException, InvalidJobIDException, InvalidOperationException, java.rmi.RemoteException
jobid
- The ID of the job whose part information is to be returnedlogSubDirName
- The name of the log subdirectory of the job whose part information is to be returnedSchedulerException
- if an unexpected error is thrown by the Job Scheduler while processing the commandInvalidJobIDException
- if no part information for the specified job ID is found by the Job SchedulerInvalidOperationException
- if the operation is currently not allowed on the jobjava.rmi.RemoteException
java.lang.String[] getLogPart(java.lang.String jobid, java.lang.String logSubDirName, java.lang.String partNumber) throws SchedulerException, InvalidJobIDException, InvalidOperationException, java.rmi.RemoteException
jobid
- The ID of the job whose part information is to be returnedlogSubDirName
- The name of the log subdirectory of the job whose part information is to be returnedpartNumber
- The name of the job log chunk in the log subdirectory whose part information is to be returnedSchedulerException
- if an unexpected error is thrown by the Job Scheduler while processing the commandInvalidJobIDException
- if no part information for the specified job ID is found by the Job SchedulerInvalidOperationException
- if the operation is currently not allowed on the jobjava.rmi.RemoteException
java.lang.String getLogSize(java.lang.String jobid, java.lang.String logSubDirName) throws SchedulerException, InvalidJobIDException, InvalidOperationException, java.rmi.RemoteException
jobid
- The ID of the job whose size information is to be returnedlogSubDirName
- The name of the log subdirectory of the job whose size information is to be returnedSchedulerException
- if an unexpected error is thrown by the Job Scheduler while processing the commandInvalidJobIDException
- if no size information for the specified job ID is found by the Job SchedulerInvalidOperationException
- if the operation is currently not allowed on the jobjava.rmi.RemoteException
int getLogAge(java.lang.String jobid, java.lang.String logSubDirName) throws SchedulerException, InvalidJobIDException, InvalidOperationException, java.rmi.RemoteException
jobid
- The ID of the job whose age information is to be returnedlogSubDirName
- The name of the log subdirectory of the job whose age information is to be returnedSchedulerException
- if an unexpected error is thrown by the Job Scheduler while processing the commandInvalidJobIDException
- if no age information for the specified job ID is found by the Job SchedulerInvalidOperationException
- if the operation is currently not allowed on the jobjava.rmi.RemoteException
java.lang.String[] getJobsByClass(java.lang.String jobClass) throws SchedulerException, InvalidOperationException, java.rmi.RemoteException
jobid
- The class identifier whose job list information is to be returnedjobClass
- The class identifier on which to matchSchedulerException
- if an unexpected error is thrown by the Job Scheduler while processing the commandInvalidOperationException
- if the operation is currently not allowed on the jobjava.rmi.RemoteException
void removeJobLog(java.lang.String jobid) throws SchedulerException, InvalidJobIDException, InvalidOperationException, java.rmi.RemoteException
jobid
- The ID of the job whose zipped log file is to be removedSchedulerException
- if an unexpected error is thrown by the Job Scheduler while processing the commandInvalidJobIDException
- if no part information for the specified job ID is found by the Job SchedulerInvalidOperationException
- if the operation is currently not allowed on the jobjava.rmi.RemoteException
void purgeJobLog(java.lang.String jobid, java.lang.String logSubDirName) throws SchedulerException, InvalidJobIDException, InvalidOperationException, java.rmi.RemoteException
jobid
- The ID of the job whose job log is to be purgedlogSubDirName
- The name of the log subdirectory of the job whose job log is to be purgedSchedulerException
- if an unexpected error is thrown by the Job Scheduler while processing the commandInvalidJobIDException
- if no job information for the specified job ID is found by the Job SchedulerInvalidOperationException
- if the operation is currently not allowed on the jobjava.rmi.RemoteException
java.lang.String[] getAdminAddresses() throws SchedulerException, InvalidOperationException, java.rmi.RemoteException
SchedulerException
- if an unexpected error is thrown by the Job Scheduler while processing the commandInvalidOperationException
- if the operation is currently not allowed on the jobjava.rmi.RemoteException
java.lang.String[] getUserPrefs(java.lang.String userId, java.lang.String prefScope) throws SchedulerException, java.rmi.RemoteException
userId
- The user ID used to log into the Job Management ConsoleprefScope
- The scope of the preferences within the Job Management Console. (e.g. JobCollectionForm, SavedJobCollectionForm,
JobScheduleCollectionForm)SchedulerException
- if an unexpected error is thrown by the job scheduler while processing the commandjava.rmi.RemoteException
void saveUserPrefs(java.lang.String userId, java.lang.String prefScope, java.lang.String[] prefNameValue) throws SchedulerException, java.rmi.RemoteException
userId
- The user ID used to log into the Job Management ConsoleprefScope
- The scope of the preferences within the Job Management Console. (e.g. JobCollectionForm, SavedJobCollectionForm,
JobScheduleCollectionForm)prefNameValue
- The list of user preferences in the format of name=valueSchedulerException
- if an unexpected error is thrown by the job scheduler while processing the commandjava.rmi.RemoteException
java.lang.String[] getJobLogMetaDataByAgeForClass(java.lang.String jobClass) throws SchedulerException, InvalidOperationException, java.rmi.RemoteException
jobClass
- The class identifier on which to matchSchedulerException
- if an unexpected error is thrown by the Job Scheduler while processing the commandInvalidOperationException
- if the operation is currently not allowed on the jobjava.rmi.RemoteException
java.lang.String[] getJobLogMetaDataBySizeForClass(java.lang.String jobClass) throws SchedulerException, InvalidOperationException, java.rmi.RemoteException
jobClass
- The class identifier on which to matchSchedulerException
- if an unexpected error is thrown by the Job Scheduler while processing the commandInvalidOperationException
- if the operation is currently not allowed on the jobjava.rmi.RemoteException
void quiesceLogging(java.lang.String jobid) throws SchedulerException, InvalidJobIDException, InvalidOperationException, java.rmi.RemoteException
jobid
- The ID of the job whose application job logging is to be stoppedSchedulerException
- if an unexpected error is thrown by the Job Scheduler while processing the commandInvalidJobIDException
- if the specified job ID is not found by the Job SchedulerInvalidOperationException
- if the operation is currently not allowed on the jobjava.rmi.RemoteException
void sendCheckpointNotification(java.lang.String jobid, java.lang.String Status) throws java.rmi.RemoteException
jobid
- The ID of the jobStatus
- The status of the jobjava.rmi.RemoteException
boolean isSAF() throws java.rmi.RemoteException
java.rmi.RemoteException
boolean isAuditRepositoryUpdateEnforced() throws java.rmi.RemoteException
java.rmi.RemoteException