RestSmartProxyImpl (scheduling 13.1.0-SNAPSHOT API)

java.lang.Object
- org.ow2.proactive.scheduler.smartproxy.common.AbstractSmartProxy<RestJobTrackerImpl>
- - org.ow2.proactive_grid_cloud_portal.smartproxy.RestSmartProxyImpl

All Implemented Interfaces:

ServiceUsingPermission, Scheduler, SchedulerEventListener, ThirdPartyCredentials, SchedulerUsage, DisconnectionAwareSchedulerEventListener, ISchedulerClient
```
public class RestSmartProxyImpl
extends AbstractSmartProxy<RestJobTrackerImpl>
implements ISchedulerClient, SchedulerEventListener, DisconnectionAwareSchedulerEventListener
```
Smart proxy implementation that relies on the REST API for communicating with dataspaces and websockets to push notifications to clients.
Any instance of this class must be initialized by calling the ISchedulerClient.init(ConnectionInfo) method before executing any subsequent method. Not respecting this rule may lead to an NPE or an unexpected behaviour.

Field Summary
- Fields inherited from class org.ow2.proactive.scheduler.smartproxy.common.AbstractSmartProxy
  configuredEvents, connectionInfo, eventListeners, GENERIC_INFO_INPUT_FOLDER_PROPERTY_NAME, GENERIC_INFO_OUTPUT_FOLDER_PROPERTY_NAME, GENERIC_INFO_PULL_URL_PROPERTY_NAME, GENERIC_INFO_PUSH_URL_PROPERTY_NAME, jobTracker, MAX_NB_OF_DATA_TRANSFER_THREADS, PROXY_SCHED_EVENTS, terminated, terminating, threadPool

Constructor Summary

Constructors
Constructor and Description

RestSmartProxyImpl()

