/NameServiceCellRoot");
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();
Method Summary |
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)
Cancel an existing job schedule |
int[] |
cancelRecurringRequest(java.lang.String[] reqId)
Cancel existing job schedules |
void |
forcedCancelJob(java.lang.String jobid)
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[] |
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 |
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 |
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)
Returns details of an existing job schedule. |
java.lang.String |
getRequests(java.lang.String[] requestid)
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)
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[] |
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 |
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)
Modify an existing job schedule. |
void |
modifyRecurringRequest(java.lang.String reqId,
java.lang.String xJCL,
java.lang.String startTime,
java.lang.String interval)
Modify an existing job schedule. |
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 |
void |
removeJobFromRepository(java.lang.String job)
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) ] |
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 |
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)
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)
Saves the xJCL passed in to the xJCL Repository. |
java.lang.String |
saveJobToRepositoryAndSubmit(java.lang.String xJCL,
java.lang.String job,
boolean replace)
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)
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)
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()
Lists all existing job schedules |
java.lang.String |
showJobFromRepository(java.lang.String job)
Returns the xJCL from the xJCL repository for the given job name. |
java.lang.String[] |
showRecurringJobs(java.lang.String reqId)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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. |
Methods inherited from interface javax.ejb.EJBObject |
getEJBHome, getHandle, getPrimaryKey, isIdentical, remove |
submitJobFromRepository
java.lang.String submitJobFromRepository(java.lang.String job)
throws InvalidJobNameException,
SchedulerException,
JCLException,
JobSubmissionException,
java.rmi.RemoteException
- Submits the specified job, saved in the xJCL repository, to the job scheduler
- Parameters:
job
- The name of the job that was stored to the xJCL repository
- Returns:
- the job ID assigned by the job scheduler to the submitted job
- Throws:
InvalidJobNameException
- if job is not found in the xJCL repository.
SchedulerException
- if an unexpected error is thrown by the job scheduler while submitting the job
JCLException
- if the xJCL stored in the repository is corrupted or not valid.
JobSubmissionException
- if an error occurs while submitting the job
java.rmi.RemoteException
submitJob
java.lang.String submitJob(java.lang.String xJCL)
throws SchedulerException,
JCLException,
JobSubmissionException,
java.rmi.RemoteException
- Submits the job, which is defined by the xJCL, to the job scheduler
- Parameters:
xJCL
- The xJCL for the job
- Returns:
- the job ID assigned by the job scheduler to the submitted job
- Throws:
SchedulerException
- if an unexpected error is thrown by the job scheduler while submitting the job
JCLException
- if the xJCL stored in the repository is corrupted or not valid.
JobSubmissionException
- if an error occurs while submitting the job
java.rmi.RemoteException
saveJobToRepositoryAndSubmit
java.lang.String saveJobToRepositoryAndSubmit(java.lang.String xJCL,
java.lang.String job,
boolean replace)
throws InvalidOperationException,
SchedulerException,
JCLException,
JobSubmissionException,
java.rmi.RemoteException
- Submits the job specified by the xJCL passed in to the job scheduler and
saves the xJCL to the xJCL repository.
- Parameters:
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.
- Returns:
- the job ID assigned by the job scheduler to the submitted job
- Throws:
InvalidOperationException
- if the job already exists in the xJCL repository and the replace parameter specified is false
SchedulerException
- if an unexpected error is thrown by the job scheduler while submitting the job
JCLException
- if the xJCL stored in the repository is corrupted or not valid.
JobSubmissionException
- if an error occurs while submitting the job
java.rmi.RemoteException
purgeJob
void purgeJob(java.lang.String jobid)
throws InvalidJobIDException,
SchedulerException,
java.rmi.RemoteException
- Purges the job, identified by the job ID, from the job scheduler and the grid endpoint environments.
- Parameters:
jobid
- The ID of the job to be purged
- Throws:
InvalidJobIDException
- if no job by the specified job ID exists in the job scheduler
SchedulerException
- if an unexpected error is thrown by the job scheduler while purging the job
java.rmi.RemoteException
cancelJob
void cancelJob(java.lang.String jobid)
throws InvalidOperationException,
InvalidJobIDException,
SchedulerException,
java.rmi.RemoteException
- Cancels the job identified by the job ID
- Parameters:
jobid
- The ID of the job
- Throws:
InvalidOperationException
- if the operation is currently not allowed on the job
InvalidJobIDException
- if no job by the specified job id exists in the job scheduler
SchedulerException
- if an unexpected error is thrown by the job scheduler while canceling the job
java.rmi.RemoteException
forcedCancelJob
void forcedCancelJob(java.lang.String jobid)
throws InvalidOperationException,
InvalidJobIDException,
SchedulerException,
java.rmi.RemoteException
- Forcibly cancels the job identified by the job ID
Supported on z/OS only. The forcedCancelJob request will be processed as a cancelJob request on
distributed platforms.
- Parameters:
jobid
- The ID of the job
- Throws:
InvalidOperationException
- if the operation is currently not allowed on the job
InvalidJobIDException
- if no job by the specified job ID exists in the job scheduler
SchedulerException
- if an unexpected error is thrown by the job scheduler while canceling the job
java.rmi.RemoteException
restartJob
void restartJob(java.lang.String jobid)
throws InvalidJobIDException,
InvalidOperationException,
SchedulerException,
JCLException,
JobSubmissionException,
java.rmi.RemoteException
- Restarts the job identified by the job ID. Only jobs in the restartable state can be restarted.
- Parameters:
jobid
- The ID of the job
- Throws:
InvalidJobIDException
- if no job by the specified job ID exists in the job scheduler
InvalidOperationException
- if the operation is currently not allowed on the job
SchedulerException
- if an unexpected error is thrown by the job scheduler while restarting the job
JCLException
- if the xJCL for the job is corrupted or not valid.
JobSubmissionException
- if an error occurs while submitting the job
java.rmi.RemoteException
getJobStatus
int getJobStatus(java.lang.String jobid)
throws InvalidJobIDException,
SchedulerException,
java.rmi.RemoteException
- Returns the job status for the given job ID. Refer to
JobStatusConstants
for a
list of the job status codes returned by this method.
- Parameters:
jobid
- The ID of the job
- Returns:
- the status of the job
- Throws:
InvalidJobIDException
- if no job by the specified job ID exists in the job scheduler
SchedulerException
- if an unexpected error is thrown by the job scheduler while processing the command
java.rmi.RemoteException
getJobOutput
java.lang.String getJobOutput(java.lang.String jobid)
throws InvalidJobIDException,
SchedulerException,
java.rmi.RemoteException
- Returns the job output for a given job ID that displays the job's progress. This only applies to batch jobs.
- Parameters:
jobid
- The ID of the job
- Returns:
- the job output of the job
- Throws:
InvalidJobIDException
- if no job by the specified job ID exists in the job scheduler
SchedulerException
- if an unexpected error is thrown by the job scheduler while processing the command
java.rmi.RemoteException
getJobDetails
java.lang.String getJobDetails(java.lang.String jobid)
throws InvalidJobIDException,
SchedulerException,
java.rmi.RemoteException
- Returns the job details for the given job ID.
- Returns:
- the details of the job such as job ID, status text, submitter and job type
- Throws:
InvalidJobIDException
- if no job by the specified job ID exists in the job scheduler
SchedulerException
- if an unexpected error is thrown by the job scheduler while processing the command
java.rmi.RemoteException
saveJobToRepository
void saveJobToRepository(java.lang.String xJCL,
java.lang.String job,
boolean replace)
throws InvalidOperationException,
SchedulerException,
JCLException,
java.rmi.RemoteException
- Saves the xJCL passed in to the xJCL Repository.
- Parameters:
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.
- Throws:
InvalidOperationException
- if the job already exists in the xJCL repository and the replace parameter specified is false
SchedulerException
- if an unexpected error is thrown by the job scheduler while processing the command
JCLException
- if the xJCL stored in the repository is corrupted or not valid.
java.rmi.RemoteException
showJobFromRepository
java.lang.String showJobFromRepository(java.lang.String job)
throws InvalidJobNameException,
SchedulerException,
java.rmi.RemoteException
- Returns the xJCL from the xJCL repository for the given job name.
- Parameters:
job
- The name given to the saved job in xJCL repository. This name can be used when invoking the submitJobFromRepository
method.
- Returns:
- the xJCL for the given job
- Throws:
InvalidJobNameException
- if job is not found in the xJCL repository.
SchedulerException
- if an unexpected error is thrown by the job scheduler while processing the command
java.rmi.RemoteException
removeJobFromRepository
void removeJobFromRepository(java.lang.String job)
throws InvalidJobNameException,
SchedulerException,
java.rmi.RemoteException
- Removes the xJCL for the specifed job from the xJCL repository
- Parameters:
job
- The name given to the saved job in the xJCL repository.
- Throws:
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 command
java.rmi.RemoteException
showAllJobs
java.lang.String[] showAllJobs()
throws SchedulerException,
java.rmi.RemoteException
- Shows all jobs in the job scheduler
- Returns:
- the list of job IDs of all jobs in the job scheduler
- Throws:
SchedulerException
- if an unexpected error is thrown by the job scheduler while processing the command
java.rmi.RemoteException
suspendJob
void suspendJob(java.lang.String jobid,
java.lang.String seconds)
throws InvalidOperationException,
InvalidJobIDException,
SchedulerException,
java.rmi.RemoteException
- Suspends the specified job for the number of seconds specified. Once the time period is up, the job automatically
resumes. This only applies to batch jobs.
- Parameters:
jobid
- The ID of the job to suspendseconds
- The number of seconds to suspend the job
- Throws:
InvalidJobIDException
- if no job by the specified job ID exists in the job scheduler
InvalidOperationException
- if the operation is currently not allowed on the job
SchedulerException
- if an unexpected error is thrown by the job scheduler while suspending the job
java.rmi.RemoteException
resumeJob
void resumeJob(java.lang.String jobid)
throws InvalidOperationException,
InvalidJobIDException,
SchedulerException,
java.rmi.RemoteException
- Resumes execution of the specified job. This only applies to batch jobs.
- Parameters:
jobid
- The ID of the job to resume
- Throws:
InvalidJobIDException
- if no job by the specified job ID exists in the job scheduler
InvalidOperationException
- if the operation is currently not allowed on the job
SchedulerException
- if an unexpected error is thrown by the job scheduler while resuming the job
java.rmi.RemoteException
getBatchJobRC
int getBatchJobRC(java.lang.String jobid)
throws InvalidOperationException,
InvalidJobIDException,
SchedulerException,
java.rmi.RemoteException
- Returns the return code of the Batch job.
- Parameters:
jobid
- The ID of the job
- Returns:
- the return code of the Batch job
- Throws:
InvalidJobIDException
- if no job by the specified job ID exists in the job scheduler
InvalidOperationException
- if the operation is currently not allowed on the job
SchedulerException
- if an unexpected error is thrown by the job scheduler while processing the command
java.rmi.RemoteException
submitDelayedJob
java.lang.String submitDelayedJob(java.lang.String xJCL,
java.lang.String startTime)
throws SchedulerException,
JCLException,
JobSubmissionException,
InvalidStartDateTimeFormatException,
StaleTimeException,
java.rmi.RemoteException
- Submits the job, which is defined by the xJCL, to the job scheduler at the specified start time.
- Parameters:
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.
- Returns:
- the job ID assigned by the job scheduler to the submitted job
- Throws:
SchedulerException
- if an unexpected error is thrown by the job scheduler while submitting the job
JCLException
- if the xJCL for the job is corrupted or not valid.
JobSubmissionException
- if an error occurs while submitting the job
InvalidStartDateTimeFormatException
- if the start date and/or time is not in the required format
StaleTimeException
- if the start date and/or time is in the past based on current time
java.rmi.RemoteException
submitDelayedJobFromRepository
java.lang.String submitDelayedJobFromRepository(java.lang.String job,
java.lang.String startTime)
throws InvalidJobNameException,
SchedulerException,
JCLException,
JobSubmissionException,
InvalidStartDateTimeFormatException,
StaleTimeException,
java.rmi.RemoteException
- Submits the job, saved in the xJCL repository, to the job scheduler at the specified start time.
- Parameters:
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.
- Returns:
- the job ID assigned by the job scheduler to the submitted job
- Throws:
InvalidJobNameException
- if job is not found in the xJCL repository.
SchedulerException
- if an unexpected error is thrown by the job scheduler while submitting the job
JCLException
- if the xJCL for the job is corrupted or not valid.
JobSubmissionException
- if an error occurs while submitting the job
InvalidStartDateTimeFormatException
- if the start date and/or time is not in the required format
StaleTimeException
- if the start date and/or time is in the past based on current time
java.rmi.RemoteException
saveDelayedJobToRepositoryAndSubmit
java.lang.String saveDelayedJobToRepositoryAndSubmit(java.lang.String xJCL,
java.lang.String job,
boolean replace,
java.lang.String startTime)
throws InvalidOperationException,
SchedulerException,
JCLException,
JobSubmissionException,
InvalidStartDateTimeFormatException,
StaleTimeException,
java.rmi.RemoteException
- Submits the delayed job specified by the xJCL passed in to the job scheduler and
saves the xJCL to the xJCL repository.
- Parameters:
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.
- Returns:
- the job ID assigned by the job scheduler to the submitted job
- Throws:
InvalidOperationException
- if the operation is currently not allowed on the job
SchedulerException
- if an unexpected error is thrown by the job scheduler while submitting the job
JCLException
- if the xJCL for the job is corrupted or not valid.
JobSubmissionException
- if an error occurs while submitting the job
InvalidStartDateTimeFormatException
- if the start date and/or time is not in the required format
StaleTimeException
- if the start date and/or time is in the past based on current time
java.rmi.RemoteException
submitRecurringRequest
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
- Creates a job schedule to submit the job, defined by the xJCL, at the specified time and interval.
- Parameters:
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)
- Throws:
InvalidOperationException
- if the operation is currently not allowed on the job
SchedulerException
- if an unexpected error is thrown by the job scheduler while submitting the job
JCLException
- if the xJCL for the job is corrupted or not valid.
InvalidStartDateTimeFormatException
- if the start date and/or time is not in the required format
StaleTimeException
- if the start date and/or time is in the past based on current time
InvalidIntervalException
- if the interval specified is not one of the supported time interval
java.rmi.RemoteException
submitRecurringRequestFromRepository
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
- Creates a job schedule to submit the specified job, saved in the xJCL repository, at the specified time and interval.
- Parameters:
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)
- Throws:
InvalidOperationException
- if the operation is currently not allowed on the job
SchedulerException
- if an unexpected error is thrown by the job scheduler while submitting the job
JCLException
- if the xJCL for the job is corrupted or not valid.
InvalidStartDateTimeFormatException
- if the start date and/or time is not in the required format
StaleTimeException
- if the start date and/or time is in the past based on current time
InvalidIntervalException
- if the interval specified is not one of the supported time interval
InvalidJobNameException
- if job is not found in the xJCL repository.
java.rmi.RemoteException
cancelRecurringRequest
void cancelRecurringRequest(java.lang.String reqId)
throws InvalidOperationException,
SchedulerException,
java.rmi.RemoteException
- Cancel an existing job schedule
- Parameters:
reqId
- The name of the job schedule
- Throws:
InvalidOperationException
- if the operation is currently not allowed on the job
SchedulerException
- if an unexpected error is thrown by the job scheduler while canceling the job
java.rmi.RemoteException
getRecurringRequestDetails
java.lang.String getRecurringRequestDetails(java.lang.String reqId)
throws SchedulerException,
InvalidOperationException,
java.rmi.RemoteException
- Returns details of an existing job schedule.
- Parameters:
reqId
- The name of the job schedule to be returned
- Returns:
- information about the schedule such as schedule name, job name, start time and interval
- Throws:
SchedulerException
- if an unexpected error is thrown by the job scheduler while processing the command
InvalidOperationException
- if the operation is currently not allowed on the job
java.rmi.RemoteException
modifyRecurringRequest
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
- Modify an existing job schedule.
- Parameters:
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)
- Throws:
SchedulerException
- if an unexpected error is thrown by the job scheduler while processing the command
JCLException
- if the xJCL for the job is corrupted or not valid.
InvalidOperationException
- if the operation is currently not allowed on the job
InvalidStartDateTimeFormatException
- if the start date and/or time is not in the required format
StaleTimeException
- if the start date and/or time is in the past based on current time
InvalidIntervalException
- if the interval specified is not one of the supported time interval
java.rmi.RemoteException
showAllRecurringRequests
java.lang.String[] showAllRecurringRequests()
throws SchedulerException,
java.rmi.RemoteException
- Lists all existing job schedules
- Returns:
- a list of all job schedules currently in the system
- Throws:
SchedulerException
- if an unexpected error is thrown by the job scheduler while processing the command
java.rmi.RemoteException
showRecurringJobs
java.lang.String[] showRecurringJobs(java.lang.String reqId)
throws SchedulerException,
InvalidOperationException,
java.rmi.RemoteException
- Show all jobs in the specified job schedule
- Parameters:
reqId
- the name of the job schedule
- Returns:
- the list of job IDs of jobs in the specified job schedule
- Throws:
SchedulerException
- if an unexpected error is thrown by the job scheduler while processing the command
InvalidOperationException
- if the operation is currently not allowed on the job
java.rmi.RemoteException
getJobsStatus
java.lang.String getJobsStatus(java.lang.String[] jobid)
throws SchedulerException,
java.rmi.RemoteException
- Returns job status in XML format for the given job IDs.
- Parameters:
jobid
- List of job IDs
- Returns:
- Job status such as job ID, return code, status code and status text in XML format
- Throws:
SchedulerException
- if an unexpected error is thrown by the job scheduler while processing the command
java.rmi.RemoteException
getJobsId
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
- Returns a list of job IDs that match the specified criteria. All conditions must apply for a match to occur.
- Parameters:
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.
- Returns:
- the list of job IDs that match the specified criteria
- Throws:
SchedulerException
- if an unexpected error is thrown by the job scheduler while processing the command
java.rmi.RemoteException
cancelJob
int[] cancelJob(java.lang.String[] jobid)
throws SchedulerException,
java.rmi.RemoteException
- Cancels the jobs identified by the list of job IDs
- Parameters:
jobid
- The list of job IDs to cancel
- Returns:
- List of return codes. Refer to
JobSchedulerConstants
for a list of the possible return codes.
- Throws:
SchedulerException
- if an unexpected error is thrown by the job scheduler while canceling the job
java.rmi.RemoteException
purgeJob
int[] purgeJob(java.lang.String[] jobid)
throws SchedulerException,
java.rmi.RemoteException
- Purges the jobs, identified by the list of job IDs, from the job scheduler and the grid endpoint environments.
- Parameters:
jobid
- The list of job IDs to purge
- Returns:
- List of return codes. Refer to
JobSchedulerConstants
for a list of the possible return codes.
- Throws:
SchedulerException
- if an unexpected error is thrown by the job scheduler while purging the job
java.rmi.RemoteException
restartJob
int[] restartJob(java.lang.String[] jobid)
throws SchedulerException,
java.rmi.RemoteException
- Restarts the jobs identified by the list of job IDs. Only jobs in the restartable state can be restarted.
- Parameters:
jobid
- The list of job IDs to restart
- Returns:
- List of return codes. Refer to
JobSchedulerConstants
for a list of the possible return codes.
- Throws:
SchedulerException
- if an unexpected error is thrown by the job scheduler while restarting the job
java.rmi.RemoteException
resumeJob
int[] resumeJob(java.lang.String[] jobid)
throws SchedulerException,
java.rmi.RemoteException
- Resumes execution of the jobs identified by the list of job IDs. This only applies to batch jobs.
- Parameters:
jobid
- The list of job IDs to resume
- Returns:
- List of return codes. Refer to
JobSchedulerConstants
for a list of the possible return codes.
- Throws:
SchedulerException
- if an unexpected error is thrown by the job scheduler while resuming the job
java.rmi.RemoteException
suspendJob
int[] suspendJob(java.lang.String[] jobid,
java.lang.String seconds)
throws SchedulerException,
InvalidOperationException,
java.rmi.RemoteException
- Suspends the specified jobs for the number of seconds specified. Once the time period is up, the jobs automatically
resume. This only applies to batch jobs.
- Parameters:
jobid
- The ID of the job to suspendseconds
- The number of seconds to suspend the job
- Returns:
- List of return codes. Refer to
JobSchedulerConstants
for a list of the possible return codes.
- Throws:
InvalidOperationException
- if the operation is currently not allowed on the job
SchedulerException
- if an unexpected error is thrown by the job scheduler while suspending the job
java.rmi.RemoteException
submitModifiableDelayedJobFromRepository
java.lang.String submitModifiableDelayedJobFromRepository(java.lang.String job,
java.lang.String startTime,
java.lang.String nameValuePairs)
throws InvalidJobNameException,
SchedulerException,
JCLException,
JobSubmissionException,
InvalidStartDateTimeFormatException,
StaleTimeException,
java.rmi.RemoteException
- Submits the specified job, saved in the xJCL repository, and any name/value pairs specified to the job scheduler at the specified
start time.
- Parameters:
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.
- Returns:
- the job ID assigned by the job scheduler to the submitted job
- Throws:
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 job
JCLException
- if the xJCL for the job is corrupted or not valid.
JobSubmissionException
- if an error occurs while submitting the job
InvalidStartDateTimeFormatException
- if the start date and/or time is not in the required format
StaleTimeException
- if the start date and/or time is in the past based on current time
java.rmi.RemoteException
submitModifiableDelayedJob
java.lang.String submitModifiableDelayedJob(java.lang.String xJCL,
java.lang.String startTime,
java.lang.String nameValuePairs)
throws SchedulerException,
JCLException,
JobSubmissionException,
InvalidStartDateTimeFormatException,
StaleTimeException,
java.rmi.RemoteException
- Submits the job, which is defined by the xJCL and any name/value pairs specified, to the job scheduler at the specified
start time.
- Parameters:
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.
- Returns:
- the job ID assigned by the job scheduler to the submitted job
- Throws:
SchedulerException
- if an unexpected error is thrown by the job scheduler while submitting the job
JCLException
- if the xJCL for the job is corrupted or not valid.
JobSubmissionException
- if an error occurs while submitting the job
InvalidStartDateTimeFormatException
- if the start date and/or time is not in the required format
StaleTimeException
- if the start date and/or time is in the past based on current time
java.rmi.RemoteException
saveModifiableDelayedJobToRepositoryAndSubmit
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,
JobSubmissionException,
InvalidStartDateTimeFormatException,
StaleTimeException,
java.rmi.RemoteException
- 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.
- Parameters:
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.
- Returns:
- the job ID assigned by the job scheduler to the submitted job
- Throws:
InvalidOperationException
- if the operation is currently not allowed on the job
SchedulerException
- if an unexpected error is thrown by the job scheduler while submitting the job
JCLException
- if the xJCL for the job is corrupted or not valid.
JobSubmissionException
- if an error occurs while submitting the job
InvalidStartDateTimeFormatException
- if the start date and/or time is not in the required format
StaleTimeException
- if the start date and/or time is in the past based on current time
java.rmi.RemoteException
submitModifiableRecurringRequest
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
- Creates a job schedule to submit jobs at the specified time interval. The jobs are defined by the xJCL and any name/value pairs specified.
- Parameters:
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.
- Throws:
InvalidOperationException
- if the operation is currently not allowed on the job
SchedulerException
- if an unexpected error is thrown by the job scheduler while submitting the job
JCLException
- if the xJCL for the job is corrupted or not valid.
InvalidStartDateTimeFormatException
- if the start date and/or time is not in the required format
StaleTimeException
- if the start date and/or time is in the past based on current time
InvalidIntervalException
- if the interval specified is not one of the supported time interval
java.rmi.RemoteException
submitModifiableRecurringRequestFromRepository
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
- Creates a job schedule to submit jobs at the specified time interval. The jobs are defined by the xJCL stored in the xJCL repository
and any name/value pairs specified.
- Parameters:
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.
- Throws:
InvalidOperationException
- if the operation is currently not allowed on the job
SchedulerException
- if an unexpected error is thrown by the job scheduler while submitting the job
JCLException
- if the xJCL for the job is corrupted or not valid.
InvalidStartDateTimeFormatException
- if the start date and/or time is not in the required format
StaleTimeException
- if the start date and/or time is in the past based on current time
InvalidIntervalException
- if the interval specified is not one of the supported time interval
InvalidJobNameException
- if job is not found in the xJCL repository.
java.rmi.RemoteException
saveModifiableJobToRepositoryAndSubmit
java.lang.String saveModifiableJobToRepositoryAndSubmit(java.lang.String xJCL,
java.lang.String job,
boolean replace,
java.lang.String nameValuePairs)
throws InvalidOperationException,
SchedulerException,
JCLException,
JobSubmissionException,
java.rmi.RemoteException
- 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.
- Parameters:
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.
- Returns:
- the job ID assigned by the job scheduler to the submitted job
- Throws:
InvalidOperationException
- if the job already exists in the xJCL repository and the replace parameter specified is false
SchedulerException
- if an unexpected error is thrown by the job scheduler while submitting the job
JCLException
- if the xJCL stored in the repository is corrupted or not valid.
JobSubmissionException
- if an error occurs while submitting the job
java.rmi.RemoteException
submitModifiableJobFromRepository
java.lang.String submitModifiableJobFromRepository(java.lang.String job,
java.lang.String nameValuePairs)
throws InvalidJobNameException,
SchedulerException,
JCLException,
JobSubmissionException,
java.rmi.RemoteException
- Submits the specified job, saved in the xJCL repository, and any name/value pairs specified to the job scheduler
- Parameters:
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.
- Returns:
- the job ID assigned by the job scheduler to the submitted job
- Throws:
InvalidJobNameException
- if job is not found in the xJCL repository.
SchedulerException
- if an unexpected error is thrown by the job scheduler while submitting the job
JCLException
- if the xJCL stored in the repository is corrupted or not valid.
JobSubmissionException
- if an error occurs while submitting the job
java.rmi.RemoteException
submitModifiableJob
java.lang.String submitModifiableJob(java.lang.String xJCL,
java.lang.String nameValuePairs)
throws SchedulerException,
JCLException,
JobSubmissionException,
java.rmi.RemoteException
- Submits the job, which is defined by the xJCL and any name/value pairs specified, to the job scheduler
- Parameters:
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.
- Returns:
- the job ID assigned by the job scheduler to the submitted job
- Throws:
SchedulerException
- if an unexpected error is thrown by the job scheduler while submitting the job
JCLException
- if the xJCL stored in the repository is corrupted or not valid.
JobSubmissionException
- if an error occurs while submitting the job
java.rmi.RemoteException
modifyModifiableRecurringRequest
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
- Modify an existing job schedule.
- Parameters:
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.
- Throws:
SchedulerException
- if an unexpected error is thrown by the job scheduler while processing the command
JCLException
- if the xJCL for the job is corrupted or not valid.
InvalidOperationException
- if the operation is currently not allowed on the job
InvalidStartDateTimeFormatException
- if the start date and/or time is not in the required format
StaleTimeException
- if the start date and/or time is in the past based on current time
InvalidIntervalException
- if the interval specified is not one of the supported time interval
java.rmi.RemoteException
getJobsName
java.lang.String[] getJobsName(java.lang.String jobNameFilter,
java.lang.String jobDescFilter,
java.lang.String sortBy,
boolean ascending)
throws SchedulerException,
java.rmi.RemoteException
- Returns a list of job names in the job repository that match the specified criteria. All conditions must apply for a match to occur.
- Parameters:
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.
- Returns:
- the list of job names that match the specified criteria
- Throws:
SchedulerException
- if an unexpected error is thrown by the job scheduler while processing the request
java.rmi.RemoteException
stopJob
void stopJob(java.lang.String jobid)
throws InvalidOperationException,
InvalidJobIDException,
SchedulerException,
java.rmi.RemoteException
- Stops the job identified by the job ID
- Parameters:
jobid
- The ID of the job
- Throws:
InvalidOperationException
- if the operation is currently not allowed on the job
InvalidJobIDException
- if no job by the specified job ID exists in the job scheduler
SchedulerException
- if an unexpected error is thrown by the job scheduler while processing the request
java.rmi.RemoteException
stopJob
int[] stopJob(java.lang.String[] jobid)
throws SchedulerException,
java.rmi.RemoteException
- Stops the jobs identified by the list of job IDs
- Parameters:
jobid
- The list of job IDs to stop
- Returns:
- List of return codes. Refer to
JobSchedulerConstants
for a list of the possible return codes.
- Throws:
SchedulerException
- if an unexpected error is thrown by the job scheduler while purging the job
java.rmi.RemoteException
getSymbolicVariables
java.lang.String getSymbolicVariables(java.lang.String clientXJCL)
throws SchedulerException,
JCLException,
java.rmi.RemoteException
- Parses the xJCL to produce a map of all symbolic variables used in the xJCL which are not system properties
- Parameters:
xJCL
- The xJCL for the job
- Returns:
- a map of defaulted name/value pairs; value==null ==> no default value in substitution-props
- Throws:
SchedulerException
- if an unexpected error is thrown by the job scheduler while processing the command
JCLException
- if the xJCL stored in the repository is corrupted or not valid.
java.rmi.RemoteException
getRequests
java.lang.String getRequests(java.lang.String[] requestid)
throws SchedulerException,
java.rmi.RemoteException
- Returns job schedule information in XML format for the given job schedule names.
- Parameters:
requestid
- List of job schedule names
- Returns:
- Job schedule information in XML format, such as job schedule name, job name, start time and interval
- Throws:
SchedulerException
- if an unexpected error is thrown by the job scheduler while processing the command
java.rmi.RemoteException
getRequestsId
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
- Returns a list of job schedule names that match the specified criteria. All conditions must apply for a match to occur.
- Parameters:
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.
- Returns:
- the list of job schedule names that match the specified criteria
- Throws:
SchedulerException
- if an unexpected error is thrown by the job scheduler while processing the command
java.rmi.RemoteException
cancelRecurringRequest
int[] cancelRecurringRequest(java.lang.String[] reqId)
throws SchedulerException,
java.rmi.RemoteException
- Cancel existing job schedules
- Parameters:
reqId
- The list of job schedule names to cancel
- Returns:
- List of return codes. Refer to
JobSchedulerConstants
for a list of the possible return codes.
- Throws:
SchedulerException
- if an unexpected error is thrown by the job scheduler while canceling the job
java.rmi.RemoteException
getJobLog
java.lang.String getJobLog(java.lang.String jobid)
throws SchedulerException,
InvalidJobIDException,
InvalidOperationException,
java.rmi.RemoteException
- Returns the zipped job log associated with the requested job ID
- Parameters:
jobid
- The ID of the job whose log file name is to be returned
- Returns:
- the file system name for the job log of the specified job
- Throws:
SchedulerException
- if an unexpected error is thrown by the Job Scheduler while processing the command
InvalidJobIDException
- if no job logs for the specified job ID are found by the Job Scheduler
InvalidOperationException
- if the operation is currently not allowed on the job
java.rmi.RemoteException
getLogMetaData
java.lang.String[] getLogMetaData(java.lang.String jobid)
throws SchedulerException,
InvalidJobIDException,
InvalidOperationException,
java.rmi.RemoteException
- Returns the job log meta-data associated with the requested job ID (list of distinct job log subdirectories for the job ID)
- Parameters:
jobid
- The ID of the job whose meta-data is to be returned
- Returns:
- the job log meta-data for the specified job
- Throws:
SchedulerException
- if an unexpected error is thrown by the Job Scheduler while processing the command
InvalidJobIDException
- if no job log meta-data for the specified job ID is found by the Job Scheduler
InvalidOperationException
- if the operation is currently not allowed on the job
java.rmi.RemoteException
getLogPartList
java.lang.String[] getLogPartList(java.lang.String jobid,
java.lang.String logSubDirName)
throws SchedulerException,
InvalidJobIDException,
InvalidOperationException,
java.rmi.RemoteException
- Returns the job log part list associated with the requested job ID and log subdirectory
- Parameters:
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 returned
- Returns:
- the job log part information for the specified job
- Throws:
SchedulerException
- if an unexpected error is thrown by the Job Scheduler while processing the command
InvalidJobIDException
- if no part information for the specified job ID is found by the Job Scheduler
InvalidOperationException
- if the operation is currently not allowed on the job
java.rmi.RemoteException
getLogPart
java.lang.String[] getLogPart(java.lang.String jobid,
java.lang.String logSubDirName,
java.lang.String partNumber)
throws SchedulerException,
InvalidJobIDException,
InvalidOperationException,
java.rmi.RemoteException
- Returns the contents of the job log file associated with the requested job ID, log subdirectory and part number
- Parameters:
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 returned
- Returns:
- the contents of the job log part for the specified job and log subdirectory
- Throws:
SchedulerException
- if an unexpected error is thrown by the Job Scheduler while processing the command
InvalidJobIDException
- if no part information for the specified job ID is found by the Job Scheduler
InvalidOperationException
- if the operation is currently not allowed on the job
java.rmi.RemoteException
getLogSize
java.lang.String getLogSize(java.lang.String jobid,
java.lang.String logSubDirName)
throws SchedulerException,
InvalidJobIDException,
InvalidOperationException,
java.rmi.RemoteException
- Returns the size in bytes of the job log file associated with the requested job ID
- Parameters:
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 returned
- Returns:
- the size of the job log for the specified job
- Throws:
SchedulerException
- if an unexpected error is thrown by the Job Scheduler while processing the command
InvalidJobIDException
- if no size information for the specified job ID is found by the Job Scheduler
InvalidOperationException
- if the operation is currently not allowed on the job
java.rmi.RemoteException
getLogAge
int getLogAge(java.lang.String jobid,
java.lang.String logSubDirName)
throws SchedulerException,
InvalidJobIDException,
InvalidOperationException,
java.rmi.RemoteException
- Returns the age of the job log file associated with the requested job ID and log subdirectory
- Parameters:
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 returned
- Returns:
- the age of the job log in days for the specified jobname and log subdirectory
- Throws:
SchedulerException
- if an unexpected error is thrown by the Job Scheduler while processing the command
InvalidJobIDException
- if no age information for the specified job ID is found by the Job Scheduler
InvalidOperationException
- if the operation is currently not allowed on the job
java.rmi.RemoteException
getJobsByClass
java.lang.String[] getJobsByClass(java.lang.String jobClass)
throws SchedulerException,
InvalidOperationException,
java.rmi.RemoteException
- Returns the job log list associated with the requested job class
- Parameters:
jobid
- The class identifier whose job list information is to be returnedjobClass
- The class identifier on which to match
- Returns:
- a list of all job IDs whose class identifier matches the specified jobClass
- Throws:
SchedulerException
- if an unexpected error is thrown by the Job Scheduler while processing the command
InvalidOperationException
- if the operation is currently not allowed on the job
java.rmi.RemoteException
removeJobLog
void removeJobLog(java.lang.String jobid)
throws SchedulerException,
InvalidJobIDException,
InvalidOperationException,
java.rmi.RemoteException
- Removes the zipped job log associated with the requested job ID [ this is the required complimentary action to {@link JobScheduler#getJobLog(String) getJobLog(jobid) ]
- Parameters:
jobid
- The ID of the job whose zipped log file is to be removed
- Throws:
SchedulerException
- if an unexpected error is thrown by the Job Scheduler while processing the command
InvalidJobIDException
- if no part information for the specified job ID is found by the Job Scheduler
InvalidOperationException
- if the operation is currently not allowed on the job
java.rmi.RemoteException
purgeJobLog
void purgeJobLog(java.lang.String jobid,
java.lang.String logSubDirName)
throws SchedulerException,
InvalidJobIDException,
InvalidOperationException,
java.rmi.RemoteException
- Purges the job log file associated with the requested job ID and log subDirectory
- Parameters:
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 purged
- Throws:
SchedulerException
- if an unexpected error is thrown by the Job Scheduler while processing the command
InvalidJobIDException
- if no job information for the specified job ID is found by the Job Scheduler
InvalidOperationException
- if the operation is currently not allowed on the job
java.rmi.RemoteException
getAdminAddresses
java.lang.String[] getAdminAddresses()
throws SchedulerException,
InvalidOperationException,
java.rmi.RemoteException
- Return the JMX addresses of the scheduler cluster
- Returns:
- the JMX addresses of the scheduler cluster
- Throws:
SchedulerException
- if an unexpected error is thrown by the Job Scheduler while processing the command
InvalidOperationException
- if the operation is currently not allowed on the job
java.rmi.RemoteException
getUserPrefs
java.lang.String[] getUserPrefs(java.lang.String userId,
java.lang.String prefScope)
throws SchedulerException,
java.rmi.RemoteException
- Retrieves a list of user preferences for the given user ID and the given scope.
- Parameters:
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)
- Returns:
- a list of user preferences in the format of name=value
- Throws:
SchedulerException
- if an unexpected error is thrown by the job scheduler while processing the command
java.rmi.RemoteException
saveUserPrefs
void saveUserPrefs(java.lang.String userId,
java.lang.String prefScope,
java.lang.String[] prefNameValue)
throws SchedulerException,
java.rmi.RemoteException
- Saves the list of user preferences for the given user ID and the given scope.
- Parameters:
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=value
- Throws:
SchedulerException
- if an unexpected error is thrown by the job scheduler while processing the command
java.rmi.RemoteException
getJobLogMetaDataByAgeForClass
java.lang.String[] getJobLogMetaDataByAgeForClass(java.lang.String jobClass)
throws SchedulerException,
InvalidOperationException,
java.rmi.RemoteException
- Returns the job log list associated with the requested job class sorted by job log age
- Parameters:
jobClass
- The class identifier on which to match
- Returns:
- a list of all job IDs whose class identifier matches jobClass
- Throws:
SchedulerException
- if an unexpected error is thrown by the Job Scheduler while processing the command
InvalidOperationException
- if the operation is currently not allowed on the job
java.rmi.RemoteException
getJobLogMetaDataBySizeForClass
java.lang.String[] getJobLogMetaDataBySizeForClass(java.lang.String jobClass)
throws SchedulerException,
InvalidOperationException,
java.rmi.RemoteException
- Returns the job log list associated with the requested job class sorted by job log size
- Parameters:
jobClass
- The class identifier on which to match
- Returns:
- a list of all job IDs whose class identifier matches jobClass
- Throws:
SchedulerException
- if an unexpected error is thrown by the Job Scheduler while processing the command
InvalidOperationException
- if the operation is currently not allowed on the job
java.rmi.RemoteException
quiesceLogging
void quiesceLogging(java.lang.String jobid)
throws SchedulerException,
InvalidJobIDException,
InvalidOperationException,
java.rmi.RemoteException
- Stops user job logging
- Parameters:
jobid
- The ID of the job whose application job logging is to be stopped
- Throws:
SchedulerException
- if an unexpected error is thrown by the Job Scheduler while processing the command
InvalidJobIDException
- if the specified job ID is not found by the Job Scheduler
InvalidOperationException
- if the operation is currently not allowed on the job
java.rmi.RemoteException
sendCheckpointNotification
void sendCheckpointNotification(java.lang.String jobid,
java.lang.String Status)
throws java.rmi.RemoteException
- Parameters:
jobid
- The ID of the jobStatus
- The status of the job
- Throws:
java.rmi.RemoteException
isSAF
boolean isSAF()
throws java.rmi.RemoteException
- Returns true if SAF authorization is enabled.
Supported on z/OS only.
- Returns:
- true if SAF authorization is enabled, otherwise false.
- Throws:
java.rmi.RemoteException