org.ow2.proactive.scheduler.common

Interface Scheduler

All Superinterfaces:

SchedulerUsage, ThirdPartyCredentials

All Known Subinterfaces:

ISchedulerClient

All Known Implementing Classes:

AbstractSmartProxy, ClientBase, RestSmartProxyImpl, SchedulerClient, SchedulerNodeClient, SchedulerProxyUserInterface, SmartProxyImpl

@PublicAPI
public interface Scheduler
extends SchedulerUsage, ThirdPartyCredentials

Scheduler interface for someone connected to the scheduler. This is suitable for every role in the Scheduler
This interface provides methods to managed the user task and jobs on the scheduler.

Scheduler currently has 2 roles:

• User: will only be able to managed his jobs and tasks, and also see the entire scheduling process.
• Admin: should do what user can do + administration stuffs.

Since:

ProActive Scheduling 2.0

Method Summary

Modifier and Type	Method and Description
SchedulerState	addEventListener(SchedulerEventListener sel, boolean myEventsOnly, boolean getCurrentState, SchedulerEvent... events) Add a scheduler event Listener.
void	addEventListener(SchedulerEventListener sel, boolean myEventsOnly, SchedulerEvent... events) Add a scheduler event Listener.
void	changeJobPriority(JobId jobId, JobPriority priority) Change the priority of the job represented by jobId. Only administrator can change the priority to HIGH, HIGEST, IDLE.
void	changeJobPriority(String jobId, JobPriority priority) Change the priority of the job represented by jobId. Only administrator can change the priority to HIGH, HIGEST, IDLE. The jobId is given as a string.
boolean	changePolicy(String policyClassName) For administrator only, change the policy of the scheduler.
boolean	changeStartAt(JobId jobId, String startAt) Change the START_AT generic information at job level and reset the scheduledAt at task level
boolean	checkJobPermissionMethod(String sessionId, String jobId, String method) Check if the user has the permission to execute the method passed as argument
void	disconnect() Disconnect properly the user from the scheduler.
boolean	finishInErrorTask(String jobId, String taskName)
boolean	freeze() For administrator only, Freeze the scheduler by terminating running tasks.
String	getCurrentPolicy() Return the name of the current Policy
String	getCurrentUser() Returns the user currently connected
UserData	getCurrentUserData() Returns the user data object associated with the user currently connected
List<String>	getGlobalSpaceURIs() Returns the GLOBAL DataSpace URI available to all users
String	getJobContent(JobId jobId)
JobInfo	getJobInfo(String jobId) Retrieve a job info by it id.
JobResult	getJobResult(JobId jobId) Get the result for the given jobId.
JobResult	getJobResult(String jobId) Get the result for the given jobId. The jobId is given as a string.
Page<JobInfo>	getJobs(int offset, int limit, JobFilterCriteria filterCriteria, List<SortParameter<JobSortParameter>> sortParameters) Retrieves a job list of the scheduler.
String	getJobServerLogs(String id) Retrieves server logs for a job with the given id.
List<JobInfo>	getJobsInfoList(List<String> jobsId) Returns a list of jobs info corresponding to the given job IDs (in the same order)
JobState	getJobState(JobId jobId) Return the state of the given job. The state contains informations about the job, every tasks and informations about the tasks. A user can only get the state of HIS job. If the job does not exist, a schedulerException is sent with the proper message.
JobState	getJobState(String jobId) Return the state of the given job. The state contains informations about the job, every tasks and informations about the tasks. The jobId is given as a string.
Map<JobId,JobDescriptor>	getJobsToSchedule() get job Descriptor Map with eligible jobs (running and pending)
Map<Object,Object>	getPortalConfiguration()
Map<String,Object>	getSchedulerProperties() Returns the scheduler properties associated with the user currently connected
SchedulerState	getState() Get the list of job states that describe every jobs in the Scheduler.
SchedulerState	getState(boolean myJobsOnly) Get the list of job states that describe every jobs in the Scheduler.
SchedulerStatus	getStatus() Get the current status of the Scheduler
Page<TaskId>	getTaskIds(String taskTag, long from, long to, boolean mytasks, boolean running, boolean pending, boolean finished, int offset, int limit) Retrieve a tasks names list from the scheduler.
TaskStatesPage	getTaskPaginated(String jobId, int offset, int limit) Return the page of tasks of the given job.
TaskResult	getTaskResult(JobId jobId, String taskName) Get the result for the given task name in the given jobId.
TaskResult	getTaskResult(String jobId, String taskName) Get the result for the given task name in the given jobId.
List<TaskResult>	getTaskResultAllIncarnations(JobId jobId, String taskName) Get the result for the given task name and all result incarnations in the given jobId.
List<TaskResult>	getTaskResultAllIncarnations(String jobId, String taskName) Get the result for the given task name and all result incarnations in the given jobId.
TaskResult	getTaskResultFromIncarnation(JobId jobId, String taskName, int inc) Get the result for the given task name and the given incarnation in the given jobId.
TaskResult	getTaskResultFromIncarnation(String jobId, String taskName, int inc) Get the result for the given task name and the given incarnation in the given jobId.
List<TaskResult>	getTaskResultsByTag(JobId jobId, String taskTag) Get the results for a set of tasks in the given jobId and filtered by a given tag.
List<TaskResult>	getTaskResultsByTag(String jobId, String taskTag) Get the results for a set of tasks in the given jobId and filtered by a given tag.
String	getTaskServerLogs(String id, String taskName) Retrieves server logs for a task with the given id.
String	getTaskServerLogsByTag(String id, String taskTag) Retrieves server logs for a set of tasks filtered by the given tag.
Page<TaskState>	getTaskStates(String taskTag, long from, long to, boolean mytasks, boolean running, boolean pending, boolean finished, int offset, int limit, SortSpecifierContainer sortParams) Retrieve a taskstates list from the scheduler.
List<TaskDescriptor>	getTasksToSchedule() get task descriptor list with eligible tasks (running)
List<SchedulerUserInfo>	getUsers() Returns a list of connected users.
List<String>	getUserSpaceURIs() Returns the USER DataSpace URIs associated with the current user
List<SchedulerUserInfo>	getUsersWithJobs() Returns a list of users having jobs.
boolean	isConnected() Test whether or not the user is connected to the ProActive Scheduler.
boolean	kill() For administrator only, Kill the scheduler. Will stop the scheduling, and shutdown the scheduler.
boolean	killJob(JobId jobId) Kill the job represented by jobId. This method will kill every running tasks of this job, and remove it from the scheduler. The job won't be terminated, it won't have result.
boolean	killJob(String jobId) Kill the job represented by jobId. This method will kill every running tasks of this job, and remove it from the scheduler. The job won't be terminated, it won't have result. The jobId is given as a string.
boolean	killTask(JobId jobId, String taskName) Try to kill the task with the given task name in the given jobId.
boolean	killTask(String jobId, String taskName) Try to kill the task with the given task name in the given jobId.
boolean	linkResourceManager(String rmURL) For administrator only, Reconnect a new Resource Manager to the scheduler.
void	listenJobLogs(JobId jobId, AppenderProvider appenderProvider) Listen for the tasks user logs.
void	listenJobLogs(String jobId, AppenderProvider appenderProvider) Listen for the tasks user logs. The jobId is given as a string.
boolean	pause() For administrator only, Pause the scheduler by terminating running jobs.
boolean	pauseJob(JobId jobId) Pause the job represented by jobId. This method will finish every running tasks of this job, and then pause the job. The job will have to be resumed in order to finish.
boolean	pauseJob(String jobId) Pause the job represented by jobId. This method will finish every running tasks of this job, and then pause the job. The job will have to be resumed in order to finish. The jobId is given as a string.
boolean	preemptTask(JobId jobId, String taskName, int restartDelay) Try to stop the task execution represented by the given task name in the given jobId.
boolean	preemptTask(String jobId, String taskName, int restartDelay) Try to stop the task execution represented by the given task name in the given jobId. If the job does not exist, an UnknownJobException is sent with the proper message. So, if you have the right to stop this task and if the job and task name exist and is running, the task will be stopped and restarted later and this method will return true. The given delay is the delay between the task termination and it's eligibility to be re-scheduled.
boolean	reloadPolicyConfiguration() For administrator only, order a reload to the policy.
void	removeEventListener() Remove the current event listener your listening on. If no listener is defined, this method has no effect.
boolean	removeJob(JobId jobId) Remove the job from the scheduler.
boolean	removeJob(String jobId) Remove the job from the scheduler.
void	renewSession() This method renew the connection lease without other side effect.
boolean	restartAllInErrorTasks(String jobId) Restart all in error tasks in the job represented by jobId. This method will restart every in error tasks of this job. The jobId is given as a string.
boolean	restartInErrorTask(String jobId, String taskName)
boolean	restartTask(JobId jobId, String taskName, int restartDelay) Try to restart the task represented by the given task name in the given jobId.
boolean	restartTask(String jobId, String taskName, int restartDelay) Try to restart the task represented by the given task name in the given jobId.
boolean	resume() For administrator only, Resume the scheduler.
boolean	resumeJob(JobId jobId) Resume the job represented by jobId. This method will restart every non-finished tasks of this job.
boolean	resumeJob(String jobId) Resume the job represented by jobId. This method will restart every non-finished tasks of this job. The jobId is given as a string.
boolean	shutdown() For administrator only, Terminate the scheduler after all currently running tasks are finished.
boolean	start() For administrator only, Start the scheduler.
boolean	stop() For administrator only, Stop the scheduler. Once done, you won't be able to submit job, and the scheduling will be stopped. Every running jobs will be terminated.
JobId	submit(Job job) Submit a new job to the scheduler.