Constructors
Constructor and Description
`RestSmartProxyImpl()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected ISchedulerClient`	`_getScheduler()` Returns a proxy instance to the Scheduler.
`void`	`addEventListener(SchedulerEventListenerExtended listener, boolean myEventsOnly, SchedulerEvent... events)`
`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
`boolean`	`changeStartAt(JobId jobId, String startAt)` Change the START_AT generic information at job level and reset the scheduledAt at task level
`boolean`	`checkJobPermissionMethod(String 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
`boolean`	`checkPermission(String method)` Checks if the current user is allowed to execute the provided method
`protected void`	`createFolder(String fUri)`
`boolean`	`deleteFile(String space, String pathname)` Deletes the specified file from the server.
`void`	`detachService(String jobId, int serviceInstanceid)` Detach a cloud automation service previously associated with the given job
`void`	`disconnect()` Disconnect from the scheduler
`protected void`	`downloadTaskOutputFiles(AwaitedJob awaitedjob, String jobId, String taskName, String localFolder)` Pull the output files of the given task from the pull_url either to the localFolder defined for the job or to the localFolder specified as argument, if it is not null.
`void`	`enableRemoteVisualization(String jobId, String taskName, String connectionString)` Enable Remote visualization for the given job and task
`boolean`	`finishInErrorTask(String jobId, String taskName)`
`ConnectionInfo`	`getConnectionInfo()` Returns the connection info, if initialized previously
`String`	`getCurrentPolicy()` Return the name of the current Policy
`String`	`getCurrentUser()` Returns the user currently connected
`UserData`	`getCurrentUserData()` Returns the user data object associated with the user currently connected
`List<String>`	`getGlobalSpaceURIs()` Returns the GLOBAL DataSpace URI available to all users
`String`	`getJobContent(JobId jobId)`
`JobInfo`	`getJobInfo(String jobId)` Retrieve a job info by it id.
`Map<Long,Map<String,Serializable>>`	`getJobResultMaps(List<String> jobsId)` Return result maps associated with multiple jobs
`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)
`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<String,Object>`	`getSchedulerProperties()` Returns the scheduler properties associated with the user currently connected
`String`	`getSession()` Retrieves the current session identifier, or null if the session was not initialized yet.
`Subject`	`getSubject()` Returns the current user JaaS subject
`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(String jobId, String taskName)` Get the result for the given task name in the given jobId.
`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<String>`	`getUserSpaceURIs()` Returns the USER DataSpace URIs associated with the current user
`void`	`init(ConnectionInfo connectionInfo)` Connects to the scheduler
`boolean`	`isJobFinished(JobId jobId)` Returns `true`, if the scheduler has finished the execution of the specified job.
`boolean`	`isJobFinished(String jobId)` Returns `true`, if the scheduler has terminated the execution of the specified job.
`boolean`	`isTaskFinished(String jobId, String taskName)` Returns `true`, if the scheduler has finished the execution of the task.
`List<JobIdDataAndError>`	`multipleSubmitFromUrls(List<WorkflowUrlData> workflowUrlDataList)` Submit a list of jobs to the scheduler from a list of catalogRestURL, variables and generic information.
`void`	`notifyDisconnection()` notify the socket disconnection
`void`	`pullFile(String space, String pathname, String outputFile)` Retrieves the specified file from the server.
`boolean`	`pushFile(String spacename, String pathname, String filename, String file)` Transfers the specified file from the local file system to the specified dataspace at the server
`void`	`registerAsListener()`
`void`	`registerService(String jobId, int serviceInstanceid, boolean enableActions)` Register a cloud automation service associated with the given job
`void`	`removeExternalEndpointUrl(String jobId, String endpointName)` Remove an external endpoint url from a job.
`protected void`	`removeJobIO(Job job, String pushURL, String pullURL, String newFolderName)`
`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)`
`JobId`	`reSubmit(JobId currentJobId, Map<String,String> jobVariables, Map<String,String> jobGenericInfos, String sessionId)`
`void`	`setSession(String sid)` Sets the session identifier explicitly.
`JobId`	`submit(File job)` Submit a new job to the scheduler.
`JobId`	`submit(File job, Map<String,String> variables)` Submit a new job to the scheduler with provided variables.
`JobId`	`submit(File job, Map<String,String> variables, Map<String,String> genericInfos)` Submit a new job to the scheduler with provided variables.
`JobId`	`submit(Job job)` Submit a new job to the scheduler.
`List<JobIdDataAndError>`	`submit(List<Job> jobs)` Submit multiple jobs
`JobId`	`submit(Map<String,String> genericInfos, URL job, Map<String,String> variables)` Submit a new job to the scheduler with provided variables.
`JobId`	`submit(URL job)` Submit a new job to the scheduler.
`JobId`	`submit(URL job, Map<String,String> variables)` Submit a new job to the scheduler with provided variables.
`JobId`	`submit(URL job, Map<String,String> variables, Map<String,String> headerParams)` Submit a new job to the scheduler with provided variables.
`JobId`	`submit(URL job, Map<String,String> variables, Map<String,String> genericInfos, Map<String,String> headerParams)` Submit a new job to the scheduler with provided variables.
`JobId`	`submitFromCatalog(String catalogRestURL, String calledWorkflow)` Submit a new job to the scheduler from the catalogRestURL without provided variables.
`JobId`	`submitFromCatalog(String catalogRestURL, String calledWorkflow, Map<String,String> variables)` Submit a new job to the scheduler from the catalogRestURL with provided variables.
`JobId`	`submitFromCatalog(String catalogRestURL, String calledWorkflow, Map<String,String> variables, Map<String,String> genericInfo)` Submit a new job to the scheduler from the catalogRestURL with provided variables ang generic information.
`JobId`	`submitFromCatalog(String catalogRestURL, String bucketName, String workflowName)` Submit a new job to the scheduler from the catalogRestURL without variables.
`JobId`	`submitFromCatalog(String catalogRestURL, String bucketName, String workflowName, Map<String,String> variables)` Submit a new job to the scheduler from the catalogRestURL with provided variables.
`JobId`	`submitFromCatalog(String catalogRestURL, String bucketName, String workflowName, Map<String,String> variables, Map<String,String> genericInfo)` Submit a new job to the scheduler from the catalogRestURL with provided variables.
`boolean`	`uploadInputfiles(TaskFlowJob job, String localInputFolderPath)` Push the input files of the given job from the local input folder to the location specified by PUSH_URL.
`List<JobVariable>`	`validateJobSignal(String jobId, String signal, Map<String,String> updatedVariables)` Validate the given signal's updated variables
`List<JobResult>`	`waitForAllJobs(List<String> jobIds, long timeout)` Causes the current thread to wait until the execution of all specified jobs has finished or the elapse of specified wait time.
`List<Map.Entry<String,TaskResult>>`	`waitForAllTasks(String jobId, List<String> taskNames, long timeout)` Causes the current thread to wait until all the executions of specified tasks finish or the elapse of specified amount of time.
`Map.Entry<String,JobResult>`	`waitForAnyJob(List<String> jobIds, long timeout)` Causes the current thread to wait until the execution of any job finishes or the elapse of the specified wait time.
`Map.Entry<String,TaskResult>`	`waitForAnyTask(String jobId, List<String> taskNames, long timeout)` Causes the current thread to wait until any of the specified tasks finishes or the elapse of specified amount of time.
`JobResult`	`waitForJob(JobId jobId, long timeout)` Causes the current thread to wait until the scheduler has finished the execution of the specified job or the specified amount of time has elapsed.
`JobResult`	`waitForJob(String jobId, long timeout)` Causes the current thread to wait until the scheduler has finished the execution of the specified job or the specified amount of time has elapsed.
`TaskResult`	`waitForTask(String jobId, String taskName, long timeout)` Causes the current thread to wait until the scheduler has finished executing the specified task or the elapse of specified elapse time.

Methods inherited from class org.ow2.proactive.scheduler.smartproxy.common.AbstractSmartProxy
addEventListener, addEventListener, addEventListener, changeJobPriority, changeJobPriority, changePolicy, checkInitialized, checkJobsPermissionMethods, cleanDatabase, configureEvents, createLabels, createNewFolderName, deleteLabel, freeze, getAccountUsage, getCompletedJobs, getCompletedTasks, getFilteredStatistics, getJobResult, getJobResult, getJobs, getJobServerLogs, getJobsInfoList, getJobState, getLabels, getMyAccountUsage, getState, getState, getStatus, getSubmissionModeCount, getSubmissionModeValues, getTaskResult, getTaskResultAllIncarnations, getTaskResultAllIncarnations, getTaskResultFromIncarnation, getTaskResultFromIncarnation, getTaskResultsByTag, getTaskResultsByTag, getTaskServerLogs, getTaskServerLogsByTag, getTaskState, getTopExecutionTimeWorkflows, getTopPendingTimeWorkflows, getTopWorkflowsCumulatedCoreTime, getTopWorkflowsNumberOfNodes, getTopWorkflowsWithIssues, getUsers, getUsersWithJobs, isConnected, jobStateUpdatedEvent, jobSubmittedEvent, jobUpdatedFullDataEvent, kill, killJob, killJob, killJobs, killTask, killTask, linkResourceManager, listenJobLogs, listenJobLogs, pause, pauseJob, pauseJob, preemptTask, preemptTask, prepareJobInput, prepareJobOutput, pullData, putThirdPartyCredential, reconnect, reinitializeState, reloadPolicyConfiguration, removeAwaitedTask, removeEventListener, removeEventListener, removeJob, removeJob, removeJobLabels, removeJobs, removeJobs, removeThirdPartyCredential, renewSession, restartTask, restartTask, resume, resumeJob, resumeJob, schedulerStateUpdatedEvent, setInitialized, setLabelOnJobs, setLabels, setSessionName, shutdown, start, stop, submit, submit, syncAwaitedJobs, taskStateUpdatedEvent, terminate, thirdPartyCredentialsKeySet, updateJob, updateLabel, updateTask, usersUpdatedEvent

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

Methods inherited from interface org.ow2.proactive.scheduler.common.Scheduler
addEventListener, addEventListener, changeJobPriority, changeJobPriority, changePolicy, checkJobsPermissionMethods, createLabels, deleteLabel, freeze, getCompletedJobs, getCompletedTasks, getFilteredStatistics, getJobResult, getJobResult, getJobs, getJobServerLogs, getJobsInfoList, getJobState, getLabels, getState, getState, getStatus, getSubmissionModeCount, getSubmissionModeValues, getTaskResult, getTaskResultAllIncarnations, getTaskResultAllIncarnations, getTaskResultFromIncarnation, getTaskResultFromIncarnation, getTaskResultsByTag, getTaskResultsByTag, getTaskServerLogs, getTaskServerLogsByTag, getTaskState, getTopExecutionTimeWorkflows, getTopPendingTimeWorkflows, getTopWorkflowsCumulatedCoreTime, getTopWorkflowsNumberOfNodes, getTopWorkflowsWithIssues, getUsers, getUsersWithJobs, isConnected, kill, killJob, killJob, killJobs, killTask, killTask, linkResourceManager, listenJobLogs, listenJobLogs, pause, pauseJob, pauseJob, preemptTask, preemptTask, reloadPolicyConfiguration, removeEventListener, removeJob, removeJob, removeJobLabels, removeJobs, removeJobs, renewSession, restartTask, restartTask, resume, resumeJob, resumeJob, setLabelOnJobs, setLabels, shutdown, start, stop, updateLabel

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

Methods inherited from interface org.ow2.proactive.scheduler.common.ThirdPartyCredentials
putThirdPartyCredential, removeThirdPartyCredential, thirdPartyCredentialsKeySet

Methods inherited from interface org.ow2.proactive.scheduler.common.SchedulerEventListener
jobStateUpdatedEvent, jobSubmittedEvent, jobUpdatedFullDataEvent, schedulerStateUpdatedEvent, taskStateUpdatedEvent, usersUpdatedEvent

- Constructor Detail
  - RestSmartProxyImpl
```
public RestSmartProxyImpl()
```
- Method Detail
  - init
```
public void init(ConnectionInfo connectionInfo)
```
    Description copied from class: AbstractSmartProxy
    
    Connects to the scheduler
    
    Specified by:
    
    init in interface ISchedulerClient
    
    Specified by:
    
    init in class AbstractSmartProxy<RestJobTrackerImpl>
    
    Parameters:
    
    connectionInfo - various info about the connection attempt
  - getConnectionInfo
```
public ConnectionInfo getConnectionInfo()
```
    Description copied from interface: ISchedulerClient
    
    Returns the connection info, if initialized previously
    
    Specified by:
    
    getConnectionInfo in interface ISchedulerClient
    
    Returns:
    
    the connection info
  - disconnect
```
public void disconnect()
                throws PermissionException
