com.ibm.websphere.longrun
Interface JobScheduler
- 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();
Method Summary
Modifier and Type
Method and Description
cancelJob(java.lang.String jobid)
cancelJob(java.lang.String[] jobid)
cancelRecurringRequest(java.lang.String reqId)
cancelRecurringRequest(java.lang.String[] reqId)
forcedCancelJob(java.lang.String jobid)
getAdminAddresses()
getBatchJobRC(java.lang.String jobid)
getJobDetails(java.lang.String jobid)
getJobLog(java.lang.String jobid)
getJobLogMetaDataByAgeForClass(java.lang.String jobClass)
getJobLogMetaDataBySizeForClass(java.lang.String jobClass)
getJobOutput(java.lang.String jobid)
getJobsByClass(java.lang.String jobClass)
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)
getJobsName(java.lang.String jobNameFilter,java.lang.String jobDescFilter,java.lang.String sortBy,boolean ascending)
getJobsStatus(java.lang.String[] jobid)
getJobStatus(java.lang.String jobid)
getLogAge(java.lang.String jobid,java.lang.String logSubDirName)
getLogMetaData(java.lang.String jobid)
getLogPart(java.lang.String jobid,java.lang.String logSubDirName,java.lang.String partNumber)
getLogPartList(java.lang.String jobid,java.lang.String logSubDirName)
getLogSize(java.lang.String jobid,java.lang.String logSubDirName)
getRecurringRequestDetails(java.lang.String reqId)
getRequests(java.lang.String[] requestid)
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)
getSymbolicVariables(java.lang.String clientXJCL)
getSymbolicVariablesForExistingJob(java.lang.String jobId)
getUserPrefs(java.lang.String userId,java.lang.String prefScope)
isSAF()
modifyModifiableRecurringRequest(java.lang.String reqId,java.lang.String xJCL,java.lang.String startTime,java.lang.String interval,java.lang.String nameValuePairs)
modifyRecurringRequest(java.lang.String reqId,java.lang.String xJCL,java.lang.String startTime,java.lang.String interval)
privateGetJobID(int jobNumber)
privateReserveJobNumber()
privateSubmitJob(java.lang.String xJCL,int jobNumber)
privateSubmitJob(java.lang.String xJCL,int jobNumber,java.lang.String proxySchedulerLockName)
privateSubmitJobFromRepository(java.lang.String job,int jobNumber)
privateSubmitJobFromRepository(java.lang.String job,int jobNumber,java.lang.String proxySchedulerLockName)
privateSubmitModifiableJob(java.lang.String xJCL,java.lang.String nameValuePairs,int jobNumber)
privateSubmitModifiableJob(java.lang.String xJCL,java.lang.String nameValuePairs,int jobNumber,java.lang.String proxySchedulerLockName)
privateSubmitModifiableJobFromRepository(java.lang.String job,java.lang.String nameValuePairs,int jobNumber)
privateSubmitModifiableJobFromRepository(java.lang.String job,java.lang.String nameValuePairs,int jobNumber,java.lang.String proxySchedulerLockName)
purgeJob(java.lang.String jobid)
purgeJob(java.lang.String[] jobid)
purgeJobLog(java.lang.String jobid,java.lang.String logSubDirName)
quiesceLogging(java.lang.String jobid)
removeJobFromRepository(java.lang.String job)
removeJobLog(java.lang.String jobid)
restartJob(java.lang.String jobid)
restartJob(java.lang.String[] jobid)
restartJob(java.lang.String jobid,java.lang.Object proxySchedulerLockName)
restartJob(java.lang.String jobid,java.lang.String passedPropertiesString)
restartJob(java.lang.String jobid,java.lang.String passedPropertiesString,java.lang.Object proxySchedulerLockName)
resumeJob(java.lang.String jobid)
resumeJob(java.lang.String[] jobid)
saveDelayedJobToRepositoryAndSubmit(java.lang.String xJCL,java.lang.String job,boolean replace,java.lang.String startTime)
saveJobToRepository(java.lang.String xJCL,java.lang.String job,boolean replace)
saveJobToRepositoryAndSubmit(java.lang.String xJCL,java.lang.String job,boolean replace)
saveModifiableDelayedJobToRepositoryAndSubmit(java.lang.String xJCL,java.lang.String job,boolean replace,java.lang.String startTime,java.lang.String nameValuePairs)
saveModifiableJobToRepositoryAndSubmit(java.lang.String xJCL,java.lang.String job,boolean replace,java.lang.String nameValuePairs)
saveUserPrefs(java.lang.String userId,java.lang.String prefScope,java.lang.String[] prefNameValue)
sendCheckpointNotification(java.lang.String jobid,java.lang.String Status)
showAllJobs()
showAllRecurringRequests()
showJobFromRepository(java.lang.String job)
showRecurringJobs(java.lang.String reqId)
stopJob(java.lang.String jobid)
stopJob(java.lang.String[] jobid)
submitDelayedJob(java.lang.String xJCL,java.lang.String startTime)
submitDelayedJobFromRepository(java.lang.String job,java.lang.String startTime)
submitJob(java.lang.String xJCL)
submitJobFromRepository(java.lang.String job)
submitModifiableDelayedJob(java.lang.String xJCL,java.lang.String startTime,java.lang.String nameValuePairs)
submitModifiableDelayedJobFromRepository(java.lang.String job,java.lang.String startTime,java.lang.String nameValuePairs)
submitModifiableJob(java.lang.String xJCL,java.lang.String nameValuePairs)
submitModifiableJobFromRepository(java.lang.String job,java.lang.String nameValuePairs)
submitModifiableRecurringRequest(java.lang.String reqId,java.lang.String xJCL,java.lang.String startTime,java.lang.String interval,java.lang.String nameValuePairs)
submitModifiableRecurringRequestFromRepository(java.lang.String jobName,java.lang.String reqId,java.lang.String startTime,java.lang.String interval,java.lang.String nameValuePairs)
submitRecurringRequest(java.lang.String reqId,java.lang.String xJCL,java.lang.String startTime,java.lang.String interval)
submitRecurringRequestFromRepository(java.lang.String jobName,java.lang.String reqId,java.lang.String startTime,java.lang.String interval)
suspendJob(java.lang.String[] jobid,java.lang.String seconds)
suspendJob(java.lang.String jobid,java.lang.String seconds)
Methods inherited from interface javax.ejb.EJBObject
getEJBHome, getHandle, getPrimaryKey, isIdentical, remove
Method Detail
submitJobFromRepository
job
- The name of the job that was stored to the xJCL repository 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
privateSubmitJobFromRepository
com.ibm.websphere.longrun.JobSubmissionException
java.rmi.RemoteException
privateSubmitJobFromRepository
com.ibm.websphere.longrun.JobSubmissionException
java.rmi.RemoteException
submitJob
xJCL
- The xJCL for the job 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
privateSubmitJob
com.ibm.websphere.longrun.JobSubmissionException
java.rmi.RemoteException
privateSubmitJob
com.ibm.websphere.longrun.JobSubmissionException
java.rmi.RemoteException
saveJobToRepositoryAndSubmit
xJCL
- The xJCL for the job 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 xJCL repository. 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
jobid
- The ID of the job to be purged 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
jobid
- The ID of the job 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
jobid
- The ID of the job 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
jobid
- The ID of the job 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
restartJob
jobid
- The ID of the job 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
restartJob
jobid
- The ID of the job 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
restartJob
jobid
- The ID of the job 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
JobStatusConstants
for a
list of the job status codes returned by this method.
jobid
- The ID of 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 command java.rmi.RemoteException
getJobOutput
jobid
- The ID of 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 command java.rmi.RemoteException
getJobDetails
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
xJCL
- The xJCL for the job 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 xJCL repository. 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
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 command java.rmi.RemoteException
removeJobFromRepository
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 command java.rmi.RemoteException
showAllJobs
SchedulerException
- if an unexpected error is thrown by the job scheduler while processing the command java.rmi.RemoteException
suspendJob
jobid
- The ID of the job to suspend seconds
- The number of seconds to suspend the job 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
jobid
- The ID of the job to resume 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
jobid
- The ID of the job 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
xJCL
- The xJCL for the job startTime
- 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 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
job
- The name of the job that was stored to the job repository startTime
- 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 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
xJCL
- The xJCL for the job startTime
- 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 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
reqId
- The name of the recurring job request xJCL
- The xJCL for the job startTime
- 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 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
jobName
- The name of the job that was stored to the job repository reqId
- The name of the recurring job request startTime
- 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 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
reqId
- The name of the job schedule 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
reqId
- The name of the job schedule to be returned 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
reqId
- The name of the job schedule to be modified xJCL
- The xJCL for the job startTime
- 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 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
SchedulerException
- if an unexpected error is thrown by the job scheduler while processing the command java.rmi.RemoteException
showRecurringJobs
reqId
- the name of the job schedule 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
jobid
- List of job IDs SchedulerException
- if an unexpected error is thrown by the job scheduler while processing the command java.rmi.RemoteException
getJobsId
jobFilter
- SQL filter value to apply to the job ID (e.g. Postings% ) submitterFilter
- SQL filter value to apply to the submitter nodeFilter
- 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 executed stateFilter
- 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 command java.rmi.RemoteException
cancelJob
jobid
- The list of job IDs to cancel JobSchedulerConstants
for a list of the possible return codes. SchedulerException
- if an unexpected error is thrown by the job scheduler while canceling the job java.rmi.RemoteException
purgeJob
jobid
- The list of job IDs to purge JobSchedulerConstants
for a list of the possible return codes. SchedulerException
- if an unexpected error is thrown by the job scheduler while purging the job java.rmi.RemoteException
restartJob
jobid
- The list of job IDs to restart JobSchedulerConstants
for a list of the possible return codes. SchedulerException
- if an unexpected error is thrown by the job scheduler while restarting the job java.rmi.RemoteException
resumeJob
jobid
- The list of job IDs to resume JobSchedulerConstants
for a list of the possible return codes. SchedulerException
- if an unexpected error is thrown by the job scheduler while resuming the job java.rmi.RemoteException
suspendJob
jobid
- The ID of the job to suspend seconds
- The number of seconds to suspend the job JobSchedulerConstants
for a list of the possible return codes. 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
job
- The name of the job that was stored to the xJCL repository startTime
- 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 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
xJCL
- The xJCL for the job startTime
- 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 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
xJCL
- The xJCL for the job startTime
- 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 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
reqId
- The name of the job schedule xJCL
- The xJCL for the job startTime
- 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 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
jobName
- The name of the job that was stored to the job repository reqId
- The name of the recurring job request startTime
- 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 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
xJCL
- The xJCL for the job job
- 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 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
job
- The name of the job that was stored to 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. 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
privateSubmitModifiableJobFromRepository
com.ibm.websphere.longrun.JobSubmissionException
java.rmi.RemoteException
privateSubmitModifiableJobFromRepository
com.ibm.websphere.longrun.JobSubmissionException
java.rmi.RemoteException
submitModifiableJob
xJCL
- The xJCL for the job 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 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
privateSubmitModifiableJob
com.ibm.websphere.longrun.JobSubmissionException
java.rmi.RemoteException
privateSubmitModifiableJob
com.ibm.websphere.longrun.JobSubmissionException
java.rmi.RemoteException
privateReserveJobNumber
privateGetJobID
modifyModifiableRecurringRequest
reqId
- The name of the job schedule to be modified xJCL
- The xJCL for the job startTime
- 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 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
jobNameFilter
- SQL filter value to apply to the job names (e.g. Postings% ) jobDescFilter
- not used sortBy
- - 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 request java.rmi.RemoteException
stopJob
jobid
- The ID of the job 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
jobid
- The list of job IDs to stop JobSchedulerConstants
for a list of the possible return codes. SchedulerException
- if an unexpected error is thrown by the job scheduler while purging the job java.rmi.RemoteException
getSymbolicVariablesForExistingJob
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
getSymbolicVariables
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
requestid
- List of job schedule names SchedulerException
- if an unexpected error is thrown by the job scheduler while processing the command java.rmi.RemoteException
getRequestsId
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 submitter intervalFilter
- 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 command java.rmi.RemoteException
cancelRecurringRequest
reqId
- The list of job schedule names to cancel JobSchedulerConstants
for a list of the possible return codes. SchedulerException
- if an unexpected error is thrown by the job scheduler while canceling the job java.rmi.RemoteException
getJobLog
jobid
- The ID of the job whose log file name is to be returned 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
jobid
- The ID of the job whose meta-data is to be returned 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
jobid
- The ID of the job whose part information is to be returned logSubDirName
- The name of the log subdirectory of the job whose part information is to be returned 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
jobid
- The ID of the job whose part information is to be returned logSubDirName
- The name of the log subdirectory of the job whose part information is to be returned partNumber
- The name of the job log chunk in the log subdirectory whose part information is to be returned 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
jobid
- The ID of the job whose size information is to be returned logSubDirName
- The name of the log subdirectory of the job whose size information is to be returned 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
jobid
- The ID of the job whose age information is to be returned logSubDirName
- The name of the log subdirectory of the job whose age information is to be returned 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
jobClass
- The class identifier on which to match 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
jobid
- The ID of the job whose zipped log file is to be removed 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
jobid
- The ID of the job whose job log is to be purged logSubDirName
- The name of the log subdirectory of the job whose job log is to be purged 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
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
userId
- The user ID used to log into the Job Management Console prefScope
- 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 command java.rmi.RemoteException
saveUserPrefs
userId
- The user ID used to log into the Job Management Console prefScope
- 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 SchedulerException
- if an unexpected error is thrown by the job scheduler while processing the command java.rmi.RemoteException
getJobLogMetaDataByAgeForClass
jobClass
- The class identifier on which to match 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
jobClass
- The class identifier on which to match 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
jobid
- The ID of the job whose application job logging is to be stopped 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
jobid
- The ID of the job Status
- The status of the job java.rmi.RemoteException
isSAF
java.rmi.RemoteException