Methods inherited from interface org.ow2.proactive.scheduler.common.usage.SchedulerUsage

getAccountUsage, getMyAccountUsage

Methods inherited from interface org.ow2.proactive.scheduler.common.ThirdPartyCredentials

putThirdPartyCredential, removeThirdPartyCredential, thirdPartyCredentialsKeySet

Method Detail

checkJobPermissionMethod

boolean checkJobPermissionMethod(String sessionId,
                                 String jobId,
                                 String method)
                          throws NotConnectedException,
                                 UnknownJobException

Check if the user has the permission to execute the method passed as argument

Parameters:

sessionId -

jobId -

method -

Returns:

true if the user has the permission to execute the java method

Throws:

NotConnectedException

UnknownJobException

getUserSpaceURIs

List<String> getUserSpaceURIs()
                       throws NotConnectedException,
                              PermissionException

Returns the USER DataSpace URIs associated with the current user

Returns:

USER Space URIs (one element for each available protocol)

Throws:

NotConnectedException - if you are not authenticated.

PermissionException

getGlobalSpaceURIs

List<String> getGlobalSpaceURIs()
                         throws NotConnectedException,
                                PermissionException

Returns the GLOBAL DataSpace URI available to all users

Returns:

GLOBAL Space URIs (one element for each available protocol)

Throws:

NotConnectedException - if you are not authenticated.

PermissionException

getJobResult

JobResult getJobResult(JobId jobId)
                throws NotConnectedException,
                       PermissionException,
                       UnknownJobException

Get the result for the given jobId. A user can only get HIS result back except if he is admin.
If the job does not exist, a schedulerException is sent with the proper message.
So, if you have the right to get the job result represented by the given jobId and if the job exists, so you will receive the result. In any other cases a schedulerException will be thrown.

Parameters:

jobId - the job on which the result will be send

Returns:

a job Result containing information about the result. If the job result is not yet available (job not finished), null is returned.

Throws:

NotConnectedException - if you are not authenticated.

UnknownJobException - if the job does not exist.

PermissionException - if you can't access to this particular job.

getTaskResultFromIncarnation

TaskResult getTaskResultFromIncarnation(JobId jobId,
                                        String taskName,
                                        int inc)
                                 throws NotConnectedException,
                                        UnknownJobException,
                                        UnknownTaskException,
                                        PermissionException

Get the result for the given task name and the given incarnation in the given jobId.

A user can only get HIS result back.

The incarnation argument represents the task result to get. If the task has failed 3 times and then has worked, then 0 represents the last result, 1 the previous, ..., and 3 represents the result of the first execution.

If the job does not exist, a schedulerException is sent with the proper message.

So, if you have the right to get the task result that is in the job represented by the given jobId and if the job and task name exist, so you will receive the result. In any other cases a schedulerException will be thrown.

Parameters:

jobId - the job in which the task result is.

taskName - the name of the task in which the result is.

inc - id of incarnation (0 is the last one, 1 the previous, and so on...)

Returns:

a job Result containing information about the result. If null is returned, this task is not yet terminated or not available.

Throws:

NotConnectedException - if you are not authenticated.

UnknownJobException - if the job does not exist.

UnknownTaskException - if this task does not exist in the job.

PermissionException - if you can't access to this particular job.

IllegalArgumentException - if the incarnation argument is lower than 0 or greater than the number of terminated execution.

getTaskResultAllIncarnations

List<TaskResult> getTaskResultAllIncarnations(JobId jobId,
                                              String taskName)
                                       throws NotConnectedException,
                                              UnknownJobException,
                                              UnknownTaskException,
                                              PermissionException

Get the result for the given task name and all result incarnations in the given jobId.