```
    Description copied from class: AbstractSmartProxy
    
    Disconnect from the scheduler
    
    Specified by:
    
    disconnect in interface Scheduler
    
    Specified by:
    
    disconnect in class AbstractSmartProxy<RestJobTrackerImpl>
    
    Throws:
    
    PermissionException - if you can't access this particular method.
  - 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
    
    Overrides:
    
    getCurrentPolicy in class AbstractSmartProxy<RestJobTrackerImpl>
    
    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
    
    Overrides:
    
    getJobsToSchedule in class AbstractSmartProxy<RestJobTrackerImpl>
    
    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
    
    Overrides:
    
    getTasksToSchedule in class AbstractSmartProxy<RestJobTrackerImpl>
    
    Returns:
    
    a List of eligible task descriptor.
    
    Throws:
    
    NotConnectedException
    
    PermissionException
  - _getScheduler
```
protected ISchedulerClient _getScheduler()
```
    Description copied from class: AbstractSmartProxy
    
    Returns a proxy instance to the Scheduler.
    /!\ This method must not be exposed remotely since remote calls to the proxy that is returned will fail with permission failures.
    
    Specified by:
    
    _getScheduler in class AbstractSmartProxy<RestJobTrackerImpl>
    
    Returns:
    
    a proxy instance to the Scheduler.
  - createFolder
```
protected void createFolder(String fUri)
                     throws NotConnectedException,
                            PermissionException
```
    Specified by:
    
    createFolder in class AbstractSmartProxy<RestJobTrackerImpl>
    
    Throws:
    
    NotConnectedException
    
    PermissionException
  - removeJobIO
```
protected void removeJobIO(Job job,
                           String pushURL,
                           String pullURL,
                           String newFolderName)
