SchedulerProxyUserInterface (scheduling 14.1.0-SNAPSHOT API)

java.lang.Object
- org.ow2.proactive.scheduler.common.util.SchedulerProxyUserInterface

All Implemented Interfaces:

Serializable, ServiceUsingPermission, Scheduler, SchedulerEventListener, ThirdPartyCredentials, SchedulerUsage
```
public class SchedulerProxyUserInterface
extends Object
implements Scheduler, Serializable, SchedulerEventListener
```
This class implements an active object managing a connection to the Scheduler (a proxy to the Scheduler) You must init the proxy by calling the init(String, String, String) method after having created it

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static org.apache.log4j.Logger logger

protected MBeanInfoViewer mbeaninfoviewer

protected Scheduler uischeduler

Fields
Modifier and Type	Field and Description
`static org.apache.log4j.Logger`	`logger`
`protected MBeanInfoViewer`	`mbeaninfoviewer`
`protected Scheduler`	`uischeduler`

Constructor Summary

Constructors
Constructor and Description

SchedulerProxyUserInterface()
Deprecated.

Constructors
Constructor and Description
`SchedulerProxyUserInterface()` Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`SchedulerState`	`addEventListener(SchedulerEventListener sel, boolean myEventsOnly, boolean getCurrentState, SchedulerEvent... events)` Subscribes a listener to the Scheduler
`void`	`addEventListener(SchedulerEventListener sel, boolean myEventsOnly, SchedulerEvent... events)` Add a scheduler event Listener.
`void`	`addExternalEndpointUrl(String jobId, String endpointName, String externalEndpointUrl, String endpointIconUri)` Add an external endpoint url to a job.
`Set<String>`	`addJobSignal(String jobId, String signal, Map<String,String> updatedVariables)` Add the given signal to job signals
`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 newPolicyClassName)` 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`	`changeStartAt(List<JobId> jobIdList, String startAt)` Change the START_AT generic information for multiple jobs at job level and reset the scheduledAt at task level
`boolean`	`checkJobPermissionMethod(String jobId, String method)` Check if the connected user has the permission to execute the method passed as argument
`List<String>`	`checkJobsPermissionMethod(List<String> jobIds, String method)` Check if the connected user has the permission to execute the method passed as argument
`Map<String,Map<String,Boolean>>`	`checkJobsPermissionMethods(List<String> jobIds, List<String> methods)` Returns a map containing pairs that represent the job id as key and a map as value containing the method name and true/false if the user has permission for the jobId and method
`boolean`	`checkPermission(String method)` Checks if the current user is allowed to execute the provided method
`List<JobLabelInfo>`	`createLabels(List<String> labels)` Creates new labels
`void`	`deleteLabel(String labelId)` Remove the given label
`void`	`detachService(String jobId, int serviceInstanceid)` Detach a cloud automation service previously associated with the given job
`void`	`disconnect()` Disconnect properly the user from the scheduler.
`void`	`enableRemoteVisualization(String jobId, String taskName, String connectionString)` Enable Remote visualization for the given job and task
`boolean`	`finishInErrorTask(String jobId, String taskName)`
`boolean`	`freeze()` For administrator only, Freeze the scheduler by terminating running tasks.
`List<JobUsage>`	`getAccountUsage(String user, Date startDate, Date endDate)` Returns details on job and task execution times for a given user's executions.
`static SchedulerProxyUserInterface`	`getActiveInstance()` Singleton active object constructor.
`CompletedJobsCount`	`getCompletedJobs(Boolean myJobs, String workflowName, String bucketName, long startDate, long endDate, int numberOfIntervals)` Retrieves an object containing a map of number of finished jobs with issues by time interval and a map of number of finished jobs without issues by time interval
`CompletedTasksCount`	`getCompletedTasks(Boolean myTasks, String taskName, long startDate, long endDate, int numberOfIntervals)` Retrieves an object containing a map of number of completed tasks with issues by time interval and a map of number of finished tasks without issues by time interval
`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
`FilteredStatistics`	`getFilteredStatistics(String workflowName, String bucketName, Boolean myJobs, long startDate, long endDate)` Retrieves an object containing jobs count-by-state and statistics based on the given filters
`List<String>`	`getGlobalSpaceURIs()` Returns the GLOBAL DataSpace URI available to all users
`String`	`getInfo(String mbeanName)` Deprecated.
`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.
`Map<Long,Map<String,Serializable>>`	`getJobResultMaps(List<String> jobsId)` Return result maps associated with multiple jobs
`Page<JobInfo>`	`getJobs(int index, int range, 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 information 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`	`getJobsToSchedule()` Returns a job Descriptor Map with eligible jobs (running and pending)
`List<JobLabelInfo>`	`getLabels()` Gets all labels.
`Map<String,String>`	`getMappedInfo(String mbeanNameAsString)` Return the informations about the Scheduler MBean as a Map.
`List<JobUsage>`	`getMyAccountUsage(Date startDate, Date endDate)` Returns details on job and task execution times for the caller's executions.
`Map<Object,Object>`	`getPortalConfiguration()`
`Map<Long,List<String>>`	`getPreciousTaskNames(List<String> jobsId)` Return the list of task names declared as precious results
`List<TaskResult>`	`getPreciousTaskResults(String jobId)` Return a list of task results which where declared as "preciousResult" for the given job
`Map`	`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.
`String`	`getStatHistory(String mbeanName, String range, String[] dataSources, String function)`
`SchedulerStatus`	`getStatus()` Get the current status of the Scheduler
`Subject`	`getSubject()` Returns the current user JaaS subject
`Map<String,Integer>`	`getSubmissionModeCount(String workflowName, String bucketName, Boolean myJobs, long startDate, long endDate)` Retrieves a map containing the number of jobs submitted from each portal
`Set<String>`	`getSubmissionModeValues()` Retrieves all the submissionMode values stored in the database
`Page<TaskId>`	`getTaskIds(String taskTag, long from, long to, boolean mytasks, Set<TaskStatus> taskStatuses, 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.
`TaskStatesPage`	`getTaskPaginated(String jobId, String statusFilter, int offset, int limit)`
`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.
`TaskState`	`getTaskState(JobId jobId, String taskName)` Return the state of the given task. The state contains information about a single task. A standard user can only get the state of HIS jobs. If the job or the task does not exist, a schedulerException is sent with the proper message.
`Page<TaskState>`	`getTaskStates(String taskTag, long from, long to, boolean mytasks, Set<TaskStatus> statusFilter, int offset, int limit, SortSpecifierContainer sortParams)` Retrieve a taskstates list from the scheduler.
`List<TaskDescriptor>`	`getTasksToSchedule()` Returns a task descriptor list with eligible tasks (ready for execution)
`List<WorkflowDuration>`	`getTopExecutionTimeWorkflows(int numberOfWorkflows, String workflowName, String bucketName, Boolean myJobs, long startDate, long endDate)` Retrieves an object containing the top workflows with the longest execution time based on the given filters
`List<WorkflowDuration>`	`getTopPendingTimeWorkflows(int numberOfWorkflows, String workflowName, String bucketName, Boolean myJobs, long startDate, long endDate)` Retrieves an object containing the top workflows with the longest pending time based on the given filters
`List<FilteredTopWorkflowsCumulatedCoreTime>`	`getTopWorkflowsCumulatedCoreTime(int numberOfWorkflows, String workflowName, String bucketName, Boolean myJobs, long startDate, long endDate)` Retrieves an object containing the top workflows that consumes the most CPU
`List<FilteredTopWorkflowsNumberOfNodes>`	`getTopWorkflowsNumberOfNodes(int numberOfWorkflows, String workflowName, String bucketName, boolean myJobs, long startDate, long endDate, boolean inParallel)` Retrieves an object containing the top workflows that use most nodes
`List<FilteredTopWorkflow>`	`getTopWorkflowsWithIssues(int numberOfWorkflows, String workflowName, String bucketName, Boolean myJobs, long startDate, long endDate)` Retrieves an object containing the top workflows with issues based on the given filters
`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.
`void`	`init(String url, CredData credData)` initialize the connection the scheduler.
`void`	`init(String url, Credentials credentials)` initialize the connection the scheduler.
`void`	`init(String url, String user, String pwd)` initialize the connection the scheduler.
`boolean`	`isConnected()` Test whether or not the user is connected to the ProActive Scheduler.
`void`	`jobStateUpdatedEvent(NotificationData<JobInfo> notification)` Invoked each time the state of a job has changed. If you want to maintain an up to date list of jobs, just use the `JobState.update(org.ow2.proactive.scheduler.common.job.JobInfo)` method to update the content of your job.
`void`	`jobSubmittedEvent(JobState job)` Invoked each time a new job has been submitted to the Scheduler and validated.
`void`	`jobUpdatedFullDataEvent(JobState job)` Invoked each time the state of a job has changed and each time a scheduler event occurs.
`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`	`killJobs(List<String> jobsId)`
`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.
`void`	`putThirdPartyCredential(String key, String value)` Stores a third-party credential key-value pair in the database.
`void`	`registerService(String jobId, int serviceInstanceid, boolean enableActions)` Register a cloud automation service associated with the given job
`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.
`void`	`removeExternalEndpointUrl(String jobId, String endpointName)` Remove an external endpoint url from a job.
`boolean`	`removeJob(JobId jobId)` Remove the job from the scheduler.
`boolean`	`removeJob(String jobId)` Remove the job from the scheduler.
`void`	`removeJobLabels(List<String> jobIds)` Removes label from jobs
`boolean`	`removeJobs(List<JobId> jobIds)` Remove jobs with given ids
`boolean`	`removeJobs(long olderThen)` Remove jobs older than the given epoch time (jobs which were finished earlier)
`void`	`removeThirdPartyCredential(String key)`
`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.
`JobId`	`reSubmit(JobId currentJobId, Map<String,String> jobVariables, Map<String,String> jobGenericInfos, String sessionId)`
`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.
`void`	`schedulerStateUpdatedEvent(SchedulerEvent eventType)` Invoked each time a scheduler event occurs. Scheduler events are stopped,started, paused, frozen, etc.
`void`	`setLabelOnJobs(String labelId, List<String> jobIds)` Sets label on jobs
`List<JobLabelInfo>`	`setLabels(List<String> labels)` Sets the list of labels.
`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.
`List<JobIdDataAndError>`	`submit(List<Job> jobs)` Submit multiple jobs
`void`	`taskStateUpdatedEvent(NotificationData<TaskInfo> notification)` Invoked each time the state of a task has changed. In this case you can use the `JobState.update(org.ow2.proactive.scheduler.common.task.TaskInfo)` method to update the content of the designated task inside your job.
`Set<String>`	`thirdPartyCredentialsKeySet()`
`JobLabelInfo`	`updateLabel(String labelId, String newLabel)` Update the given label
`void`	`updateLogo(byte[] image)` Updates the logo on all portals
`void`	`usersUpdatedEvent(NotificationData<UserIdentification> notification)` Invoked each time something change about users.
`List<JobVariable>`	`validateJobSignal(String jobId, String signal, Map<String,String> updatedVariables)` Validate the given signal's updated variables
`void`	`waitForJobFinished(JobId jobId, Long timeout)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - uischeduler
```
protected transient Scheduler uischeduler
```
  - mbeaninfoviewer
```
protected transient MBeanInfoViewer mbeaninfoviewer
```
  - logger
```
public static final org.apache.log4j.Logger logger
```
- Constructor Detail
  - SchedulerProxyUserInterface
```
public SchedulerProxyUserInterface()
```
    Deprecated.
    
    Default constructor demanded by ProActive. WARNING: Singleton pattern: Use getActiveInstance() instead of this constructor
- Method Detail
  - getActiveInstance
```
public static SchedulerProxyUserInterface getActiveInstance()
                                                     throws org.objectweb.proactive.ActiveObjectCreationException,
                                                            org.objectweb.proactive.core.node.NodeException
```
    Singleton active object constructor. Creates the singleton Creates an active object on this and returns a reference to its stub. If the active object is already created, returns the reference
    
    Returns:
    
    Throws:
    
    org.objectweb.proactive.core.node.NodeException
    
    org.objectweb.proactive.ActiveObjectCreationException
  - init
```
public void init(String url,
                 Credentials credentials)
          throws SchedulerException,
                 LoginException
```
    initialize the connection the scheduler. Must be called only once
    
    Parameters:
    
    url - the scheduler's url
    
    credentials - the credential to be passed to the scheduler
    
    Throws:
    
    SchedulerException - thrown if the scheduler is not available
    
    LoginException - thrown if the credential is invalid
  - init
```
public void init(String url,
                 String user,
                 String pwd)
          throws SchedulerException,
                 LoginException
```
    initialize the connection the scheduler. Must be called only once. Create the corresponding credential object before sending it to the scheduler.
    
    Parameters:
    
    url - the scheduler's url
    
    user - the username to use
    
    pwd - the password to use
    
    Throws:
    
    SchedulerException - thrown if the scheduler is not available
    
    LoginException - if the couple username/password is invalid
  - init
```
public void init(String url,
                 CredData credData)
          throws SchedulerException,
                 LoginException
```
    initialize the connection the scheduler. Must be called only once. Create the corresponding credential object before sending it to the scheduler.
    
    Parameters:
    
    url - the scheduler's url
    
    credData - the credential object that contains user-related data
    
    Throws:
    
    SchedulerException - thrown if the scheduler is not available
    
    LoginException - if the couple username/password is invalid
    
    Since:
    
    Scheduling 3.1.0
  - addEventListener
```
public SchedulerState addEventListener(SchedulerEventListener sel,
                                       boolean myEventsOnly,
                                       boolean getCurrentState,
                                       SchedulerEvent... events)
                                throws NotConnectedException,
                                       PermissionException
```
    Subscribes a listener to the Scheduler
    
    Specified by:
    
    addEventListener in interface Scheduler
    
    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 this particular job.
  - disconnect
```
public void disconnect()
                throws NotConnectedException,
                       PermissionException
```
    Description copied from interface: Scheduler
    
    Disconnect properly the user from the scheduler.
    
    Specified by:
    
    disconnect in interface Scheduler
    
    Throws:
    
    NotConnectedException - if you are not authenticated.
    
    PermissionException - if you can't access this particular method.
  - isConnected
```
public boolean isConnected()
```
    Description copied from interface: Scheduler
    
    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.
    
    Specified by:
    
    isConnected in interface Scheduler
    
    Returns:
    
    true if the user connected to a Scheduler, false otherwise.
  - getCurrentPolicy
```
public String getCurrentPolicy()
                        throws NotConnectedException,
                               PermissionException
```
    Description copied from interface: Scheduler
    
    Return the name of the current Policy
    
    Specified by:
    
    getCurrentPolicy in interface Scheduler
    
    Returns:
    
    the name of the current policy.
    
    Throws:
    
    NotConnectedException
    
    PermissionException
  - getJobsToSchedule
```
public Map getJobsToSchedule()
                      throws NotConnectedException,
                             PermissionException
```
    Description copied from interface: Scheduler
    
    Returns a job Descriptor Map with eligible jobs (running and pending)
    
    Specified by:
    
    getJobsToSchedule in interface Scheduler
    
    Returns:
    
    a Map of eligible jobs.
    
    Throws:
    
    NotConnectedException
    
    PermissionException
  - getTasksToSchedule
```
public List<TaskDescriptor> getTasksToSchedule()
                                        throws NotConnectedException,
                                               PermissionException
```
    Description copied from interface: Scheduler
    
    Returns a task descriptor list with eligible tasks (ready for execution)
    
    Specified by:
    
    getTasksToSchedule in interface Scheduler
    
    Returns:
    
    a List of eligible task descriptor.
    
    Throws:
    
    NotConnectedException
    
    PermissionException
  - renewSession
```
public void renewSession()
                  throws NotConnectedException
```
    Description copied from interface: Scheduler
    
    This method renew the connection lease without other side effect.
    
    Specified by:
    
    renewSession in interface Scheduler
    
    Throws:
    
    NotConnectedException - if you are not authenticated.
  - removeEventListener
```
public void removeEventListener()
                         throws NotConnectedException,
                                PermissionException
```
    Description copied from interface: Scheduler
    
    Remove the current event listener your listening on.
    If no listener is defined, this method has no effect.
    
    Specified by:
    
    removeEventListener in interface Scheduler
    
    Throws:
    
    NotConnectedException - if you are not authenticated.
    
    PermissionException - if you can't access this particular method.
  - submit
```
public JobId submit(Job job)
             throws NotConnectedException,
                    PermissionException,
                    SubmissionClosedException,
                    JobCreationException
```
    Description copied from interface: Scheduler
    
    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 Scheduler.addEventListener(SchedulerEventListener, boolean, SchedulerEvent...) for more details)
    
    Specified by:
    
    submit in interface Scheduler
    
    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 this particular method.
    
    SubmissionClosedException - if the submit action could not be performed.
    
    JobCreationException - if Their was a problem while creation the job
  - submit
```
public List<JobIdDataAndError> submit(List<Job> jobs)
                               throws NotConnectedException
```
    Description copied from interface: Scheduler
    
    Submit multiple jobs
    
    Specified by:
    
    submit in interface Scheduler
    
    Parameters:
    
    jobs - a list of jobs to submit
    
    Returns:
    
    a list of objects containing, for each job, a job id or any error occurring during job submission
    
    Throws:
    
    NotConnectedException
  - reSubmit
```
public JobId reSubmit(JobId currentJobId,
                      Map<String,String> jobVariables,
                      Map<String,String> jobGenericInfos,
                      String sessionId)
               throws NotConnectedException,
                      UnknownJobException,
                      PermissionException,
                      JobCreationException,
                      SubmissionClosedException
```
    Specified by:
    
    reSubmit in interface Scheduler
    
    Parameters:
    
    currentJobId - id of the already submitted job
    
    jobVariables - new job variables which is merged to existing job variables of the submitted job
    
    jobGenericInfos - new generic information which is merged to existing generic info of the submitted job
    
    Returns:
    
    job id of the newly submitted job
    
    Throws:
    
    UnknownJobException - if currentJobId does not correspond to any submitted job
    
    PermissionException - if user cannot access job with currentJobId
    
    NotConnectedException
    
    JobCreationException
    
    SubmissionClosedException
  - changeJobPriority
```
public void changeJobPriority(JobId jobId,
                              JobPriority priority)
                       throws NotConnectedException,
                              UnknownJobException,
                              PermissionException,
                              JobAlreadyFinishedException
```
    Description copied from interface: Scheduler
    
    Change the priority of the job represented by jobId.
    Only administrator can change the priority to HIGH, HIGEST, IDLE.
    
    Specified by:
    
    changeJobPriority in interface Scheduler
    
    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 this particular job.
    
    JobAlreadyFinishedException - if you want to change the priority on a finished job.
  - getJobResult
```
public JobResult getJobResult(String jobId)
                       throws NotConnectedException,
                              PermissionException,
                              UnknownJobException
```
    Description copied from interface: Scheduler
    
    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.
    
    Specified by:
    
    getJobResult in interface Scheduler
    
    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.
    
    PermissionException - if you can't access this particular job.
    
    UnknownJobException - if the job does not exist.
  - getUserSpaceURIs
```
public List<String> getUserSpaceURIs()
                              throws NotConnectedException,
                                     PermissionException
```
    Description copied from interface: Scheduler
    
    Returns the USER DataSpace URIs associated with the current user
    
    Specified by:
    
    getUserSpaceURIs in interface Scheduler
    
    Returns:
    
    USER Space URIs (one element for each available protocol)
    
    Throws:
    
    NotConnectedException - if you are not authenticated.
    
    PermissionException
  - getGlobalSpaceURIs
```
public List<String> getGlobalSpaceURIs()
                                throws NotConnectedException,
                                       PermissionException
```
    Description copied from interface: Scheduler
    
    Returns the GLOBAL DataSpace URI available to all users
    
    Specified by:
    
    getGlobalSpaceURIs in interface Scheduler
    
    Returns:
    
    GLOBAL Space URIs (one element for each available protocol)
    
    Throws:
    
    NotConnectedException - if you are not authenticated.
    
    PermissionException
  - getJobResult
```
public JobResult getJobResult(JobId jobId)
                       throws NotConnectedException,
                              PermissionException,
                              UnknownJobException
```
    Description copied from interface: Scheduler
    
    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.
    
    Specified by:
    
    getJobResult in interface Scheduler
    
    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.
    
    PermissionException - if you can't access this particular job.
    
    UnknownJobException - if the job does not exist.
  - getTaskResult
```
public TaskResult getTaskResult(String jobId,
                                String taskName)
                         throws NotConnectedException,
                                UnknownJobException,
                                UnknownTaskException,
                                PermissionException
```
    Description copied from interface: Scheduler
    
    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.
    
    Specified by:
    
    getTaskResult in interface Scheduler
    
    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 this particular job.
  - getTaskResult
```
public TaskResult getTaskResult(JobId jobId,
                                String taskName)
                         throws NotConnectedException,
                                UnknownJobException,
                                UnknownTaskException,
                                PermissionException
```
    Description copied from interface: Scheduler
    
    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.
    
    Specified by:
    
    getTaskResult in interface Scheduler
    
    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 this particular job.
  - getTaskResultsByTag
```
public List<TaskResult> getTaskResultsByTag(JobId jobId,
                                            String taskTag)
                                     throws NotConnectedException,
                                            UnknownJobException,
                                            PermissionException
```
    Description copied from interface: Scheduler
    
    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.
    
    Specified by:
    
    getTaskResultsByTag in interface Scheduler
    
    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 this particular job.
  - getTaskResultsByTag
```
public List<TaskResult> getTaskResultsByTag(String jobId,
                                            String taskTag)
                                     throws NotConnectedException,
                                            UnknownJobException,
                                            PermissionException
```
    Description copied from interface: Scheduler
    
    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.
    
    Specified by:
    
    getTaskResultsByTag in interface Scheduler
    
    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 this particular job.
  - getTaskResultFromIncarnation
```
public TaskResult getTaskResultFromIncarnation(JobId jobId,
                                               String taskName,
                                               int inc)
                                        throws NotConnectedException,
                                               UnknownJobException,
                                               UnknownTaskException,
                                               PermissionException
```
    Description copied from interface: Scheduler
    
    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.
    
    Specified by:
    
    getTaskResultFromIncarnation in interface Scheduler
    
    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 this particular job.
  - getTaskResultAllIncarnations
```
public List<TaskResult> getTaskResultAllIncarnations(JobId jobId,
                                                     String taskName)
                                              throws NotConnectedException,
                                                     UnknownJobException,
                                                     UnknownTaskException,
                                                     PermissionException
```
    Description copied from interface: Scheduler
    
    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
    
    Specified by:
    
    getTaskResultAllIncarnations in interface Scheduler
    
    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 this particular job.
  - getTaskResultAllIncarnations
```
public List<TaskResult> getTaskResultAllIncarnations(String jobId,
                                                     String taskName)
                                              throws NotConnectedException,
                                                     UnknownJobException,
                                                     UnknownTaskException,
                                                     PermissionException
```
    Description copied from interface: Scheduler
    
    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
    
    Specified by:
    
    getTaskResultAllIncarnations in interface Scheduler
    
    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 this particular job.
  - getTaskResultFromIncarnation
```
public TaskResult getTaskResultFromIncarnation(String jobId,
                                               String taskName,
                                               int inc)
                                        throws NotConnectedException,
                                               UnknownJobException,
                                               UnknownTaskException,
                                               PermissionException
```
    Description copied from interface: Scheduler
    
    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.
    
    Specified by:
    
    getTaskResultFromIncarnation in interface Scheduler
    
    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 this particular job.
  - killTask
```
public boolean killTask(JobId jobId,
                        String taskName)
                 throws NotConnectedException,
                        UnknownJobException,
                        UnknownTaskException,
                        PermissionException
```
    Description copied from interface: Scheduler
    
    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.
    
    Specified by:
    
    killTask in interface Scheduler
    
    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 this particular job and task.
  - restartTask
```
public boolean restartTask(JobId jobId,
                           String taskName,
                           int restartDelay)
                    throws NotConnectedException,
                           UnknownJobException,
                           UnknownTaskException,
                           PermissionException
```
    Description copied from interface: Scheduler
    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
    Specified by:
    
    restartTask in interface Scheduler
    
    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 this particular job and task.
  - preemptTask
```
public boolean preemptTask(JobId jobId,
                           String taskName,
                           int restartDelay)
                    throws NotConnectedException,
                           UnknownJobException,
                           UnknownTaskException,
                           PermissionException
```
    Description copied from interface: Scheduler
    
    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.
    
    Specified by:
    
    preemptTask in interface Scheduler
    
    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 this particular job and task.
  - killTask
```
public boolean killTask(String jobId,
                        String taskName)
                 throws NotConnectedException,
                        UnknownJobException,
                        UnknownTaskException,
                        PermissionException
```
    Description copied from interface: Scheduler
    
    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.
    
    Specified by:
    
    killTask in interface Scheduler
    
    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 this particular job and task.
  - restartTask
```
public boolean restartTask(String jobId,
                           String taskName,
                           int restartDelay)
                    throws NotConnectedException,
                           UnknownJobException,
                           UnknownTaskException,
                           PermissionException
```
    Description copied from interface: Scheduler
    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
    Specified by:
    
    restartTask in interface Scheduler
    
    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 this particular job and task.
  - finishInErrorTask
```
public boolean finishInErrorTask(String jobId,
                                 String taskName)
                          throws NotConnectedException,
                                 UnknownJobException,
                                 UnknownTaskException,
                                 PermissionException
```
    Specified by:
    
    finishInErrorTask in interface Scheduler
    
    Throws:
    
    NotConnectedException
    
    UnknownJobException
    
    UnknownTaskException
    
    PermissionException
  - restartInErrorTask
```
public boolean restartInErrorTask(String jobId,
                                  String taskName)
                           throws NotConnectedException,
                                  UnknownJobException,
                                  UnknownTaskException,
                                  PermissionException
```
    Specified by:
    
    restartInErrorTask in interface Scheduler
    
    Throws:
    
    NotConnectedException
    
    UnknownJobException
    
    UnknownTaskException
    
    PermissionException
  - preemptTask
```
public boolean preemptTask(String jobId,
                           String taskName,
                           int restartDelay)
                    throws NotConnectedException,
                           UnknownJobException,
                           UnknownTaskException,
                           PermissionException
```
    Description copied from interface: Scheduler
    
    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.
    
    Specified by:
    
    preemptTask in interface Scheduler
    
    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 this particular job and task.
  - enableRemoteVisualization
```
public void enableRemoteVisualization(String jobId,
                                      String taskName,
                                      String connectionString)
                               throws NotConnectedException,
                                      PermissionException,
                                      UnknownJobException,
                                      UnknownTaskException
```
    Description copied from interface: Scheduler
    
    Enable Remote visualization for the given job and task
    
    Specified by:
    
    enableRemoteVisualization in interface Scheduler
    
    Parameters:
    
    jobId - id of the job
    
    taskName - name of the task which enables visualization
    
    connectionString - visualization connection string
    
    Throws:
    
    NotConnectedException - if you are not authenticated.
    
    PermissionException - if you can't access this particular job and task.
    
    UnknownJobException - if the job does not exist.
    
    UnknownTaskException - if this task does not exist in the job.
  - registerService
```
public void registerService(String jobId,
                            int serviceInstanceid,
                            boolean enableActions)
                     throws NotConnectedException,
                            PermissionException,
                            UnknownJobException
```
    Description copied from interface: Scheduler
    
    Register a cloud automation service associated with the given job
    
    Specified by:
    
    registerService in interface Scheduler
    
    Parameters:
    
    jobId - id of the job
    
    serviceInstanceid - id of the PSA service instance to register
    
    enableActions - if actions should be enabled on this service from the given job
    
    Throws:
    
    NotConnectedException - if you are not authenticated.
    
    PermissionException - if you can't access this particular job.
    
    UnknownJobException - if the job does not exist.
  - detachService
```
public void detachService(String jobId,
                          int serviceInstanceid)
                   throws NotConnectedException,
                          PermissionException,
                          UnknownJobException
```
    Description copied from interface: Scheduler
    
    Detach a cloud automation service previously associated with the given job
    
    Specified by:
    
    detachService in interface Scheduler
    
    Parameters:
    
    jobId - id of the job
    
    serviceInstanceid - id of the PSA service to detach
    
    Throws:
    
    NotConnectedException - if you are not authenticated.
    
    PermissionException - if you can't access this particular job.
    
    UnknownJobException - if the job does not exist.
  - killJob
```
public boolean killJob(JobId jobId)
                throws NotConnectedException,
                       UnknownJobException,
                       PermissionException
```
    Description copied from interface: Scheduler
    
    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.
    
    Specified by:
    
    killJob in interface Scheduler
    
    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 this particular job.
  - listenJobLogs
```
public void listenJobLogs(JobId jobId,
                          AppenderProvider appenderProvider)
                   throws NotConnectedException,
                          UnknownJobException,
                          PermissionException
```
    Description copied from interface: Scheduler
    
    Listen for the tasks user logs.
    A user can only listen to HIS jobs.
    
    Specified by:
    
    listenJobLogs in interface Scheduler
    
    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 this particular job.
  - pauseJob
```
public boolean pauseJob(JobId jobId)
                 throws NotConnectedException,
                        UnknownJobException,
                        PermissionException
```
    Description copied from interface: Scheduler
    
    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.
    
    Specified by:
    
    pauseJob in interface Scheduler
    
    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 this particular job.
  - removeJob
```
public boolean removeJob(JobId jobId)
                  throws NotConnectedException,
                         UnknownJobException,
                         PermissionException
```
    Description copied from interface: Scheduler
    
    Remove the job from the scheduler.
    
    Specified by:
    
    removeJob in interface 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 this particular job.
  - removeJobs
```
public boolean removeJobs(List<JobId> jobIds)
                   throws NotConnectedException,
                          PermissionException
```
    Description copied from interface: Scheduler
    
    Remove jobs with given ids
    
    Specified by:
    
    removeJobs in interface Scheduler
    
    Returns:
    
    true if all jobs with jobIds were removed, otherwise false
    
    Throws:
    
    NotConnectedException - if you are not authenticated
    
    PermissionException - if you can't access to at least one of the job
  - removeJobs
```
public boolean removeJobs(long olderThen)
                   throws NotConnectedException,
                          PermissionException
```
    Description copied from interface: Scheduler
    
    Remove jobs older than the given epoch time (jobs which were finished earlier)
    
    Specified by:
    
    removeJobs in interface Scheduler
    
    Parameters:
    
    olderThen - epoch time to consider
    
    Returns:
    
    true if all jobs with jobIds were removed, otherwise false
    
    Throws:
    
    NotConnectedException - if you are not authenticated
    
    PermissionException - if you can't access to at least one of the job
  - resumeJob
```
public boolean resumeJob(JobId jobId)
                  throws NotConnectedException,
                         UnknownJobException,
                         PermissionException
```
    Description copied from interface: Scheduler
    
    Resume the job represented by jobId.
    This method will restart every non-finished tasks of this job.
    
    Specified by:
    
    resumeJob in interface Scheduler
    
    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 this particular job.
  - changeJobPriority
```
public void changeJobPriority(String jobId,
                              JobPriority priority)
                       throws NotConnectedException,
                              UnknownJobException,
                              PermissionException,
                              JobAlreadyFinishedException
```
    Description copied from interface: Scheduler
    
    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.
    
    Specified by:
    
    changeJobPriority in interface Scheduler
    
    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 this particular job.
    
    JobAlreadyFinishedException - if you want to change the priority on a finished job.
  - getStatus
```
public SchedulerStatus getStatus()
                          throws NotConnectedException,
                                 PermissionException
```
    Description copied from interface: Scheduler
    
    Get the current status of the Scheduler
    
    Specified by:
    
    getStatus in interface Scheduler
    
    Returns:
    
    the current status of the Scheduler
    
    Throws:
    
    NotConnectedException - if you are not authenticated.
    
    PermissionException - if you can't access this particular method.
  - killJob
```
public boolean killJob(String jobId)
                throws NotConnectedException,
                       UnknownJobException,
                       PermissionException
```
    Description copied from interface: Scheduler
    
    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.
    
    Specified by:
    
    killJob in interface Scheduler
    
    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 this particular job.
  - killJobs
```
public boolean killJobs(List<String> jobsId)
                 throws NotConnectedException,
                        PermissionException
```
    Specified by:
    
    killJobs in interface Scheduler
    
    Returns:
    
    true if all jobs were killed
    
    Throws:
    
    NotConnectedException - if you are not authenticated.
    
    PermissionException - if you can't access to at least one particular job
  - pauseJob
```
public boolean pauseJob(String jobId)
                 throws NotConnectedException,
                        UnknownJobException,
                        PermissionException
```
    Description copied from interface: Scheduler
    
    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.
    
    Specified by:
    
    pauseJob in interface Scheduler
    
    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 this particular job.
  - restartAllInErrorTasks
```
public boolean restartAllInErrorTasks(String jobId)
                               throws NotConnectedException,
                                      UnknownJobException,
                                      PermissionException
```
    Description copied from interface: Scheduler
    
    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.
    
    Specified by:
    
    restartAllInErrorTasks in interface Scheduler
    
    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 this particular job.
  - removeJob
```
public boolean removeJob(String jobId)
                  throws NotConnectedException,
                         UnknownJobException,
                         PermissionException
```
    Description copied from interface: Scheduler
    
    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.
    
    Specified by:
    
    removeJob in interface Scheduler
    
    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 this particular job.
  - resumeJob
```
public boolean resumeJob(String jobId)
                  throws NotConnectedException,
                         UnknownJobException,
                         PermissionException
```
    Description copied from interface: Scheduler
    
    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.
    
    Specified by:
    
    resumeJob in interface Scheduler
    
    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 this particular job.
  - addEventListener
```
public void addEventListener(SchedulerEventListener sel,
                             boolean myEventsOnly,
                             SchedulerEvent... events)
                      throws NotConnectedException,
                             PermissionException
```
    Description copied from interface: Scheduler
    
    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
    
    Specified by:
    
    addEventListener in interface Scheduler
    
    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 this particular job.
  - getJobState
```
public JobState getJobState(String jobId)
                     throws NotConnectedException,
                            UnknownJobException,
                            PermissionException
```
    Description copied from interface: Scheduler
    
    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.
    
    Specified by:
    
    getJobState in interface Scheduler
    
    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 this particular job.
  - listenJobLogs
```
public void listenJobLogs(String jobId,
                          AppenderProvider appenderProvider)
                   throws NotConnectedException,
                          UnknownJobException,
                          PermissionException
```
    Description copied from interface: Scheduler
    
    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.
    
    Specified by:
    
    listenJobLogs in interface Scheduler
    
    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 this particular job.
  - changePolicy
```
public boolean changePolicy(String newPolicyClassName)
                     throws NotConnectedException,
                            PermissionException
```
    Description copied from interface: Scheduler
    
    For administrator only, change the policy of the scheduler.
    This method will immediately change the policy and so the whole scheduling process.
    
    Specified by:
    
    changePolicy in interface Scheduler
    
    Parameters:
    
    newPolicyClassName - 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.
  - reloadPolicyConfiguration
```
public boolean reloadPolicyConfiguration()
                                  throws NotConnectedException,
                                         PermissionException
```
    Description copied from interface: Scheduler
    
    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.
    
    Specified by:
    
    reloadPolicyConfiguration in interface Scheduler
    
    Returns:
    
    true if success, false otherwise.
    
    Throws:
    
    NotConnectedException - if you are not authenticated.
    
    PermissionException - if you have not enough permission to access this method.
  - freeze
```
public boolean freeze()
               throws NotConnectedException,
                      PermissionException
```
    Description copied from interface: Scheduler
    
    For administrator only, Freeze the scheduler by terminating running tasks.
    
    Specified by:
    
    freeze in interface 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.
  - getJobState
```
public JobState getJobState(JobId jobId)
                     throws NotConnectedException,
                            UnknownJobException,
                            PermissionException
```
    Description copied from interface: Scheduler
    
    Return the state of the given job.
    The state contains information 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.
    
    Specified by:
    
    getJobState in interface Scheduler
    
    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 this particular job.
  - getTaskState
```
public TaskState getTaskState(JobId jobId,
                              String taskName)
                       throws NotConnectedException,
                              UnknownJobException,
                              UnknownTaskException,
                              PermissionException
```
    Description copied from interface: Scheduler
    
    Return the state of the given task.
    The state contains information about a single task.
    
    A standard user can only get the state of HIS jobs.
    If the job or the task does not exist, a schedulerException is sent with the proper message.
    
    Specified by:
    
    getTaskState in interface Scheduler
    
    Parameters:
    
    jobId - the job on which to get the state.
    
    taskName - the name of the task.
    
    Returns:
    
    the current state of the given task
    
    Throws:
    
    NotConnectedException - if you are not authenticated.
    
    UnknownJobException - if the job does not exist.
    
    PermissionException - if you can't access this particular job.
    
    UnknownTaskException
  - getState
```
public SchedulerState getState()
                        throws NotConnectedException,
                               PermissionException
```
    Description copied from interface: Scheduler
    
    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 Scheduler.getState(boolean) method with argument true. NOTE: the total list of finished jobs is limited by the Java property 'scheduler.state.max.finished.jobs' configured on the server. Default is 1000 finished jobs.
    
    Specified by:
    
    getState in interface Scheduler
    
    Returns:
    
    the list of every jobs in the Scheduler
    
    Throws:
    
    NotConnectedException - if you are not authenticated.
    
    PermissionException - if you can't access this particular method.
  - kill
```
public boolean kill()
             throws NotConnectedException,
                    PermissionException
```
    Description copied from interface: Scheduler
    
    For administrator only, Kill the scheduler.
    Will stop the scheduling, and shutdown the scheduler.
    
    Specified by:
    
    kill in interface 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
```
public boolean linkResourceManager(String rmURL)
                            throws NotConnectedException,
                                   PermissionException
```
    Description copied from interface: Scheduler
    
    For administrator only, Reconnect a new Resource Manager to the scheduler.
    Can be used if the resource manager has crashed.
    
    Specified by:
    
    linkResourceManager in interface Scheduler
    
    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.
  - pause
```
public boolean pause()
              throws NotConnectedException,
                     PermissionException
```
    Description copied from interface: Scheduler
    
    For administrator only, Pause the scheduler by terminating running jobs.
    
    Specified by:
    
    pause in interface 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.
  - resume
```
public boolean resume()
               throws NotConnectedException,
                      PermissionException
```
    Description copied from interface: Scheduler
    
    For administrator only, Resume the scheduler.
    
    Specified by:
    
    resume in interface 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
```
public boolean shutdown()
                 throws NotConnectedException,
                        PermissionException
```
    Description copied from interface: Scheduler
    
    For administrator only, Terminate the scheduler after all currently running tasks are finished.
    
    Specified by:
    
    shutdown in interface 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.
  - start
```
public boolean start()
              throws NotConnectedException,
                     PermissionException
```
    Description copied from interface: Scheduler
    
    For administrator only, Start the scheduler.
    
    Specified by:
    
    start in interface 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
```
public boolean stop()
             throws NotConnectedException,
                    PermissionException
```
    Description copied from interface: Scheduler
    
    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.
    
    Specified by:
    
    stop in interface 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.
  - getState
```
public SchedulerState getState(boolean myJobsOnly)
                        throws NotConnectedException,
                               PermissionException
```
    Description copied from interface: Scheduler
    
    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. NOTE: the total list of finished jobs is limited by the Java property 'scheduler.state.max.finished.jobs' configured on the server. Default is 1000 finished jobs. From this list, only jobs belonging to the current user will be returned.
    
    Specified by:
    
    getState in interface Scheduler
    
    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 this particular method.
  - getInfo
```
@Deprecated
public String getInfo(String mbeanName)
```
    Deprecated.
    
    Return the informations about the Scheduler MBean as a formatted string. The first time this method is called it connects to the JMX connector server. The default behavior will try to establish a connection using RMI protocol, if it fails the RO (Remote Object) protocol is used.
    
    Parameters:
    
    mbeanName - the object name of the MBean
    
    Returns:
    
    the informations about the MBean as a formatted string
    
    See Also:
    
    MBeanInfoViewer.getInfo(String)
  - getMappedInfo
```
public Map<String,String> getMappedInfo(String mbeanNameAsString)
                                 throws RuntimeException
```
    Return the informations about the Scheduler MBean as a Map. The first time this method is called it connects to the JMX connector server. The default behavior will try to establish a connection using RMI protocol, if it fails the RO (Remote Object) protocol is used.
    
    Parameters:
    
    mbeanNameAsString - the object name of the MBean
    
    Returns:
    
    the informations about the MBean as a formatted string
    
    Throws:
    
    RuntimeException - if mbean cannot access or connect the service
  - getJobServerLogs
```
public String getJobServerLogs(String id)
                        throws UnknownJobException,
                               NotConnectedException,
                               PermissionException
```
    Description copied from interface: Scheduler
    
    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.
    
    Specified by:
    
    getJobServerLogs in interface Scheduler
    
    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
```
public String getTaskServerLogs(String id,
                                String taskName)
                         throws UnknownJobException,
                                UnknownTaskException,
                                NotConnectedException,
                                PermissionException
```
    Description copied from interface: Scheduler
    
    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.
    
    Specified by:
    
    getTaskServerLogs in interface Scheduler
    
    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
```
public String getTaskServerLogsByTag(String id,
                                     String taskTag)
                              throws UnknownJobException,
                                     NotConnectedException,
                                     PermissionException
```
    Description copied from interface: Scheduler
    
    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.
    
    Specified by:
    
    getTaskServerLogsByTag in interface Scheduler
    
    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
```
public Page<JobInfo> getJobs(int index,
                             int range,
                             JobFilterCriteria filterCriteria,
                             List<SortParameter<JobSortParameter>> sortParameters)
                      throws NotConnectedException,
                             PermissionException
```
    Description copied from interface: Scheduler
    
    Retrieves a job list of the scheduler.
    
    Specified by:
    
    getJobs in interface Scheduler
    
    Parameters:
    
    index - says to start from this job is
    
    range - 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
```
public List<JobInfo> getJobsInfoList(List<String> jobsId)
                              throws PermissionException,
                                     NotConnectedException
```
    Description copied from interface: Scheduler
    
    Returns a list of jobs info corresponding to the given job IDs (in the same order)
    
    Specified by:
    
    getJobsInfoList in interface Scheduler
    
    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:
    
    PermissionException - if you have not enough permission to access this method.
    
    NotConnectedException - if you are not authenticated.
  - getUsers
```
public List<SchedulerUserInfo> getUsers()
                                 throws NotConnectedException,
                                        PermissionException
```
    Description copied from interface: Scheduler
    
    Returns a list of connected users.
    
    Specified by:
    
    getUsers in interface Scheduler
    
    Throws:
    
    NotConnectedException
    
    PermissionException
  - getUsersWithJobs
```
public List<SchedulerUserInfo> getUsersWithJobs()
                                         throws NotConnectedException,
                                                PermissionException
```
    Description copied from interface: Scheduler
    
    Returns a list of users having jobs. These are meaningful users for accounting SchedulerUsage
    
    Specified by:
    
    getUsersWithJobs in interface Scheduler
    
    Throws:
    
    NotConnectedException
    
    PermissionException
  - getFilteredStatistics
```
public FilteredStatistics getFilteredStatistics(String workflowName,
                                                String bucketName,
                                                Boolean myJobs,
                                                long startDate,
                                                long endDate)
                                         throws NotConnectedException,
                                                PermissionException
```
    Description copied from interface: Scheduler
    
    Retrieves an object containing jobs count-by-state and statistics based on the given filters
    
    Specified by:
    
    getFilteredStatistics in interface Scheduler
    
    Parameters:
    
    workflowName - filter job by workflow name (or part of its name)
    
    bucketName - filter job by bucket name (or part of its name)
    
    myJobs - fetch only the jobs owned by the user making the request
    
    startDate - start date of the filtered jobs
    
    endDate - end date of the filtered jobs
    
    Returns:
    
    an object containing jobs count-by-state based on the given filters
    
    Throws:
    
    NotConnectedException - if you are not authenticated.
    
    PermissionException - if you have not enough permission to access this method.
  - getTopWorkflowsWithIssues
```
public List<FilteredTopWorkflow> getTopWorkflowsWithIssues(int numberOfWorkflows,
                                                           String workflowName,
                                                           String bucketName,
                                                           Boolean myJobs,
                                                           long startDate,
                                                           long endDate)
                                                    throws NotConnectedException,
                                                           PermissionException
```
    Description copied from interface: Scheduler
    
    Retrieves an object containing the top workflows with issues based on the given filters
    
    Specified by:
    
    getTopWorkflowsWithIssues in interface Scheduler
    
    Parameters:
    
    numberOfWorkflows - number of workflows to show
    
    workflowName - filter job by workflow name (or part of its name)
    
    bucketName - filter job by bucket name (or part of its name)
    
    myJobs - fetch only the jobs owned by the user making the request
    
    startDate - start date of the filtered jobs
    
    endDate - end date of the filtered jobs
    
    Returns:
    
    an object containing the top workflows with issues
    
    Throws:
    
    NotConnectedException - if you are not authenticated.
    
    PermissionException - if you have not enough permission to access this method.
  - getTopWorkflowsCumulatedCoreTime
```
public List<FilteredTopWorkflowsCumulatedCoreTime> getTopWorkflowsCumulatedCoreTime(int numberOfWorkflows,
                                                                                    String workflowName,
                                                                                    String bucketName,
                                                                                    Boolean myJobs,
                                                                                    long startDate,
                                                                                    long endDate)
                                                                             throws NotConnectedException,
                                                                                    PermissionException
```
    Description copied from interface: Scheduler
    
    Retrieves an object containing the top workflows that consumes the most CPU
    
    Specified by:
    
    getTopWorkflowsCumulatedCoreTime in interface Scheduler
    
    Parameters:
    
    numberOfWorkflows - number of workflows to show
    
    workflowName - filter job by workflow name (or part of its name)
    
    bucketName - filter job by bucket name (or part of its name)
    
    myJobs - fetch only the jobs owned by the user making the request
    
    startDate - start date of the filtered jobs
    
    endDate - end date of the filtered jobs
    
    Returns:
    
    an object containing the top workflows that consumes the most CPU
    
    Throws:
    
    NotConnectedException - if you are not authenticated.
    
    PermissionException - if you have not enough permission to access this method.
  - getTopWorkflowsNumberOfNodes
```
public List<FilteredTopWorkflowsNumberOfNodes> getTopWorkflowsNumberOfNodes(int numberOfWorkflows,
                                                                            String workflowName,
                                                                            String bucketName,
                                                                            boolean myJobs,
                                                                            long startDate,
                                                                            long endDate,
                                                                            boolean inParallel)
                                                                     throws NotConnectedException,
                                                                            PermissionException
```
    Description copied from interface: Scheduler
    
    Retrieves an object containing the top workflows that use most nodes
    
    Specified by:
    
    getTopWorkflowsNumberOfNodes in interface Scheduler
    
    Parameters:
    
    numberOfWorkflows - number of workflows to show
    
    workflowName - filter job by workflow name (or part of its name)
    
    bucketName - filter job by bucket name (or part of its name)
    
    myJobs - fetch only the jobs owned by the user making the request
    
    startDate - start date of the filtered jobs
    
    endDate - end date of the filtered jobs
    
    inParallel - if true, returns the maximum number of nodes used in parallel instead of the total number of nodes
    
    Returns:
    
    an object containing the top workflows that use most nodes
    
    Throws:
    
    NotConnectedException - if you are not authenticated.
    
    PermissionException - if you have not enough permission to access this method.
  - getTopExecutionTimeWorkflows
```
public List<WorkflowDuration> getTopExecutionTimeWorkflows(int numberOfWorkflows,
                                                           String workflowName,
                                                           String bucketName,
                                                           Boolean myJobs,
                                                           long startDate,
                                                           long endDate)
                                                    throws NotConnectedException,
                                                           PermissionException
```
    Description copied from interface: Scheduler
    
    Retrieves an object containing the top workflows with the longest execution time based on the given filters
    
    Specified by:
    
    getTopExecutionTimeWorkflows in interface Scheduler
    
    Parameters:
    
    numberOfWorkflows - number of workflows to show
    
    workflowName - filter job by workflow name (or part of its name)
    
    bucketName - filter job by bucket name (or part of its name)
    
    myJobs - fetch only the jobs owned by the user making the request
    
    startDate - start date of the filtered jobs
    
    endDate - end date of the filtered jobs
    
    Returns:
    
    an object containing the top workflows with the longest execution time based on the given filters
    
    Throws:
    
    NotConnectedException - if you are not authenticated.
    
    PermissionException - if you have not enough permission to access this method.
  - getTopPendingTimeWorkflows
```
public List<WorkflowDuration> getTopPendingTimeWorkflows(int numberOfWorkflows,
                                                         String workflowName,
                                                         String bucketName,
                                                         Boolean myJobs,
                                                         long startDate,
                                                         long endDate)
                                                  throws NotConnectedException,
                                                         PermissionException
```
    Description copied from interface: Scheduler
    
    Retrieves an object containing the top workflows with the longest pending time based on the given filters
    
    Specified by:
    
    getTopPendingTimeWorkflows in interface Scheduler
    
    Parameters:
    
    numberOfWorkflows - number of workflows to show
    
    workflowName - filter job by workflow name (or part of its name)
    
    bucketName - filter job by bucket name (or part of its name)
    
    myJobs - fetch only the jobs owned by the user making the request
    
    startDate - start date of the filtered jobs
    
    endDate - end date of the filtered jobs
    
    Returns:
    
    an object containing the top workflows with the longest pending time based on the given filters
    
    Throws:
    
    NotConnectedException - if you are not authenticated.
    
    PermissionException - if you have not enough permission to access this method.
  - getSubmissionModeCount
```
public Map<String,Integer> getSubmissionModeCount(String workflowName,
                                                  String bucketName,
                                                  Boolean myJobs,
                                                  long startDate,
                                                  long endDate)
                                           throws NotConnectedException,
                                                  PermissionException
```
    Description copied from interface: Scheduler
    
    Retrieves a map containing the number of jobs submitted from each portal
    
    Specified by:
    
    getSubmissionModeCount in interface Scheduler
    
    Parameters:
    
    workflowName - filter job by workflow name (or part of its name)
    
    bucketName - filter job by bucket name (or part of its name)
    
    myJobs - fetch only the jobs owned by the user making the request
    
    startDate - start date of the jobs
    
    endDate - end date of the jobs
    
    Returns:
    
    a map containing the number of jobs submitted from each portal
    
    Throws:
    
    NotConnectedException - if you are not authenticated.
    
    PermissionException - if you have not enough permission to access this method.
  - getCompletedJobs
```
public CompletedJobsCount getCompletedJobs(Boolean myJobs,
                                           String workflowName,
                                           String bucketName,
                                           long startDate,
                                           long endDate,
                                           int numberOfIntervals)
                                    throws NotConnectedException,
                                           PermissionException
```
    Description copied from interface: Scheduler
    
    Retrieves an object containing a map of number of finished jobs with issues by time interval and a map of number of finished jobs without issues by time interval
    
    Specified by:
    
    getCompletedJobs in interface Scheduler
    
    Parameters:
    
    myJobs - fetch only the jobs owned by the user making the request
    
    workflowName - filter job by workflow name (or part of its name)
    
    bucketName - filter job by bucket name (or part of its name)
    
    startDate - start date of the filtered jobs
    
    endDate - end date of the filtered jobs, default value represents the current date
    
    numberOfIntervals - number of time intervals
    
    Returns:
    
    an object containing a map of number of finished jobs
    
    Throws:
    
    NotConnectedException - if you are not authenticated.
    
    PermissionException - if you have not enough permission to access this method.
  - getCompletedTasks
```
public CompletedTasksCount getCompletedTasks(Boolean myTasks,
                                             String taskName,
                                             long startDate,
                                             long endDate,
                                             int numberOfIntervals)
                                      throws NotConnectedException,
                                             PermissionException
```
    Description copied from interface: Scheduler
    
    Retrieves an object containing a map of number of completed tasks with issues by time interval and a map of number of finished tasks without issues by time interval
    
    Specified by:
    
    getCompletedTasks in interface Scheduler
    
    Parameters:
    
    myTasks - fetch only the tasks owned by the user making the request
    
    taskName - the task name of the filtered tasks
    
    startDate - start date of the filtered tasks
    
    endDate - end date of the filtered tasks, default value represents the current date
    
    numberOfIntervals - number of time intervals
    
    Returns:
    
    an object containing a map of number of completed tasks
    
    Throws:
    
    NotConnectedException - if you are not authenticated.
    
    PermissionException - if you have not enough permission to access this method.
  - getSubmissionModeValues
```
public Set<String> getSubmissionModeValues()
                                    throws NotConnectedException,
                                           PermissionException
```
    Description copied from interface: Scheduler
    
    Retrieves all the submissionMode values stored in the database
    
    Specified by:
    
    getSubmissionModeValues in interface Scheduler
    
    Returns:
    
    a set of submissionMode values
    
    Throws:
    
    NotConnectedException - if you are not authenticated.
    
    PermissionException - if you have not enough permission to access this method.
  - getMyAccountUsage
```
public List<JobUsage> getMyAccountUsage(Date startDate,
                                        Date endDate)
                                 throws NotConnectedException,
                                        PermissionException
```
    Description copied from interface: SchedulerUsage
    
    Returns details on job and task execution times for the caller's executions.
    Only the jobs finished between the start date and the end date will be returned: i.e startDate <= job.finishedTime <= endDate.
    
    Specified by:
    
    getMyAccountUsage in interface SchedulerUsage
    
    Parameters:
    
    startDate - must not be null, inclusive
    
    endDate - must not be null, inclusive
    
    Returns:
    
    a list of JobUsage objects where job finished times are between start date and end date
    
    Throws:
    
    NotConnectedException - if the caller is not connected
    
    PermissionException - if the caller hasn't the permission to call this method
  - getAccountUsage
```
public List<JobUsage> getAccountUsage(String user,
                                      Date startDate,
                                      Date endDate)
                               throws NotConnectedException,
                                      PermissionException
```
    Description copied from interface: SchedulerUsage
    
    Returns details on job and task execution times for a given user's executions.
    Only the jobs finished between the start date and the end date will be returned: i.e startDate <= job.finishedTime <= endDate.
    If user is the same as the caller, then it will fallback to to SchedulerUsage.getMyAccountUsage(Date, Date).
    
    Specified by:
    
    getAccountUsage in interface SchedulerUsage
    
    Parameters:
    
    user - must match a username as defined in the Scheduler's users
    
    startDate - must not be null, inclusive
    
    endDate - must not be null, inclusive
    
    Returns:
    
    a list of JobUsage objects where job finished times are between start date and end date
    
    Throws:
    
    NotConnectedException - if the caller is not connected
    
    PermissionException - if the caller hasn't the permission to call this method
  - putThirdPartyCredential
```
public void putThirdPartyCredential(String key,
                                    String value)
                             throws SchedulerException
```
    Description copied from interface: ThirdPartyCredentials
    
    Stores a third-party credential key-value pair in the database.
    
    Specified by:
    
    putThirdPartyCredential in interface ThirdPartyCredentials
    
    Parameters:
    
    key - the third-party credential key to store
    
    value - the third-party credential value to store, it will be encrypted
    
    Throws:
    
    NotConnectedException - if you are not authenticated.
    
    PermissionException - if you can't access this particular method.
    
    SchedulerException
  - thirdPartyCredentialsKeySet
```
public Set<String> thirdPartyCredentialsKeySet()
                                        throws SchedulerException
```
    Specified by:
    
    thirdPartyCredentialsKeySet in interface ThirdPartyCredentials
    
    Returns:
    
    all third-party credential keys stored for the current user
    
    Throws:
    
    NotConnectedException - if you are not authenticated.
    
    PermissionException - if you can't access this particular method.
    
    SchedulerException
  - removeThirdPartyCredential
```
public void removeThirdPartyCredential(String key)
                                throws SchedulerException
```
    Specified by:
    
    removeThirdPartyCredential in interface ThirdPartyCredentials
    
    Parameters:
    
    key - the third-party credential key to remove
    
    Throws:
    
    NotConnectedException - if you are not authenticated.
    
    PermissionException - if you can't access this particular method.
    
    SchedulerException
  - getTaskIds
```
public Page<TaskId> getTaskIds(String taskTag,
                               long from,
                               long to,
                               boolean mytasks,
                               Set<TaskStatus> taskStatuses,
                               int offset,
                               int limit)
                        throws SchedulerException
```
    Description copied from interface: Scheduler
    
    Retrieve a tasks names list from the scheduler.
    
    Specified by:
    
    getTaskIds in interface 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.
    
    taskStatuses - Set of task statuses which is used as filter
    
    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:
    
    SchedulerException
  - getTaskStates
```
public Page<TaskState> getTaskStates(String taskTag,
                                     long from,
                                     long to,
                                     boolean mytasks,
                                     Set<TaskStatus> statusFilter,
                                     int offset,
                                     int limit,
                                     SortSpecifierContainer sortParams)
                              throws SchedulerException
```
    Description copied from interface: Scheduler
    
    Retrieve a taskstates list from the scheduler.
    
    Specified by:
    
    getTaskStates in interface 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.
    
    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:
    
    SchedulerException
  - getJobInfo
```
public JobInfo getJobInfo(String jobId)
                   throws SchedulerException
```
    Description copied from interface: Scheduler
    
    Retrieve a job info by it id.
    
    Specified by:
    
    getJobInfo in interface Scheduler
    
    Parameters:
    
    jobId - the id of the job we want to fetch info.
    
    Returns:
    
    the JobInfo associated to the given id
    
    Throws:
    
    SchedulerException
  - changeStartAt
```
public boolean changeStartAt(JobId jobId,
                             String startAt)
                      throws NotConnectedException,
                             UnknownJobException,
                             PermissionException
```
    Description copied from interface: Scheduler
    
    Change the START_AT generic information at job level and reset the scheduledAt at task level
    
    Specified by:
    
    changeStartAt in interface Scheduler
    
    Parameters:
    
    jobId - id of the job that needs to be updated
    
    startAt - its value should be ISO 8601 compliant
    
    Throws:
    
    NotConnectedException
    
    UnknownJobException
    
    PermissionException
  - changeStartAt
```
public boolean changeStartAt(List<JobId> jobIdList,
                             String startAt)
                      throws NotConnectedException,
                             UnknownJobException,
                             PermissionException
```
    Description copied from interface: Scheduler
    
    Change the START_AT generic information for multiple jobs at job level and reset the scheduledAt at task level
    
    Specified by:
    
    changeStartAt in interface Scheduler
    
    Parameters:
    
    jobIdList - id of the jobs that needs to be updated
    
    startAt - its value should be ISO 8601 compliant
    
    Throws:
    
    NotConnectedException
    
    UnknownJobException
    
    PermissionException
  - getJobContent
```
public String getJobContent(JobId jobId)
                     throws SchedulerException
```
    Specified by:
    
    getJobContent in interface Scheduler
    
    Parameters:
    
    jobId - job id of existing job
    
    Returns:
    
    copy of the xml which was submitted to the scheduler
    
    Throws:
    
    SchedulerException
  - getPortalConfiguration
```
public Map<Object,Object> getPortalConfiguration()
                                          throws SchedulerException
```
    Specified by:
    
    getPortalConfiguration in interface Scheduler
    
    Returns:
    
    Throws:
    
    PermissionException
    
    NotConnectedException
    
    SchedulerException
  - getCurrentUser
```
public String getCurrentUser()
                      throws NotConnectedException
```
    Description copied from interface: Scheduler
    
    Returns the user currently connected
    
    Specified by:
    
    getCurrentUser in interface Scheduler
    
    Returns:
    
    user name
    
    Throws:
    
    NotConnectedException
  - getCurrentUserData
```
public UserData getCurrentUserData()
                            throws NotConnectedException
```
    Description copied from interface: Scheduler
    
    Returns the user data object associated with the user currently connected
    
    Specified by:
    
    getCurrentUserData in interface Scheduler
    
    Returns:
    
    a user data object
    
    Throws:
    
    NotConnectedException
  - getSubject
```
public Subject getSubject()
                   throws NotConnectedException
```
    Description copied from interface: Scheduler
    
    Returns the current user JaaS subject
    
    Specified by:
    
    getSubject in interface Scheduler
    
    Returns:
    
    jaas subject
    
    Throws:
    
    NotConnectedException
  - getSchedulerProperties
```
public Map getSchedulerProperties()
                           throws SchedulerException
```
    Description copied from interface: Scheduler
    
    Returns the scheduler properties associated with the user currently connected
    
    Specified by:
    
    getSchedulerProperties in interface Scheduler
    
    Returns:
    
    scheduler properties
    
    Throws:
    
    SchedulerException
  - getTaskPaginated
```
public TaskStatesPage getTaskPaginated(String jobId,
                                       int offset,
                                       int limit)
                                throws NotConnectedException,
                                       UnknownJobException,
                                       PermissionException
```
    Description copied from interface: Scheduler
    
    Return the page of tasks of the given job.
    
    Specified by:
    
    getTaskPaginated in interface Scheduler
    
    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 this particular job.
  - getTaskPaginated
```
public TaskStatesPage getTaskPaginated(String jobId,
                                       String statusFilter,
                                       int offset,
                                       int limit)
                                throws NotConnectedException,
                                       UnknownJobException,
                                       PermissionException
```
    Specified by:
    
    getTaskPaginated in interface Scheduler
    
    Throws:
    
    NotConnectedException
    
    UnknownJobException
    
    PermissionException
  - getPreciousTaskResults
```
public List<TaskResult> getPreciousTaskResults(String jobId)
                                        throws NotConnectedException,
                                               PermissionException,
                                               UnknownJobException
```
    Description copied from interface: Scheduler
    
    Return a list of task results which where declared as "preciousResult" for the given job
    
    Specified by:
    
    getPreciousTaskResults in interface Scheduler
    
    Parameters:
    
    jobId - id of the job
    
    Returns:
    
    a list of precious tasks' results
    
    Throws:
    
    NotConnectedException - if you are not authenticated.
    
    PermissionException - if you can't access this particular job.
    
    UnknownJobException - if the job does not exist.
  - getJobResultMaps
```
public Map<Long,Map<String,Serializable>> getJobResultMaps(List<String> jobsId)
                                                    throws UnknownJobException,
                                                           NotConnectedException,
                                                           PermissionException
```
    Description copied from interface: Scheduler
    
    Return result maps associated with multiple jobs
    
    Specified by:
    
    getJobResultMaps in interface Scheduler
    
    Parameters:
    
    jobsId - list of jobs ids
    
    Returns:
    
    a map containing, for each job, the resultMap associated with that job
    
    Throws:
    
    UnknownJobException - if one of the jobs in the list does not exist.
    
    NotConnectedException - if you are not authenticated.
    
    PermissionException - if you can't access one job in the list.
  - getPreciousTaskNames
```
public Map<Long,List<String>> getPreciousTaskNames(List<String> jobsId)
                                            throws SchedulerException
```
    Description copied from interface: Scheduler
    
    Return the list of task names declared as precious results
    
    Specified by:
    
    getPreciousTaskNames in interface Scheduler
    
    Parameters:
    
    jobsId - id of the job
    
    Returns:
    
    a list of task names declared as "preciousResult" for the given job
    
    Throws:
    
    SchedulerException
  - checkPermission
```
public boolean checkPermission(String method)
                        throws SecurityException
```
    Description copied from interface: ServiceUsingPermission
    
    Checks if the current user is allowed to execute the provided method
    
    Specified by:
    
    checkPermission in interface ServiceUsingPermission
    
    Parameters:
    
    method - method name
    
    Returns:
    
    true if authorization is successful
    
    Throws:
    
    SecurityException - if the user is not allowed to execute this method
  - checkJobPermissionMethod
```
public boolean checkJobPermissionMethod(String jobId,
                                        String method)
                                 throws SchedulerException
```
    Description copied from interface: Scheduler
    
    Check if the connected user has the permission to execute the method passed as argument
    
    Specified by:
    
    checkJobPermissionMethod in interface Scheduler
    
    Parameters:
    
    jobId - id of the job
    
    method - operation to test
    
    Returns:
    
    true if the user has the permission to execute the java method
    
    Throws:
    
    NotConnectedException
    
    UnknownJobException
    
    SchedulerException
  - checkJobsPermissionMethod
```
public List<String> checkJobsPermissionMethod(List<String> jobIds,
                                              String method)
                                       throws SchedulerException
```
    Description copied from interface: Scheduler
    
    Check if the connected user has the permission to execute the method passed as argument
    
    Specified by:
    
    checkJobsPermissionMethod in interface Scheduler
    
    Parameters:
    
    jobIds - list of jobs ids
    
    method - operation to test
    
    Returns:
    
    a list of authorized jobs ids for the given method
    
    Throws:
    
    SchedulerException
  - addJobSignal
```
public Set<String> addJobSignal(String jobId,
                                String signal,
                                Map<String,String> updatedVariables)
                         throws UnknownJobException,
                                NotConnectedException,
                                PermissionException,
                                SignalApiException,
                                JobValidationException
```
    Description copied from interface: Scheduler
    
    Add the given signal to job signals
    
    Specified by:
    
    addJobSignal in interface Scheduler
    
    Parameters:
    
    jobId - id of the job
    
    signal - signal name
    
    updatedVariables - the updated variables of the signal
    
    Returns:
    
    the set of job signals including the added signal
    
    Throws:
    
    UnknownJobException - if the job does not exist.
    
    NotConnectedException - if you are not authenticated.
    
    PermissionException - if you can't access this particular job.
    
    SignalApiException - errors related to the signal api
    
    JobValidationException
  - validateJobSignal
```
public List<JobVariable> validateJobSignal(String jobId,
                                           String signal,
                                           Map<String,String> updatedVariables)
                                    throws UnknownJobException,
                                           NotConnectedException,
                                           PermissionException,
                                           SignalApiException,
                                           JobValidationException
```
    Description copied from interface: Scheduler
    
    Validate the given signal's updated variables
    
    Specified by:
    
    validateJobSignal in interface Scheduler
    
    Parameters:
    
    jobId - id of the job
    
    signal - signal name
    
    updatedVariables - the updated variables of the signal
    
    Returns:
    
    the list of signal input values
    
    Throws:
    
    UnknownJobException - if the job does not exist.
    
    NotConnectedException - if you are not authenticated.
    
    PermissionException - if you can't access this particular job.
    
    SignalApiException - errors related to the signal api
    
    JobValidationException
  - getStatHistory
```
public String getStatHistory(String mbeanName,
                             String range,
                             String[] dataSources,
                             String function)
```
  - checkJobsPermissionMethods
```
public Map<String,Map<String,Boolean>> checkJobsPermissionMethods(List<String> jobIds,
                                                                  List<String> methods)
                                                           throws NotConnectedException,
                                                                  UnknownJobException
```
    Description copied from interface: Scheduler
    
    Returns a map containing pairs that represent the job id as key and a map as value containing the method name and true/false if the user has permission for the jobId and method
    
    Specified by:
    
    checkJobsPermissionMethods in interface Scheduler
    
    Parameters:
    
    jobIds - a list of job ids
    
    methods - a list of methods
    
    Returns:
    
    a map containing job ids as key and a map as value representing methods and true/false
    
    Throws:
    
    NotConnectedException - if the user is not authenticated.
    
    UnknownJobException - if the job does not exist.
  - addExternalEndpointUrl
```
public void addExternalEndpointUrl(String jobId,
                                   String endpointName,
                                   String externalEndpointUrl,
                                   String endpointIconUri)
                            throws NotConnectedException,
                                   PermissionException,
                                   UnknownJobException
```
    Description copied from interface: Scheduler
    
    Add an external endpoint url to a job. The job must be alive and not terminated, otherwise an UnknownJobException will be thrown
    
    Specified by:
    
    addExternalEndpointUrl in interface Scheduler
    
    Parameters:
    
    jobId - id of the job
    
    endpointName - the name of the endpoint
    
    externalEndpointUrl - the external endpoint url to add to the job endpoint list
    
    endpointIconUri - uri of the icon associated with the endpoint. If this parameter is null, the workflow icon will be used.
    
    Throws:
    
    NotConnectedException - if you are not authenticated.
    
    PermissionException - if you can't access this particular job.
    
    UnknownJobException - if the job does not exist or is terminated.
  - removeExternalEndpointUrl
```
public void removeExternalEndpointUrl(String jobId,
                                      String endpointName)
                               throws NotConnectedException,
                                      PermissionException,
                                      UnknownJobException
```
    Description copied from interface: Scheduler
    
    Remove an external endpoint url from a job. The job must be alive and not terminated, otherwise an UnknownJobException will be thrown
    
    Specified by:
    
    removeExternalEndpointUrl in interface Scheduler
    
    Parameters:
    
    jobId - id of the job
    
    endpointName - name of the external endpoint url to remove
    
    Throws:
    
    NotConnectedException - if you are not authenticated.
    
    PermissionException - if you can't access this particular job.
    
    UnknownJobException - if the job does not exist or is terminated.
  - getLabels
```
public List<JobLabelInfo> getLabels()
                             throws NotConnectedException,
                                    PermissionException
```
    Description copied from interface: Scheduler
    
    Gets all labels.
    
    Specified by:
    
    getLabels in interface Scheduler
    
    Returns:
    
    a list of labels
    
    Throws:
    
    NotConnectedException - if you are not authenticated.
    
    PermissionException - if you have not enough permission to access this method.
  - createLabels
```
public List<JobLabelInfo> createLabels(List<String> labels)
                                throws NotConnectedException,
                                       PermissionException,
                                       LabelConflictException,
                                       LabelValidationException
```
    Description copied from interface: Scheduler
    
    Creates new labels
    
    Specified by:
    
    createLabels in interface Scheduler
    
    Throws:
    
    NotConnectedException - if you are not authenticated.
    
    PermissionException - if you have not enough permission to access this method.
    
    LabelConflictException - if the given labels already exist.
    
    LabelValidationException
  - setLabels
```
public List<JobLabelInfo> setLabels(List<String> labels)
                             throws NotConnectedException,
                                    PermissionException,
                                    LabelValidationException
```
    Description copied from interface: Scheduler
    
    Sets the list of labels.
    
    Specified by:
    
    setLabels in interface Scheduler
    
    Throws:
    
    NotConnectedException - if you are not authenticated.
    
    PermissionException - if you have not enough permission to access this method.
    
    LabelValidationException
  - updateLabel
```
public JobLabelInfo updateLabel(String labelId,
                                String newLabel)
                         throws NotConnectedException,
                                PermissionException,
                                LabelConflictException,
                                LabelNotFoundException,
                                LabelValidationException
```
    Description copied from interface: Scheduler
    
    Update the given label
    
    Specified by:
    
    updateLabel in interface Scheduler
    
    Throws:
    
    NotConnectedException - if you are not authenticated.
    
    PermissionException - if you have not enough permission to access this method.
    
    LabelConflictException - if the new given labels name already exist.
    
    LabelNotFoundException - if the given label id is not found.
    
    LabelValidationException
  - deleteLabel
```
public void deleteLabel(String labelId)
                 throws NotConnectedException,
                        PermissionException,
                        LabelNotFoundException
```
    Description copied from interface: Scheduler
    
    Remove the given label
    
    Specified by:
    
    deleteLabel in interface Scheduler
    
    Throws:
    
    NotConnectedException - if you are not authenticated.
    
    PermissionException - if you have not enough permission to access this method.
    
    LabelNotFoundException - if the given label id is not found.
  - setLabelOnJobs
```
public void setLabelOnJobs(String labelId,
                           List<String> jobIds)
                    throws NotConnectedException,
                           PermissionException,
                           LabelNotFoundException,
                           UnknownJobException
```
    Description copied from interface: Scheduler
    
    Sets label on jobs
    
    Specified by:
    
    setLabelOnJobs in interface Scheduler
    
    Throws:
    
    NotConnectedException - if you are not authenticated.
    
    PermissionException - if you have not enough permission to access this method.
    
    LabelNotFoundException - if the given label id is not found
    
    UnknownJobException
  - removeJobLabels
```
public void removeJobLabels(List<String> jobIds)
                     throws NotConnectedException,
                            PermissionException,
                            UnknownJobException
```
    Description copied from interface: Scheduler
    
    Removes label from jobs
    
    Specified by:
    
    removeJobLabels in interface Scheduler
    
    Throws:
    
    NotConnectedException - if you are not authenticated.
    
    PermissionException - if you have not enough permission to access this method.
    
    UnknownJobException
  - updateLogo
```
public void updateLogo(byte[] image)
                throws NotConnectedException,
                       PermissionException,
                       ImageValidationException
```
    Description copied from interface: Scheduler
    
    Updates the logo on all portals
    
    Specified by:
    
    updateLogo in interface Scheduler
    
    Throws:
    
    NotConnectedException - if you are not authenticated.
    
    PermissionException - if you have not enough permission to access this method.
    
    ImageValidationException
  - waitForJobFinished
```
public void waitForJobFinished(JobId jobId,
                               Long timeout)
                        throws PermissionException,
                               NotConnectedException,
                               InterruptedException
```
    Throws:
    
    PermissionException
    
    NotConnectedException
    
    InterruptedException
  - schedulerStateUpdatedEvent
```
public void schedulerStateUpdatedEvent(SchedulerEvent eventType)
```
    Description copied from interface: SchedulerEventListener
    
    Invoked each time a scheduler event occurs.
    Scheduler events are stopped,started, paused, frozen, etc.
    
    Specified by:
    
    schedulerStateUpdatedEvent in interface SchedulerEventListener
    
    Parameters:
    
    eventType - the type of the event received.
  - jobSubmittedEvent
```
public void jobSubmittedEvent(JobState job)
```
    Description copied from interface: SchedulerEventListener
    
    Invoked each time a new job has been submitted to the Scheduler and validated.
    
    Specified by:
    
    jobSubmittedEvent in interface SchedulerEventListener
    
    Parameters:
    
    job - the newly submitted job.
  - jobStateUpdatedEvent
```
public void jobStateUpdatedEvent(NotificationData<JobInfo> notification)
```
    Description copied from interface: SchedulerEventListener
    
    Invoked each time the state of a job has changed.
    If you want to maintain an up to date list of jobs, just use the JobState.update(org.ow2.proactive.scheduler.common.job.JobInfo) method to update the content of your job.
    
    Specified by:
    
    jobStateUpdatedEvent in interface SchedulerEventListener
    
    Parameters:
    
    notification - the data composed of the type of the event and the information that have change in the job.
  - jobUpdatedFullDataEvent
```
public void jobUpdatedFullDataEvent(JobState job)
```
    Description copied from interface: SchedulerEventListener
    
    Invoked each time the state of a job has changed and each time a scheduler event occurs.
    
    Specified by:
    
    jobUpdatedFullDataEvent in interface SchedulerEventListener
    
    Parameters:
    
    job - the updated job.
  - taskStateUpdatedEvent
```
public void taskStateUpdatedEvent(NotificationData<TaskInfo> notification)
```
    Description copied from interface: SchedulerEventListener
    
    Invoked each time the state of a task has changed.
    In this case you can use the JobState.update(org.ow2.proactive.scheduler.common.task.TaskInfo) method to update the content of the designated task inside your job.
    
    Specified by:
    
    taskStateUpdatedEvent in interface SchedulerEventListener
    
    Parameters:
    
    notification - the data composed of the type of the event and the information that have change in the task.
  - usersUpdatedEvent
```
public void usersUpdatedEvent(NotificationData<UserIdentification> notification)
```
    Description copied from interface: SchedulerEventListener
    
    Invoked each time something change about users.
    
    Specified by:
    
    usersUpdatedEvent in interface SchedulerEventListener
    
    Parameters:
    
    notification - the data composed of the type of the event and the data linked to the change.

Class SchedulerProxyUserInterface

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

uischeduler

mbeaninfoviewer

logger

Constructor Detail

SchedulerProxyUserInterface

Method Detail

getActiveInstance

init

init

init

addEventListener

disconnect

isConnected

getCurrentPolicy

getJobsToSchedule

getTasksToSchedule

renewSession

removeEventListener

submit

submit

reSubmit

changeJobPriority

getJobResult

getUserSpaceURIs

getGlobalSpaceURIs

getJobResult

getTaskResult

getTaskResult

getTaskResultsByTag

getTaskResultsByTag

getTaskResultFromIncarnation

getTaskResultAllIncarnations

getTaskResultAllIncarnations

getTaskResultFromIncarnation

killTask

restartTask

preemptTask

killTask

restartTask

finishInErrorTask

restartInErrorTask

preemptTask

enableRemoteVisualization

registerService

detachService

killJob

listenJobLogs

pauseJob

removeJob

removeJobs

removeJobs

resumeJob

changeJobPriority

getStatus

killJob

killJobs

pauseJob

restartAllInErrorTasks

removeJob

resumeJob

addEventListener

getJobState

listenJobLogs

changePolicy

reloadPolicyConfiguration

freeze

getJobState

getTaskState

getState

kill

linkResourceManager

pause

resume

shutdown