This method returns a list of task result attempts. If the task has failed 3 times and then has worked, then the list will contain a list of 4 task results. 0 represents the first failed result attempt, 1 the next one, ..., and 3 represents the result of the last execution. In that sense the id order is reversed comparing to individual calls to getTaskResultFromIncarnation

Parameters:

jobId - the job in which the task result is.

taskName - the name of the task in which the result is.

Returns:

a list of Task Results containing information about the result. If the returned list is empty, this task is not yet terminated or not available.

Throws:

NotConnectedException - if you are not authenticated.

UnknownJobException - if the job does not exist.

UnknownTaskException - if this task does not exist in the job.

PermissionException - if you can't access to this particular job.

IllegalArgumentException - if the incarnation argument is lower than 0 or greater than the number of terminated execution.

getTaskResultAllIncarnations

List<TaskResult> getTaskResultAllIncarnations(String jobId,
                                              String taskName)
                                       throws NotConnectedException,
                                              UnknownJobException,
                                              UnknownTaskException,
                                              PermissionException

Get the result for the given task name and all result incarnations in the given jobId.

This method returns a list of task result attempts. If the task has failed 3 times and then has worked, then the list will contain a list of 4 task results. 0 represents the first failed result attempt, 1 the next one, ..., and 3 represents the result of the last execution. In that sense the id order is reversed comparing to individual calls to

Parameters:

jobId - the job in which the task result is.

taskName - the name of the task in which the result is.

Returns:

a list of Task Results containing information about the result. If the returned list is empty, this task is not yet terminated or not available.

Throws:

NotConnectedException - if you are not authenticated.

UnknownJobException - if the job does not exist.

UnknownTaskException - if this task does not exist in the job.

PermissionException - if you can't access to this particular job.

IllegalArgumentException - if the incarnation argument is lower than 0 or greater than the number of terminated execution.

killTask

boolean killTask(JobId jobId,
                 String taskName)
          throws NotConnectedException,
                 UnknownJobException,
                 UnknownTaskException,
                 PermissionException

Try to kill the task with the given task name in the given jobId. A user can only kill HIS task.

If the job does not exist, an UnknownJobException is sent with the proper message.

So, if you have the right to kill this task and if the job and task name exist and is running, the task will be killed and this method will return true. In any other cases a SchedulerException will be thrown.

Parameters:

jobId - the job containing the task to be killed.

taskName - the name of the task to kill.

Returns:

true if the action to kill the task has succeed, false if the task cannot be killed because it's not running.

Throws:

NotConnectedException - if you are not authenticated.

UnknownJobException - if the job does not exist.

UnknownTaskException - if this task does not exist in the job.

PermissionException - if you can't access to this particular job and task.

restartTask

boolean restartTask(JobId jobId,
                    String taskName,
                    int restartDelay)
             throws NotConnectedException,
                    UnknownJobException,
                    UnknownTaskException,
                    PermissionException

Try to restart the task represented by the given task name in the given jobId. A user can only restart HIS task.

If the job does not exist, an UnknownJobException is sent with the proper message. So, if you have the right to restart this task and if the job and task name exist and is running, the task will be restarted and this method will return true.

The given delay is the delay between the task termination and it's eligibility to be re-scheduled. In any other cases a SchedulerException will be thrown.

After this call, the following situations can occur :

• The task has not yet reached its max number of execution : it will be re-scheduled after delay
• The task has reached its max number of execution : it becomes faulty
• The task has reached its max number of execution and is cancelJobOnError : it becomes faulty and the job is terminated

Parameters:

jobId - the job containing the task to be restarted.

taskName - the name of the task to restart.

restartDelay - the delay between the task termination and it's eligibility to be re-scheduled (in sec)

Returns:

true if the action to restart the task has succeed, false if the task cannot be restarted because it's not running.

Throws:

NotConnectedException - if you are not authenticated.

UnknownJobException - if the job does not exist.

UnknownTaskException - if this task does not exist in the job.

PermissionException - if you can't access to this particular job and task.

preemptTask

boolean preemptTask(JobId jobId,
                    String taskName,
                    int restartDelay)
             throws NotConnectedException,
                    UnknownJobException,
                    UnknownTaskException,
                    PermissionException

Try to stop the task execution represented by the given task name in the given jobId.

If the job does not exist, an UnknownJobException is sent with the proper message.

So, if you have the right to stop this task and if the job and task name exist and is running, the task will be stopped and restarted later and this method will return true.

The given delay is the delay between the task termination and it's eligibility to be re-scheduled. In any other cases a SchedulerException will be thrown.

Parameters:

jobId - the job containing the task to be stopped.

taskName - the name of the task to stop.

restartDelay - the delay between the task termination and it's eligibility to be re-scheduled (in sec)

Returns:

true if the action to stop the task has succeed, false if the task cannot be stopped because it's not running.

Throws:

NotConnectedException - if you are not authenticated.

UnknownJobException - if the job does not exist.

UnknownTaskException - if this task does not exist in the job.

PermissionException - if you can't access to this particular job and task.

removeJob

boolean removeJob(JobId jobId)
           throws NotConnectedException,
                  UnknownJobException,
                  PermissionException

Remove the job from the scheduler.

Parameters:

jobId - the job to be removed.

Throws:

NotConnectedException - if you are not authenticated.

UnknownJobException - if the job does not exist.

PermissionException - if you can't access to this particular job.

listenJobLogs

void listenJobLogs(JobId jobId,
                   AppenderProvider appenderProvider)
            throws NotConnectedException,
                   UnknownJobException,
                   PermissionException

Listen for the tasks user logs.

A user can only listen to HIS jobs.

Parameters:

jobId - the id of the job to listen to.

appenderProvider - a provider for an appender that must be connected on a log server on the caller side (see LogForwardingService)

Throws:

NotConnectedException - if you are not authenticated.

UnknownJobException - if the job does not exist.

PermissionException - if you can't access to this particular job.

killJob

boolean killJob(JobId jobId)
         throws NotConnectedException,
                UnknownJobException,
                PermissionException

Kill the job represented by jobId.
This method will kill every running tasks of this job, and remove it from the scheduler.
The job won't be terminated, it won't have result.

Parameters:

jobId - the job to kill.

Returns:

true if success, false if not.

Throws:

NotConnectedException - if you are not authenticated.

UnknownJobException - if the job does not exist.

PermissionException - if you can't access to this particular job.

pauseJob

boolean pauseJob(JobId jobId)
          throws NotConnectedException,
                 UnknownJobException,
                 PermissionException

Pause the job represented by jobId.
This method will finish every running tasks of this job, and then pause the job.
The job will have to be resumed in order to finish.