```
    Specified by:
    
    removeJobIO in class AbstractSmartProxy<RestJobTrackerImpl>
  - 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
  - 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
    
    Specified by:
    
    submit in class AbstractSmartProxy<RestJobTrackerImpl>
    
    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
    
    Specified by:
    
    submit in class AbstractSmartProxy<RestJobTrackerImpl>
    
    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
  - submit
```
public JobId submit(File job)
             throws NotConnectedException,
                    PermissionException,
                    SubmissionClosedException,
                    JobCreationException
```
    Description copied from interface: ISchedulerClient
    
    Submit a new job to the scheduler.
    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.
    
    Specified by:
    
    submit in interface ISchedulerClient
    
    Parameters:
    
    job - a job provided as a local File
    
    Returns:
    
    the generated new job ID.
    
    Throws:
    
    NotConnectedException
    
    PermissionException
    
    SubmissionClosedException
    
    JobCreationException
  - submit
```
public JobId submit(File job,
                    Map<String,String> variables)
             throws NotConnectedException,
                    PermissionException,
                    SubmissionClosedException,
                    JobCreationException
```
    Description copied from interface: ISchedulerClient
    
    Submit a new job to the scheduler with provided variables.
    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.
    
    Specified by:
    
    submit in interface ISchedulerClient
    
    Parameters:
    
    job - a job provided as a local File
    
    variables - job variables to use during the job execution
    
    Returns:
    
    the generated new job ID.
    
    Throws:
    
    NotConnectedException
    
    PermissionException
    
    SubmissionClosedException
    
    JobCreationException
  - submit
```
public JobId submit(File job,
                    Map<String,String> variables,
                    Map<String,String> genericInfos)
             throws NotConnectedException,
                    PermissionException,
                    SubmissionClosedException,
                    JobCreationException
```
    Description copied from interface: ISchedulerClient
    
    Submit a new job to the scheduler with provided variables.
    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.
    
    Specified by:
    
    submit in interface ISchedulerClient
    
    Parameters:
    
    job - a job provided as a local File
    
    variables - job variables to use during the job execution
    
    genericInfos - map with generic informations
    
    Returns:
    
    the generated new job ID.
    
    Throws:
    
    NotConnectedException
    
    PermissionException
    
    SubmissionClosedException
    
    JobCreationException
  - submit
```
public JobId submit(URL job)
             throws NotConnectedException,
                    PermissionException,
                    SubmissionClosedException,
                    JobCreationException
```
    Description copied from interface: ISchedulerClient
    
    Submit a new job to the scheduler.
    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.
    
    Specified by:
    
    submit in interface ISchedulerClient
    
    Parameters:
    
    job - a job provided as a url
    
    Returns:
    
    the generated new job ID.
    
    Throws:
    
    NotConnectedException
    
    PermissionException
    
    SubmissionClosedException
    
    JobCreationException
  - submit
```
public JobId submit(URL job,
                    Map<String,String> variables)
             throws NotConnectedException,
                    PermissionException,
                    SubmissionClosedException,
                    JobCreationException
```
    Description copied from interface: ISchedulerClient
    
    Submit a new job to the scheduler with provided variables.
    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.
    
    Specified by:
    
    submit in interface ISchedulerClient
    
    Parameters:
    
    job - a job provided as a url
    
    variables - job variables to use during the job execution
    
    Returns:
    
    the generated new job ID.
    
    Throws:
    
    NotConnectedException
    
    PermissionException
    
    SubmissionClosedException
    
    JobCreationException
  - submit
```
public JobId submit(URL job,
                    Map<String,String> variables,
                    Map<String,String> headerParams)
             throws NotConnectedException,
                    PermissionException,
                    SubmissionClosedException,
                    JobCreationException
```
    Description copied from interface: ISchedulerClient
    
    Submit a new job to the scheduler with provided variables.
    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.
    
    Specified by:
    
    submit in interface ISchedulerClient
    
    Parameters:
    
    job - a job provided as a url
    
    variables - job variables to use during the job execution
    
    headerParams - map with request header parameters
    
    Returns:
    
    the generated new job ID.
    
    Throws:
    
    NotConnectedException
    
    PermissionException
    
    SubmissionClosedException
    
    JobCreationException
  - submit
```
public JobId submit(URL job,
                    Map<String,String> variables,
                    Map<String,String> genericInfos,
                    Map<String,String> headerParams)
             throws NotConnectedException,
                    PermissionException,
                    SubmissionClosedException,
                    JobCreationException
```
    Description copied from interface: ISchedulerClient
    
    Submit a new job to the scheduler with provided variables.
    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.
    
    Specified by:
    
    submit in interface ISchedulerClient
    
    Parameters:
    
    job - a job provided as a url
    
    variables - job variables to use during the job execution
    
    genericInfos - map with generic informations
    
    headerParams - map with request header parameters
    
    Returns:
    
    the generated new job ID.
    
    Throws:
    
    NotConnectedException
    
    PermissionException
    
    SubmissionClosedException
    
    JobCreationException
  - submit
```
public JobId submit(Map<String,String> genericInfos,
                    URL job,
                    Map<String,String> variables)
             throws NotConnectedException,
                    PermissionException,
                    SubmissionClosedException,
                    JobCreationException
```
    Description copied from interface: ISchedulerClient
    
    Submit a new job to the scheduler with provided variables.
    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.
    
    Specified by:
    
    submit in interface ISchedulerClient
    
    Parameters:
    
    genericInfos - map with generic informations
    
    job - a job provided as a url
    
    variables - job variables to use during the job execution
    
    Returns:
    
    the generated new job ID.
    
    Throws:
    
    NotConnectedException
    
    PermissionException
    
    SubmissionClosedException
    
    JobCreationException
  - submitFromCatalog
```
public JobId submitFromCatalog(String catalogRestURL,
                               String bucketName,
                               String workflowName)
                        throws NotConnectedException,
                               PermissionException,
                               SubmissionClosedException,
                               JobCreationException