Parameters:

jobId - the job to pause.

Returns:

true if success, false if not.

Throws:

NotConnectedException - if you are not authenticated.

UnknownJobException - if the job does not exist.

PermissionException - if you can't access to this particular job.

resumeJob

boolean resumeJob(JobId jobId)
           throws NotConnectedException,
                  UnknownJobException,
                  PermissionException

Resume the job represented by jobId.
This method will restart every non-finished tasks of this job.

Parameters:

jobId - the job to resume.

Returns:

true if success, false if not.

Throws:

NotConnectedException - if you are not authenticated.

UnknownJobException - if the job does not exist.

PermissionException - if you can't access to this particular job.

changeJobPriority

void changeJobPriority(JobId jobId,
                       JobPriority priority)
                throws NotConnectedException,
                       UnknownJobException,
                       PermissionException,
                       JobAlreadyFinishedException

Change the priority of the job represented by jobId.
Only administrator can change the priority to HIGH, HIGEST, IDLE.

Parameters:

jobId - the job on which to change the priority.

priority - The new priority to apply to the job.

Throws:

NotConnectedException - if you are not authenticated.

UnknownJobException - if the job does not exist.

PermissionException - if you can't access to this particular job.

JobAlreadyFinishedException - if you want to change the priority on a finished job.

changePolicy

boolean changePolicy(String policyClassName)
              throws NotConnectedException,
                     PermissionException

For administrator only, change the policy of the scheduler.

This method will immediately change the policy and so the whole scheduling process.

Parameters:

policyClassName - the new policy full class name.

Returns:

true if the policy has been correctly change, false if not.

Throws:

NotConnectedException - if you are not authenticated.

PermissionException - if you have not enough permission to access this method.

start

boolean start()
       throws NotConnectedException,
              PermissionException

For administrator only, Start the scheduler.

Returns:

true if success, false if not.

Throws:

NotConnectedException - if you are not authenticated.

PermissionException - if you have not enough permission to access this method.

stop

boolean stop()
      throws NotConnectedException,
             PermissionException

For administrator only, Stop the scheduler.
Once done, you won't be able to submit job, and the scheduling will be stopped.
Every running jobs will be terminated.

Returns:

true if success, false if not.

Throws:

NotConnectedException - if you are not authenticated.

PermissionException - if you have not enough permission to access this method.

pause

boolean pause()
       throws NotConnectedException,
              PermissionException

For administrator only, Pause the scheduler by terminating running jobs.

Returns:

true if success, false if not.

Throws:

NotConnectedException - if you are not authenticated.

PermissionException - if you have not enough permission to access this method.

freeze

boolean freeze()
        throws NotConnectedException,
               PermissionException

For administrator only, Freeze the scheduler by terminating running tasks.

Returns:

true if success, false if not.

Throws:

NotConnectedException - if you are not authenticated.

PermissionException - if you have not enough permission to access this method.

resume

boolean resume()
        throws NotConnectedException,
               PermissionException

For administrator only, Resume the scheduler.

Returns:

true if success, false if not.

Throws:

NotConnectedException - if you are not authenticated.

PermissionException - if you have not enough permission to access this method.

shutdown

boolean shutdown()
          throws NotConnectedException,
                 PermissionException

For administrator only, Terminate the scheduler after all currently running tasks are finished.

Returns:

true if success, false if not.

Throws:

NotConnectedException - if you are not authenticated.

PermissionException - if you have not enough permission to access this method.

kill

boolean kill()
      throws NotConnectedException,
             PermissionException

For administrator only, Kill the scheduler.
Will stop the scheduling, and shutdown the scheduler.

Returns:

true if success, false if not.

Throws:

NotConnectedException - if you are not authenticated.

PermissionException - if you have not enough permission to access this method.

linkResourceManager

boolean linkResourceManager(String rmURL)
                     throws NotConnectedException,
                            PermissionException

For administrator only, Reconnect a new Resource Manager to the scheduler.

Can be used if the resource manager has crashed.

Parameters:

rmURL - the URL of the new Resource Manager to link to the scheduler. Example: //host/RM_node_name

Returns:

true if success, false otherwise.

Throws:

NotConnectedException - if you are not authenticated.

PermissionException - if you have not enough permission to access this method.

reloadPolicyConfiguration

boolean reloadPolicyConfiguration()
                           throws NotConnectedException,
                                  PermissionException

For administrator only, order a reload to the policy.

The default behavior reload the configuration file and update the properties available in policy. This will cause the Policy#reloadConfig() method to be called. This last method can be overridden in the policy to perform a custom behavior on reload.

Returns:

true if success, false otherwise.

Throws:

NotConnectedException - if you are not authenticated.

PermissionException - if you have not enough permission to access this method.

submit

JobId submit(Job job)
      throws NotConnectedException,
             PermissionException,
             SubmissionClosedException,
             JobCreationException

Submit a new job to the scheduler. A user can only managed their jobs.

It will execute the tasks of the jobs as soon as resources are available. The job will be considered as finished once every tasks have finished (error or success). Thus, user could get the job result according to the precious result.

It is possible to get a listener on the scheduler. (see addEventListener(SchedulerEventListener, boolean, SchedulerEvent...) for more details)

Parameters:

job - the new job to submit.

Returns:

the generated new job ID.

Throws:

NotConnectedException - if you are not authenticated.

PermissionException - if you can't access to this particular method.

SubmissionClosedException - if the submit action could not be performed.

JobCreationException - if Their was a problem while creation the job

getJobResult

JobResult getJobResult(String jobId)
                throws NotConnectedException,
                       PermissionException,
                       UnknownJobException

Get the result for the given jobId.
The jobId is given as a string. It's in fact the string returned by the JobId.value() method.
A user can only get HIS result back except if he is admin.
If the job does not exist, a schedulerException is sent with the proper message.
So, if you have the right to get the job result represented by the given jobId and if the job exists, so you will receive the result. In any other cases a schedulerException will be thrown.

Parameters:

jobId - the job on which the result will be send

Returns:

a job Result containing information about the result. If the job result is not yet available (job not finished), null is returned.

Throws:

NotConnectedException - if you are not authenticated.

UnknownJobException - if the job does not exist.

PermissionException - if you can't access to this particular job.

getTaskResult

TaskResult getTaskResult(String jobId,
                         String taskName)
                  throws NotConnectedException,
                         UnknownJobException,
                         UnknownTaskException,
                         PermissionException

Get the result for the given task name in the given jobId.
The jobId is given as a string. It's in fact the string returned by the JobId.value() method.
A user can only get HIS result back.
If the job does not exist, a schedulerException is sent with the proper message.
So, if you have the right to get the task result that is in the job represented by the given jobId and if the job and task name exist, so you will receive the result. In any other cases a schedulerException will be thrown.