```
    Description copied from interface: ISchedulerClient
    
    Submit a new job to the scheduler from the catalogRestURL without variables.
    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.
    
    Specified by:
    
    submitFromCatalog in interface ISchedulerClient
    
    Returns:
    
    Throws:
    
    NotConnectedException
    
    PermissionException
    
    SubmissionClosedException
    
    JobCreationException
  - submitFromCatalog
```
public JobId submitFromCatalog(String catalogRestURL,
                               String bucketName,
                               String workflowName,
                               Map<String,String> variables)
                        throws NotConnectedException,
                               PermissionException,
                               SubmissionClosedException,
                               JobCreationException
```
    Description copied from interface: ISchedulerClient
    
    Submit a new job to the scheduler from the catalogRestURL with provided variables.
    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.
    
    Specified by:
    
    submitFromCatalog in interface ISchedulerClient
    
    Returns:
    
    Throws:
    
    NotConnectedException
    
    PermissionException
    
    SubmissionClosedException
    
    JobCreationException
  - submitFromCatalog
```
public JobId submitFromCatalog(String catalogRestURL,
                               String bucketName,
                               String workflowName,
                               Map<String,String> variables,
                               Map<String,String> genericInfo)
                        throws NotConnectedException,
                               PermissionException,
                               SubmissionClosedException,
                               JobCreationException
```
    Description copied from interface: ISchedulerClient
    
    Submit a new job to the scheduler from the catalogRestURL with provided variables.
    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.
    
    Specified by:
    
    submitFromCatalog in interface ISchedulerClient
    
    genericInfo - map with generic information
    
    Returns:
    
    Throws:
    
    NotConnectedException
    
    PermissionException
    
    SubmissionClosedException
    
    JobCreationException
  - submitFromCatalog
```
public JobId submitFromCatalog(String catalogRestURL,
                               String calledWorkflow)
                        throws NotConnectedException,
                               PermissionException,
                               SubmissionClosedException,
                               JobCreationException
```
    Description copied from interface: ISchedulerClient
    
    Submit a new job to the scheduler from the catalogRestURL without provided variables.
    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.
    
    Specified by:
    
    submitFromCatalog in interface ISchedulerClient
    
    Returns:
    
    Throws:
    
    NotConnectedException
    
    PermissionException
    
    SubmissionClosedException
    
    JobCreationException
  - submitFromCatalog
```
public JobId submitFromCatalog(String catalogRestURL,
                               String calledWorkflow,
                               Map<String,String> variables)
                        throws NotConnectedException,
                               PermissionException,
                               SubmissionClosedException,
                               JobCreationException
```
    Description copied from interface: ISchedulerClient
    
    Submit a new job to the scheduler from the catalogRestURL with provided variables.
    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.
    
    Specified by:
    
    submitFromCatalog in interface ISchedulerClient
    
    Returns:
    
    Throws:
    
    NotConnectedException
    
    PermissionException
    
    SubmissionClosedException
    
    JobCreationException
  - submitFromCatalog
```
public JobId submitFromCatalog(String catalogRestURL,
                               String calledWorkflow,
                               Map<String,String> variables,
                               Map<String,String> genericInfo)
                        throws NotConnectedException,
                               PermissionException,
                               SubmissionClosedException,
                               JobCreationException
```
    Description copied from interface: ISchedulerClient
    
    Submit a new job to the scheduler from the catalogRestURL with provided variables ang generic information.
    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.
    
    Specified by:
    
    submitFromCatalog in interface ISchedulerClient
    
    genericInfo - map with generic information
    
    Returns:
    
    Throws:
    
    NotConnectedException
    
    PermissionException
    
    SubmissionClosedException
    
    JobCreationException
  - multipleSubmitFromUrls
```
public List<JobIdDataAndError> multipleSubmitFromUrls(List<WorkflowUrlData> workflowUrlDataList)
                                               throws NotConnectedException,
                                                      PermissionException
```
    Description copied from interface: ISchedulerClient
    
    Submit a list of jobs to the scheduler from a list of catalogRestURL, variables and generic information.
    
    Specified by:
    
    multipleSubmitFromUrls in interface ISchedulerClient
    
    Parameters:
    
    workflowUrlDataList - list of objects containing workflow submission data
    
    Returns:
    
    a list of job ids of the submitted jobs and errors when jobs could not be submitted
    
    Throws:
    
    NotConnectedException
    
    PermissionException
  - 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
    
    Specified by:
    
    getJobState in class AbstractSmartProxy<RestJobTrackerImpl>
    
    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.
  - 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
    
    Specified by:
    
    getTaskResult in class AbstractSmartProxy<RestJobTrackerImpl>
    
    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.
  - 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
  - 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.
  - 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
    
    Specified by:
    
    getGlobalSpaceURIs in class AbstractSmartProxy<RestJobTrackerImpl>
    
    Returns:
    
    GLOBAL Space URIs (one element for each available protocol)
    
    Throws:
    
    NotConnectedException - if you are not authenticated.
    
    PermissionException
  - 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
    
    Specified by:
    
    getUserSpaceURIs in class AbstractSmartProxy<RestJobTrackerImpl>
    
    Returns:
    
    USER Space URIs (one element for each available protocol)
    
    Throws:
    
    NotConnectedException - if you are not authenticated.
    
    PermissionException
  - addEventListener
```
public void addEventListener(SchedulerEventListenerExtended listener,
                             boolean myEventsOnly,
                             SchedulerEvent... events)
                      throws NotConnectedException,
                             PermissionException