Parameters:

jobId - the job in which the task result is.

taskName - the name of the task in which the result is.

Returns:

a job Result containing information about the result. If null is returned, this task is not yet terminated or not available.

Throws:

NotConnectedException - if you are not authenticated.

UnknownJobException - if the job does not exist.

UnknownTaskException - if this task does not exist in the job.

PermissionException - if you can't access to this particular job.

getTaskResultsByTag

List<TaskResult> getTaskResultsByTag(JobId jobId,
                                     String taskTag)
                              throws NotConnectedException,
                                     UnknownJobException,
                                     PermissionException

Get the results for a set of tasks in the given jobId and filtered by a given tag. A user can only get HIS result back.
If the job does not exist, an UnknownJobException is sent with the proper message.
So, if you have the right to get the task result that is in the job represented by the given jobId and if the job and task name exist, so you will receive the result. In any other cases a schedulerException will be thrown.

Parameters:

jobId - the job in which the task result is.

taskTag - the tag used to filter the tasks in which the result is.

Returns:

a job Result containing information about the result. If the task result is not yet available, null is returned.

Throws:

NotConnectedException - if you are not authenticated.

UnknownJobException - if the job does not exist.

PermissionException - if you can't access to this particular job.

getTaskResultsByTag

List<TaskResult> getTaskResultsByTag(String jobId,
                                     String taskTag)
                              throws NotConnectedException,
                                     UnknownJobException,
                                     PermissionException

Get the results for a set of tasks in the given jobId and filtered by a given tag.
The jobId is given as a string. It's in fact the string returned by the JobId.value() method.
A user can only get HIS result back.
If the job does not exist, a schedulerException is sent with the proper message.
So, if you have the right to get the task result that is in the job represented by the given jobId and if the job and task name exist, so you will receive the result of these tasks. In any other cases a schedulerException will be thrown.

Parameters:

jobId - the job in which the task result is.

taskTag - the tag used to filter the tasks in which the result is.

Returns:

the list of task result containing information about the result. If null is returned, this task is not yet terminated or not available.

Throws:

NotConnectedException - if you are not authenticated.

UnknownJobException - if the job does not exist.

PermissionException - if you can't access to this particular job.

getTaskResult

TaskResult getTaskResult(JobId jobId,
                         String taskName)
                  throws NotConnectedException,
                         UnknownJobException,
                         UnknownTaskException,
                         PermissionException

Get the result for the given task name in the given jobId. A user can only get HIS result back.
If the job does not exist, an UnknownJobException is sent with the proper message.
So, if you have the right to get the task result that is in the job represented by the given jobId and if the job and task name exist, so you will receive the result. In any other cases a schedulerException will be thrown.

Parameters:

jobId - the job in which the task result is.

taskName - the name of the task in which the result is.

Returns:

a job Result containing information about the result. If the task result is not yet available, null is returned.

Throws:

NotConnectedException - if you are not authenticated.

UnknownJobException - if the job does not exist.

UnknownTaskException - if this task does not exist in the job.

PermissionException - if you can't access to this particular job.

getTaskResultFromIncarnation

TaskResult getTaskResultFromIncarnation(String jobId,
                                        String taskName,
                                        int inc)
                                 throws NotConnectedException,
                                        UnknownJobException,
                                        UnknownTaskException,
                                        PermissionException

Get the result for the given task name and the given incarnation in the given jobId. The jobId is given as a string. It's in fact the string returned by the JobId.value() method. A user can only get HIS result back. The incarnation argument represents the task result to get. If the task has failed 3 times and then has worked, then 0 represents the last result, 1 the previous, ..., and 3 represents the result of the first execution.

If the job does not exist, a schedulerException is sent with the proper message. So, if you have the right to get the task result that is in the job represented by the given jobId and if the job and task name exist, so you will receive the result. In any other cases a schedulerException will be thrown.

Parameters:

jobId - the job in which the task result is.

taskName - the name of the task in which the result is.

inc - id of incarnation (0 is the last one, 1 the previous, and so on...)

Returns:

a job Result containing information about the result. If null is returned, this task is not yet terminated or not available.

Throws:

NotConnectedException - if you are not authenticated.

UnknownJobException - if the job does not exist.

UnknownTaskException - if this task does not exist in the job.

PermissionException - if you can't access to this particular job.

IllegalArgumentException - if the incarnation argument is lower than 0 or greater than the number of terminated execution.

removeJob

boolean removeJob(String jobId)
           throws NotConnectedException,
                  UnknownJobException,
                  PermissionException

Remove the job from the scheduler.

The jobId is given as a string. It's in fact the string returned by the JobId.value() method.
A user can only remove HIS job.
If the job does not exist, a schedulerException is sent with the proper message.

Parameters:

jobId - the job to be removed.

Returns:

true if success, false if job is not terminated.

Throws:

NotConnectedException - if you are not authenticated.

UnknownJobException - if the job does not exist.

PermissionException - if you can't access to this particular job.

listenJobLogs

void listenJobLogs(String jobId,
                   AppenderProvider appenderProvider)
            throws NotConnectedException,
                   UnknownJobException,
                   PermissionException

Listen for the tasks user logs.
The jobId is given as a string. It's in fact the string returned by the JobId.value() method.
A user can only listen to HIS jobs.

Parameters:

jobId - the id of the job to listen to.

appenderProvider - a provider for an appender that must be connected on a log server on the caller side (see LogForwardingService)

Throws:

NotConnectedException - if you are not authenticated.

UnknownJobException - if the job does not exist.

PermissionException - if you can't access to this particular job.

killJob

boolean killJob(String jobId)
         throws NotConnectedException,
                UnknownJobException,
                PermissionException

Kill the job represented by jobId.
This method will kill every running tasks of this job, and remove it from the scheduler.
The job won't be terminated, it won't have result.

The jobId is given as a string. It's in fact the string returned by the JobId.value() method.
A user can only kill HIS job.
If the job does not exist, a schedulerException is sent with the proper message.

Parameters:

jobId - the job to kill.

Returns:

true if success, false if not.

Throws:

NotConnectedException - if you are not authenticated.

UnknownJobException - if the job does not exist.

PermissionException - if you can't access to this particular job.

killTask

boolean killTask(String jobId,
                 String taskName)
          throws NotConnectedException,
                 UnknownJobException,
                 UnknownTaskException,
                 PermissionException

Try to kill the task with the given task name in the given jobId. A user can only kill HIS task.
If the job does not exist, an UnknownJobException is sent with the proper message.
So, if you have the right to kill this task and if the job and task name exist and is running, the task will be killed and this method will return true.
In any other cases a SchedulerException will be thrown.