```
    Specified by:
    
    addEventListener in class AbstractSmartProxy<RestJobTrackerImpl>
    
    Throws:
    
    NotConnectedException
    
    PermissionException
  - uploadInputfiles
```
public boolean uploadInputfiles(TaskFlowJob job,
                                String localInputFolderPath)
                         throws NotConnectedException,
                                PermissionException
```
    Description copied from class: AbstractSmartProxy
    
    Push the input files of the given job from the local input folder to the location specified by PUSH_URL.
    
    Specified by:
    
    uploadInputfiles in class AbstractSmartProxy<RestJobTrackerImpl>
    
    Parameters:
    
    job - job to push data for
    
    localInputFolderPath - utFolderPath local input folder
    
    Returns:
    
    true if all input files are uploaded to the location specified by the PUSH_URL.
    
    Throws:
    
    NotConnectedException
    
    PermissionException
    
    See Also:
    
    AbstractSmartProxy.uploadInputfiles(TaskFlowJob, String)
  - downloadTaskOutputFiles
```
protected void downloadTaskOutputFiles(AwaitedJob awaitedjob,
                                       String jobId,
                                       String taskName,
                                       String localFolder)
                                throws NotConnectedException,
                                       PermissionException
```
    Description copied from class: AbstractSmartProxy
    
    Pull the output files of the given task from the pull_url either to the localFolder defined for the job or to the localFolder specified as argument, if it is not null. The call to the method pullData is triggered by the user. If the job is configured to be handled asynchronously, call to this method will trigger a RuntimeException.
    
    Specified by:
    
    downloadTaskOutputFiles in class AbstractSmartProxy<RestJobTrackerImpl>
    
    jobId - job to pull data for
    
    taskName - name of the task
    
    localFolder - local output folder, if not null, it overrides the folder specified as output folder for the job
    
    Throws:
    
    NotConnectedException
    
    PermissionException
  - registerAsListener
```
public void registerAsListener()
                        throws NotConnectedException,
                               PermissionException
```
    Specified by:
    
    registerAsListener in class AbstractSmartProxy<RestJobTrackerImpl>
    
    Throws:
    
    NotConnectedException
    
    PermissionException
  - setSession
```
public void setSession(String sid)
```
    Description copied from interface: ISchedulerClient
    
    Sets the session identifier explicitly. This might run on an uninitialized client.
    
    Specified by:
    
    setSession in interface ISchedulerClient
    
    Parameters:
    
    sid - session identifier
  - getSession
```
public String getSession()
```
    Description copied from interface: ISchedulerClient
    
    Retrieves the current session identifier, or null if the session was not initialized yet.
    
    Specified by:
    
    getSession in interface ISchedulerClient
    
    Returns:
    
    the current session identifier if initialize, null otherwise
  - isJobFinished
```
public boolean isJobFinished(JobId jobId)
                      throws NotConnectedException,
                             UnknownJobException,
                             PermissionException
```
    Description copied from interface: ISchedulerClient
    
    Returns true, if the scheduler has finished the execution of the specified job.
    
    Specified by:
    
    isJobFinished in interface ISchedulerClient
    
    Parameters:
    
    jobId - the job identifier object
    
    Returns:
    
    true if the scheduler has finished the execution of the job
    
    Throws:
    
    NotConnectedException - if the client is not logged in or the session has expired
    
    UnknownJobException - if the job identifier is invalid
    
    PermissionException - if the user does not have permission to view the state of the specified job
  - isJobFinished
```
public boolean isJobFinished(String jobId)
                      throws NotConnectedException,
                             UnknownJobException,
                             PermissionException
```
    Description copied from interface: ISchedulerClient
    
    Returns true, if the scheduler has terminated the execution of the specified job.
    
    Specified by:
    
    isJobFinished in interface ISchedulerClient
    
    Parameters:
    
    jobId - the job identifier string
    
    Throws:
    
    NotConnectedException
    
    UnknownJobException
    
    PermissionException
    
    See Also:
    
    ISchedulerClient.isJobFinished(JobId)
  - waitForJob
```
public JobResult waitForJob(JobId jobId,
                            long timeout)
                     throws NotConnectedException,
                            UnknownJobException,
                            PermissionException,
                            TimeoutException
```
    Description copied from interface: ISchedulerClient
    
    Causes the current thread to wait until the scheduler has finished the execution of the specified job or the specified amount of time has elapsed.
    If the job execution finishes before the elapse of wait time, the result of the job is returned. Otherwise a timeout exception is thrown.
    
    Specified by:
    
    waitForJob in interface ISchedulerClient
    
    Parameters:
    
    jobId - the job identifier object
    
    timeout - the maximum amount of time to wait
    
    Returns:
    
    the result associated to the job which has been executed
    
    Throws:
    
    NotConnectedException - if the client is not logged in or the session has expired
    
    UnknownJobException - if the job identifier is invalid
    
    PermissionException - if the user does not have permission to view the state of the specified job
    
    TimeoutException - if the job execution does not finish before the elapse of wait time
  - waitForJob
```
public JobResult waitForJob(String jobId,
                            long timeout)
                     throws NotConnectedException,
                            UnknownJobException,
                            PermissionException,
                            TimeoutException