Parameters:

jobId - the job containing the task to be killed.

taskName - the name of the task to kill.

Returns:

true if the action to kill the task has succeed, false if the task cannot be killed because it's not running.

Throws:

NotConnectedException - if you are not authenticated.

UnknownJobException - if the job does not exist.

UnknownTaskException - if this task does not exist in the job.

PermissionException - if you can't access to this particular job and task.

restartTask

boolean restartTask(String jobId,
                    String taskName,
                    int restartDelay)
             throws NotConnectedException,
                    UnknownJobException,
                    UnknownTaskException,
                    PermissionException

Try to restart the task represented by the given task name in the given jobId. A user can only restart HIS task.
If the job does not exist, an UnknownJobException is sent with the proper message.
So, if you have the right to restart this task and if the job and task name exist and is running, the task will be restarted and this method will return true.
The given delay is the delay between the task termination and it's eligibility to be re-scheduled. In any other cases a SchedulerException will be thrown.

After this call, the following situations can occur :

• The task has not yet reached its max number of execution : it will be re-scheduled after delay
• The task has reached its max number of execution : it becomes faulty
• The task has reached its max number of execution and is cancelJobOnError : it becomes faulty and the job is terminated

Parameters:

jobId - the job containing the task to be restarted.

taskName - the name of the task to restart.

restartDelay - the delay between the task termination and it's eligibility to be re-scheduled (in sec)

Returns:

true if the action to restart the task has succeed, false if the task cannot be restarted because it's not running.

Throws:

NotConnectedException - if you are not authenticated.

UnknownJobException - if the job does not exist.

UnknownTaskException - if this task does not exist in the job.

PermissionException - if you can't access to this particular job and task.

finishInErrorTask

boolean finishInErrorTask(String jobId,
                          String taskName)
                   throws NotConnectedException,
                          UnknownJobException,
                          UnknownTaskException,
                          PermissionException

Throws:

NotConnectedException

UnknownJobException

UnknownTaskException

PermissionException

restartInErrorTask

boolean restartInErrorTask(String jobId,
                           String taskName)
                    throws NotConnectedException,
                           UnknownJobException,
                           UnknownTaskException,
                           PermissionException

Throws:

NotConnectedException

UnknownJobException

UnknownTaskException

PermissionException

preemptTask

boolean preemptTask(String jobId,
                    String taskName,
                    int restartDelay)
             throws NotConnectedException,
                    UnknownJobException,
                    UnknownTaskException,
                    PermissionException

Try to stop the task execution represented by the given task name in the given jobId.
If the job does not exist, an UnknownJobException is sent with the proper message.
So, if you have the right to stop this task and if the job and task name exist and is running, the task will be stopped and restarted later and this method will return true.
The given delay is the delay between the task termination and it's eligibility to be re-scheduled. In any other cases a SchedulerException will be thrown.

Parameters:

jobId - the job containing the task to be stopped.

taskName - the name of the task to stop.

restartDelay - the delay between the task termination and it's eligibility to be re-scheduled (in sec)

Returns:

true if the action to stop the task has succeed, false if the task cannot be stopped because it's not running.

Throws:

NotConnectedException - if you are not authenticated.

UnknownJobException - if the job does not exist.

UnknownTaskException - if this task does not exist in the job.

PermissionException - if you can't access to this particular job and task.

pauseJob

boolean pauseJob(String jobId)
          throws NotConnectedException,
                 UnknownJobException,
                 PermissionException

Pause the job represented by jobId.
This method will finish every running tasks of this job, and then pause the job.
The job will have to be resumed in order to finish.

The jobId is given as a string. It's in fact the string returned by the JobId.value() method.
A user can only pause HIS job.
If the job does not exist, a schedulerException is sent with the proper message.

Parameters:

jobId - the job to pause.

Returns:

true if success, false if not.

Throws:

NotConnectedException - if you are not authenticated.

UnknownJobException - if the job does not exist.

PermissionException - if you can't access to this particular job.

restartAllInErrorTasks

boolean restartAllInErrorTasks(String jobId)
                        throws NotConnectedException,
                               UnknownJobException,
                               PermissionException

Restart all in error tasks in the job represented by jobId.
This method will restart every in error tasks of this job.

The jobId is given as a string. It's in fact the string returned by the JobId.value() method.
A user can only restart HIS job.
If the job does not exist, a schedulerException is sent with the proper message.

Parameters:

jobId - the job to resume.

Returns:

true if success, false if not.

Throws:

NotConnectedException - if you are not authenticated.

UnknownJobException - if the job does not exist.

PermissionException - if you can't access to this particular job.

resumeJob

boolean resumeJob(String jobId)
           throws NotConnectedException,
                  UnknownJobException,
                  PermissionException

Resume the job represented by jobId.
This method will restart every non-finished tasks of this job.

The jobId is given as a string. It's in fact the string returned by the JobId.value() method.
A user can only resume HIS job.
If the job does not exist, a schedulerException is sent with the proper message.

Parameters:

jobId - the job to resume.

Returns:

true if success, false if not.

Throws:

NotConnectedException - if you are not authenticated.

UnknownJobException - if the job does not exist.

PermissionException - if you can't access to this particular job.

changeJobPriority

void changeJobPriority(String jobId,
                       JobPriority priority)
                throws NotConnectedException,
                       UnknownJobException,
                       PermissionException,
                       JobAlreadyFinishedException

Change the priority of the job represented by jobId.
Only administrator can change the priority to HIGH, HIGEST, IDLE.

The jobId is given as a string. It's in fact the string returned by the JobId.value() method.
A user can only change HIS job priority.
If the job does not exist, a schedulerException is sent with the proper message.

Parameters:

jobId - the job on which to change the priority.

priority - The new priority to apply to the job.

Throws:

NotConnectedException - if you are not authenticated.

UnknownJobException - if the job does not exist.

PermissionException - if you can't access to this particular job.

JobAlreadyFinishedException - if you want to change the priority on a finished job.

getJobState

JobState getJobState(String jobId)
              throws NotConnectedException,
                     UnknownJobException,
                     PermissionException

Return the state of the given job.
The state contains informations about the job, every tasks and informations about the tasks.

The jobId is given as a string. It's in fact the string returned by the JobId.value() method.
A user can only get the state of HIS job.
If the job does not exist, a schedulerException is sent with the proper message.

Parameters:

jobId - the job on which to get the state.

Returns:

the current state of the given job

Throws:

NotConnectedException - if you are not authenticated.

UnknownJobException - if the job does not exist.

PermissionException - if you can't access to this particular job.

getStatus

SchedulerStatus getStatus()
                   throws NotConnectedException,
                          PermissionException