```
    Description copied from interface: ISchedulerClient
    
    Causes the current thread to wait until the scheduler has finished the execution of the specified job or the specified amount of time has elapsed.
    If the job execution finishes before the elapse of wait time, the result of the job is returned. Otherwise a timeout exception is thrown.
    
    Specified by:
    
    waitForJob in interface ISchedulerClient
    
    Parameters:
    
    jobId - the job identifier string
    
    Throws:
    
    NotConnectedException
    
    UnknownJobException
    
    PermissionException
    
    TimeoutException
    
    See Also:
    
    ISchedulerClient.waitForJob(JobId, long)
  - isTaskFinished
```
public boolean isTaskFinished(String jobId,
                              String taskName)
                       throws UnknownJobException,
                              NotConnectedException,
                              PermissionException,
                              UnknownTaskException
```
    Description copied from interface: ISchedulerClient
    
    Returns true, if the scheduler has finished the execution of the task.
    
    Specified by:
    
    isTaskFinished in interface ISchedulerClient
    
    Parameters:
    
    jobId - the string identifier of the job to which the task is belong
    
    taskName - the task name
    
    Returns:
    
    the task result
    
    Throws:
    
    UnknownJobException - if the job identifier is invalid
    
    NotConnectedException - if the client is not logged in or the session has expired
    
    PermissionException - if the user does not have permission to view the state of the task
    
    UnknownTaskException - if the task name is invalid
  - waitForTask
```
public TaskResult waitForTask(String jobId,
                              String taskName,
                              long timeout)
                       throws UnknownJobException,
                              NotConnectedException,
                              PermissionException,
                              UnknownTaskException,
                              TimeoutException
```
    Description copied from interface: ISchedulerClient
    
    Causes the current thread to wait until the scheduler has finished executing the specified task or the elapse of specified elapse time.
    If the task execution finishes before the elapse of wait time, the result of the task is returned. Otherwise a timeout exception is thrown.
    
    Specified by:
    
    waitForTask in interface ISchedulerClient
    
    Parameters:
    
    jobId - the string identifier of the job to which the task is belong
    
    taskName - the task name
    
    Returns:
    
    the task result
    
    Throws:
    
    UnknownJobException - if the job identifier is invalid
    
    NotConnectedException - if the client is not logged in or the session has expired
    
    PermissionException - if the user does not have permission to view the state of task
    
    UnknownTaskException - if the task name is invalid
    
    TimeoutException - if the task execution does not finish before the elapse of wait time
  - waitForAllJobs
```
public List<JobResult> waitForAllJobs(List<String> jobIds,
                                      long timeout)
                               throws NotConnectedException,
                                      UnknownJobException,
                                      PermissionException,
                                      TimeoutException
```
    Description copied from interface: ISchedulerClient
    
    Causes the current thread to wait until the execution of all specified jobs has finished or the elapse of specified wait time.
    Returns a list of job results, if the execution of all jobs specified finishes before the elapse of the wait time. Otherwise a timeout exception is thrown.
    
    Specified by:
    
    waitForAllJobs in interface ISchedulerClient
    
    Parameters:
    
    jobIds - the list of job identifier stings
    
    timeout - the maximum amount of wait time
    
    Returns:
    
    a list of job results
    
    Throws:
    
    NotConnectedException - if the client is not logged in or the session has expired
    
    UnknownJobException - if one of jobs specified is invalid
    
    PermissionException - if the user does not have permission to view the state of one of the specified jobs
    
    TimeoutException - if the execution of all jobs specified does not finish before the elapse of specified wait time
  - waitForAnyJob
```
public Map.Entry<String,JobResult> waitForAnyJob(List<String> jobIds,
                                                 long timeout)
                                          throws NotConnectedException,
                                                 UnknownJobException,
                                                 PermissionException,
                                                 TimeoutException
```
    Description copied from interface: ISchedulerClient
    
    Causes the current thread to wait until the execution of any job finishes or the elapse of the specified wait time.
    Returns the string identifier and result of the finished job, if any of the execution of the jobs finishes before the elapse of wait time. Otherwise a timeout exception is thrown.
    
    Specified by:
    
    waitForAnyJob in interface ISchedulerClient
    
    Parameters:
    
    jobIds - the list of job identifier strings
    
    timeout - the maximum amount of wait time
    
    Returns:
    
    the identifier and the result of a finished job
    
    Throws:
    
    NotConnectedException - if the client is not logged in or the session has expired
    
    UnknownJobException - if only of the job identifiers is invalid
    
    PermissionException - if the user does not have permission to view the job state
    
    TimeoutException - if none of the executions of jobs finishes before the elapse of wait time
  - waitForAnyTask
```
public Map.Entry<String,TaskResult> waitForAnyTask(String jobId,
                                                   List<String> taskNames,
                                                   long timeout)
                                            throws UnknownJobException,
                                                   NotConnectedException,
                                                   PermissionException,
                                                   UnknownTaskException,
                                                   TimeoutException