Get the current status of the Scheduler

Returns:

the current status of the Scheduler

Throws:

NotConnectedException - if you are not authenticated.

PermissionException - if you can't access to this particular method.

getJobState

JobState getJobState(JobId jobId)
              throws NotConnectedException,
                     UnknownJobException,
                     PermissionException

Return the state of the given job.
The state contains informations about the job, every tasks and informations about the tasks.

A user can only get the state of HIS job.
If the job does not exist, a schedulerException is sent with the proper message.

Parameters:

jobId - the job on which to get the state.

Returns:

the current state of the given job

Throws:

NotConnectedException - if you are not authenticated.

UnknownJobException - if the job does not exist.

PermissionException - if you can't access to this particular job.

getState

SchedulerState getState()
                 throws NotConnectedException,
                        PermissionException

Get the list of job states that describe every jobs in the Scheduler. The SchedulerState contains 3 list of jobs, pending, running, and finished. Every jobs will be returned depending on your right.

If a PermissionException is thrown, try using getState(boolean) method with argument true.

Returns:

the list of every jobs in the Scheduler

Throws:

NotConnectedException - if you are not authenticated.

PermissionException - if you can't access to this particular method.

getState

SchedulerState getState(boolean myJobsOnly)
                 throws NotConnectedException,
                        PermissionException

Get the list of job states that describe every jobs in the Scheduler. The SchedulerState contains 3 list of jobs, pending, running, and finished If the given argument is true, only job that you own will be returned, otherwise every jobs will be returned depending on your right.

Parameters:

myJobsOnly - true to get only my jobs, false to get any.

Returns:

the list of every jobs in the Scheduler

Throws:

NotConnectedException - if you are not authenticated.

PermissionException - if you can't access to this particular method.

addEventListener

void addEventListener(SchedulerEventListener sel,
                      boolean myEventsOnly,
                      SchedulerEvent... events)
               throws NotConnectedException,
                      PermissionException

Add a scheduler event Listener. this listener provides method to notice of new coming job, started task, finished task, running job, finished job, etc...

This method behaves exactly the same as a call to addEventListener(sel, myEventsOnly, false, events); but return nothing

Parameters:

sel - a SchedulerEventListener on which the scheduler will talk.

myEventsOnly - a boolean that indicates if you want to receive every event or just the one concerning your jobs. This won't affect the scheduler state event that will be sent anyway.

events - An array of events that you want to receive from the scheduler.

Throws:

NotConnectedException - if you are not authenticated.

PermissionException - if you can't access to this particular job.

addEventListener

SchedulerState addEventListener(SchedulerEventListener sel,
                                boolean myEventsOnly,
                                boolean getCurrentState,
                                SchedulerEvent... events)
                         throws NotConnectedException,
                                PermissionException

Add a scheduler event Listener. this listener provides method to notice of new coming job, started task, finished task, running job, finished job, etc...

You may use this method once by remote or active object.
Every call to this method will remove your previous listening settings.
If you want to get 2 type of events, add the 2 events type you want at the end of this method. If no type is specified, all of them will be sent.

If you want to received the events concerning your job only, just set the 'myEventsOnly' parameter to true. otherwise, you will received events coming from any user.

Parameters:

sel - a SchedulerEventListener on which the scheduler will talk.

myEventsOnly - a boolean that indicates if you want to receive every events or just those concerning your jobs. This won't affect the scheduler state event that will be sent anyway.

getCurrentState - if false, this method returns null, if true, it returns the Scheduler current state.

events - An array of events that you want to receive from the scheduler.

Returns:

the scheduler current state containing the different lists of jobs if the getInitialState parameter is true, null if false.

Throws:

NotConnectedException - if you are not authenticated.

PermissionException - if you can't access to this particular job.

removeEventListener

void removeEventListener()
                  throws NotConnectedException,
                         PermissionException

Remove the current event listener your listening on.
If no listener is defined, this method has no effect.

Throws:

NotConnectedException - if you are not authenticated.

PermissionException - if you can't access to this particular method.

disconnect

void disconnect()
         throws NotConnectedException,
                PermissionException

Disconnect properly the user from the scheduler.

Throws:

NotConnectedException - if you are not authenticated.

PermissionException - if you can't access to this particular method.

isConnected

boolean isConnected()

Test whether or not the user is connected to the ProActive Scheduler. Note that a call to this method DOES NOT renew the connection lease.

Returns:

true if the user connected to a Scheduler, false otherwise.

getCurrentPolicy

String getCurrentPolicy()
                 throws NotConnectedException,
                        PermissionException

Return the name of the current Policy

Returns:

the name of the current policy.

Throws:

NotConnectedException

PermissionException

getJobsToSchedule

Map<JobId,JobDescriptor> getJobsToSchedule()
                                    throws NotConnectedException,
                                           PermissionException

get job Descriptor Map with eligible jobs (running and pending)

Returns:

a Map of eligible jobs.

Throws:

NotConnectedException

PermissionException

getTasksToSchedule

List<TaskDescriptor> getTasksToSchedule()
                                 throws NotConnectedException,
                                        PermissionException

get task descriptor list with eligible tasks (running)

Returns:

a List of eligible task descriptor.

Throws:

NotConnectedException

PermissionException

renewSession

void renewSession()
           throws NotConnectedException

This method renew the connection lease without other side effect.

Throws:

NotConnectedException - if you are not authenticated.

getJobServerLogs

String getJobServerLogs(String id)
                 throws UnknownJobException,
                        NotConnectedException,
                        PermissionException

Retrieves server logs for a job with the given id. Only the job owner of admin if the scheduler can request these logs. It's a combination of corresponding tasks logs belonging to this job plus some extra job specific information.

Parameters:

id - of the job for which logs are requested

Returns:

job's logs

Throws:

UnknownJobException - if the job does not exist.

NotConnectedException - if you are not authenticated.

PermissionException - if you have not enough permission to access this method.

getTaskServerLogs

String getTaskServerLogs(String id,
                         String taskName)
                  throws UnknownJobException,
                         UnknownTaskException,
                         NotConnectedException,
                         PermissionException

Retrieves server logs for a task with the given id. Only the job owner of admin if the scheduler can request these logs. It's a combination of corresponding tasks logs belonging to this job plus some extra job specific information.

Parameters:

id - of the job where the task is.

taskName - the name of the task.

Returns:

tasks's logs

Throws:

UnknownJobException - if the job does not exist.

UnknownTaskException - if this task does not exist in the job.

NotConnectedException - if you are not authenticated.

PermissionException - if you have not enough permission to access this method.

getTaskServerLogsByTag

String getTaskServerLogsByTag(String id,
                              String taskTag)
                       throws UnknownJobException,
                              NotConnectedException,
                              PermissionException