```
    Description copied from interface: ISchedulerClient
    
    Causes the current thread to wait until any of the specified tasks finishes or the elapse of specified amount of time.
    Returns name and the result of a finished task. Otherwise a timeout exception is thrown.
    
    Specified by:
    
    waitForAnyTask in interface ISchedulerClient
    
    Parameters:
    
    jobId - the job identifier of the job to which the specified tasks belong
    
    taskNames - the names of the tasks
    
    timeout - the maximum amount of wait time
    
    Returns:
    
    the name and the result of a finished task
    
    Throws:
    
    UnknownJobException - if the job identifier is invalid
    
    NotConnectedException - if the client is not logged in or the session has expired
    
    PermissionException - if the user does not have permission to view the state of the tasks
    
    UnknownTaskException - if the name of a task is invalid
    
    TimeoutException - if none of the executions of tasks finish before the elapse of wait time
  - waitForAllTasks
```
public List<Map.Entry<String,TaskResult>> waitForAllTasks(String jobId,
                                                          List<String> taskNames,
                                                          long timeout)
                                                   throws UnknownJobException,
                                                          NotConnectedException,
                                                          PermissionException,
                                                          UnknownTaskException,
                                                          TimeoutException
```
    Description copied from interface: ISchedulerClient
    
    Causes the current thread to wait until all the executions of specified tasks finish or the elapse of specified amount of time.
    Returns a list of task name and task result pairs, if all the executions of specified tasks finishes before the elapse of wait time. Otherwise a timeout exception is thrown.
    
    Specified by:
    
    waitForAllTasks in interface ISchedulerClient
    
    Parameters:
    
    jobId - the identifier of the job to which all the specified tasks belong
    
    taskNames - the task names
    
    timeout - the maximum amount of wait time
    
    Returns:
    
    a list of task name and task result pairs
    
    Throws:
    
    UnknownJobException - if the job identifier is invalid
    
    NotConnectedException - if the client is not logged in or the session has expired.
    
    PermissionException - if the user does not have permission to view the state of the tasks
    
    UnknownTaskException - if a task name is invalid
    
    TimeoutException - if all the executions of the tasks do not finish before the elapse of maximum wait time
  - pushFile
```
public boolean pushFile(String spacename,
                        String pathname,
                        String filename,
                        String file)
                 throws NotConnectedException,
                        PermissionException
```
    Description copied from interface: ISchedulerClient
    
    Transfers the specified file from the local file system to the specified dataspace at the server
    
    Specified by:
    
    pushFile in interface ISchedulerClient
    
    Parameters:
    
    spacename - the dataspace name
    
    pathname - the path of the stored file with respect to the dataspace
    
    filename - the name of the stored file with respect to the dataspace
    
    file - the local file
    
    Returns:
    
    true, if the file transfer completes successfully
    
    Throws:
    
    NotConnectedException - if the client is not logged in or the session has expired
    
    PermissionException - if the user does not have permission to upload the file to the specified dataspace
  - pullFile
```
public void pullFile(String space,
                     String pathname,
                     String outputFile)
              throws NotConnectedException,
                     PermissionException
```
    Description copied from interface: ISchedulerClient
    
    Retrieves the specified file from the server.
    
    Specified by:
    
    pullFile in interface ISchedulerClient
    
    Parameters:
    
    space - the dataspace name
    
    pathname - the pathname of the file with respect the dataspace
    
    outputFile - the name of the output file
    
    Throws:
    
    NotConnectedException - if the client is not logged in or the session has expired
    
    PermissionException - if the user does not have permission to retrieve the specified file from the server
  - deleteFile
```
public boolean deleteFile(String space,
                          String pathname)
                   throws NotConnectedException,
                          PermissionException
```
    Description copied from interface: ISchedulerClient
    
    Deletes the specified file from the server.
    
    Specified by:
    
    deleteFile in interface ISchedulerClient
    
    Parameters:
    
    space - the dataspace name
    
    pathname - the pathname of the file with respect to the dataspace
    
    Returns:
    
    true if the specified file has been deleted successfully
    
    Throws:
    
    NotConnectedException - if the client is not logged in or the session has expired
    
    PermissionException - if the user does not have permission to delete the file from the server
  - 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
  - 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<String,Object> 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
  - 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.
  - notifyDisconnection
```
public void notifyDisconnection()
```
    notify the socket disconnection
    
    Specified by:
    
    notifyDisconnection in interface DisconnectionAwareSchedulerEventListener
  - 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
  - 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.

Class RestSmartProxyImpl

Field Summary

Fields inherited from class org.ow2.proactive.scheduler.smartproxy.common.AbstractSmartProxy

Constructor Summary

Method Summary

Methods inherited from class org.ow2.proactive.scheduler.smartproxy.common.AbstractSmartProxy

Methods inherited from class java.lang.Object

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

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

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

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

Constructor Detail

RestSmartProxyImpl

Method Detail

init

getConnectionInfo

disconnect

getCurrentPolicy

getJobsToSchedule

getTasksToSchedule

_getScheduler

createFolder

removeJobIO

reSubmit

submit

submit

submit

submit

submit

submit

submit

submit

submit

submit

submitFromCatalog

submitFromCatalog

submitFromCatalog

submitFromCatalog

submitFromCatalog

submitFromCatalog

multipleSubmitFromUrls

getJobState

getTaskResult

finishInErrorTask

restartInErrorTask

restartAllInErrorTasks

getGlobalSpaceURIs

getUserSpaceURIs

addEventListener

uploadInputfiles

downloadTaskOutputFiles

registerAsListener

setSession

getSession

isJobFinished

isJobFinished

waitForJob

waitForJob

isTaskFinished

waitForTask

waitForAllJobs

waitForAnyJob

waitForAnyTask

waitForAllTasks

pushFile

pullFile

deleteFile

getTaskIds

getTaskStates

getJobInfo

changeStartAt

getJobContent

getPortalConfiguration

getCurrentUser

getCurrentUserData

getSubject

getSchedulerProperties

getTaskPaginated

getTaskPaginated

getPreciousTaskResults