Retrieves server logs for a set of tasks filtered by the given tag. Only the job owner of admin if the scheduler can request these logs. It's a combination of corresponding tasks logs belonging to this job plus some extra job specific information.

Parameters:

id - of the job where the task is.

taskTag - the tag used to filter tasks.

Returns:

tasks's logs

Throws:

UnknownJobException - if the job does not exist.

NotConnectedException - if you are not authenticated.

PermissionException - if you have not enough permission to access this method.

getJobs

Page<JobInfo> getJobs(int offset,
                      int limit,
                      JobFilterCriteria filterCriteria,
                      List<SortParameter<JobSortParameter>> sortParameters)
               throws NotConnectedException,
                      PermissionException

Retrieves a job list of the scheduler.

Parameters:

offset - says to start from this job is

limit - max number of jobs to retrieve

filterCriteria - defines types of job (myonly, pending, running, finished). Important! If user tries to get all jobs (myonly is false) but does not have permissions to do it (namely HandleOnlyMyJobsPermission(true)) user will get his own jobs instead of a PermissionException. This behavior should simplify the client design.

sortParameters - defines in how jobs must be sorted

Returns:

jobs list according to all criteria

Throws:

NotConnectedException - if you are not authenticated.

PermissionException - if you have not enough permission to access this method.

getJobsInfoList

List<JobInfo> getJobsInfoList(List<String> jobsId)
                       throws PermissionException,
                              NotConnectedException

Returns a list of jobs info corresponding to the given job IDs (in the same order)

Parameters:

jobsId - the list of id of the jobs to return, in the same order

Returns:

jobs list of the given list of id

Throws:

NotConnectedException - if you are not authenticated.

PermissionException - if you have not enough permission to access this method.

getUsers

List<SchedulerUserInfo> getUsers()
                          throws NotConnectedException,
                                 PermissionException

Returns a list of connected users.

Throws:

NotConnectedException

PermissionException

getUsersWithJobs

List<SchedulerUserInfo> getUsersWithJobs()
                                  throws NotConnectedException,
                                         PermissionException

Returns a list of users having jobs. These are meaningful users for accounting SchedulerUsage

Throws:

NotConnectedException

PermissionException

getTaskIds

Page<TaskId> getTaskIds(String taskTag,
                        long from,
                        long to,
                        boolean mytasks,
                        boolean running,
                        boolean pending,
                        boolean finished,
                        int offset,
                        int limit)
                 throws NotConnectedException,
                        PermissionException

Retrieve a tasks names list from the scheduler.

Parameters:

taskTag - a complete tag to use to filter tasks

from - the starting date to fetch tasks from. The format is in Epoch time.

to - the end date to stop fetching tasks. The format is in Epoch time.

mytasks - True will only fetch the user tasks, False will fetch everyones.

running - fetch the running tasks.

pending - fetch the pending tasks.

finished - fetch the finished tasks.

offset - the starting task to include in the paginated list.

limit - the last task (not included) before stopping fetching tasks in the paginated list.

Returns:

the paginated list of tasks names satisfying the given criterias. The total number of tasks (without pagination() is also returned.

Throws:

NotConnectedException

PermissionException

getTaskStates

Page<TaskState> getTaskStates(String taskTag,
                              long from,
                              long to,
                              boolean mytasks,
                              boolean running,
                              boolean pending,
                              boolean finished,
                              int offset,
                              int limit,
                              SortSpecifierContainer sortParams)
                       throws NotConnectedException,
                              PermissionException

Retrieve a taskstates list from the scheduler.

Parameters:

taskTag - a complete tag to use to filter tasks

from - the starting date to fetch tasks from. The format is in Epoch time.

to - the end date to stop fetching tasks. The format is in Epoch time.

mytasks - True will only fetch the user tasks, False will fetch everyones.

running - fetch the running tasks.

pending - fetch the pending tasks.

finished - fetch the finished tasks.

offset - the starting task to include in the paginated list.

limit - the last task (not included) before stopping fetching tasks in the paginated list.

Returns:

the paginated list of taskstates satisfying the given criterias. The total number of tasks (without pagination() is also returned.

Throws:

NotConnectedException

PermissionException

getJobInfo

JobInfo getJobInfo(String jobId)
            throws UnknownJobException,
                   NotConnectedException,
                   PermissionException

Retrieve a job info by it id.

Parameters:

jobId - the id of the job we want to fetch info.

Returns:

the JobInfo associated to the given id

Throws:

UnknownJobException

NotConnectedException

PermissionException

changeStartAt

boolean changeStartAt(JobId jobId,
                      String startAt)
               throws NotConnectedException,
                      UnknownJobException,
                      PermissionException

Change the START_AT generic information at job level and reset the scheduledAt at task level

Parameters:

jobId - id of the job that needs to be updated

startAt - its value should be ISO 8601 compliant

Throws:

NotConnectedException

UnknownJobException

PermissionException

getJobContent

String getJobContent(JobId jobId)
              throws NotConnectedException,
                     UnknownJobException,
                     PermissionException,
                     SubmissionClosedException,
                     JobCreationException

Parameters:

jobId - job id of existing job

Returns:

copy of the xml which was submitted to the scheduler

Throws:

NotConnectedException

UnknownJobException

PermissionException

SubmissionClosedException

JobCreationException

getPortalConfiguration

Map<Object,Object> getPortalConfiguration()
                                   throws NotConnectedException,
                                          PermissionException

Returns:

Throws:

PermissionException

NotConnectedException

getCurrentUser

String getCurrentUser()
               throws NotConnectedException

Returns the user currently connected

Returns:

user name

Throws:

NotConnectedException

getCurrentUserData

UserData getCurrentUserData()
                     throws NotConnectedException

Returns the user data object associated with the user currently connected

Returns:

a user data object

Throws:

NotConnectedException

getSchedulerProperties

Map<String,Object> getSchedulerProperties()
                                   throws NotConnectedException,
                                          PermissionException

Returns the scheduler properties associated with the user currently connected

Returns:

scheduler properties

Throws:

NotConnectedException

PermissionException

getTaskPaginated

TaskStatesPage getTaskPaginated(String jobId,
                                int offset,
                                int limit)
                         throws NotConnectedException,
                                UnknownJobException,
                                PermissionException

Return the page of tasks of the given job.

Parameters:

jobId - the job on which to get the state.

offset - the starting index of the sublist of tasks to get

limit - the last index (non inclusive) of the sublist of tasks to get

Returns:

the current state of the given job

Throws:

NotConnectedException - if you are not authenticated.

UnknownJobException - if the job does not exist.

PermissionException - if you can't access to this particular job.