org.ow2.proactive.scheduler.rest

Interface ISchedulerClient

All Superinterfaces:

Scheduler, SchedulerUsage, ThirdPartyCredentials

All Known Implementing Classes:

ClientBase, RestSmartProxyImpl, SchedulerClient, SchedulerNodeClient

@PublicAPI
public interface ISchedulerClient
extends Scheduler

Scheduler interface available in the rest-client framework. It extends the default scheduler interface with new methods which can be used to transfer files or wait for jobs or tasks to finish.

Method Summary

Modifier and Type	Method and Description
boolean	deleteFile(String space, String pathname) Deletes the specified file from the server.
ConnectionInfo	getConnectionInfo() Returns the connection info, if initialized previously
String	getSession() Retrieves the current session identifier, or null if the session was not initialized yet.
void	init(ConnectionInfo connectionInfo) Initialize this instance.
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.
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	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(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.
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 interface org.ow2.proactive.scheduler.common.Scheduler

addEventListener, addEventListener, changeJobPriority, changeJobPriority, changePolicy, changeStartAt, checkJobPermissionMethod, disconnect, finishInErrorTask, freeze, getCurrentPolicy, getCurrentUser, getCurrentUserData, getGlobalSpaceURIs, getJobContent, getJobInfo, getJobResult, getJobResult, getJobs, getJobServerLogs, getJobsInfoList, getJobState, getJobState, getJobsToSchedule, getPortalConfiguration, getSchedulerProperties, getState, getState, getStatus, getTaskIds, getTaskPaginated, getTaskResult, getTaskResult, getTaskResultAllIncarnations, getTaskResultAllIncarnations, getTaskResultFromIncarnation, getTaskResultFromIncarnation, getTaskResultsByTag, getTaskResultsByTag, getTaskServerLogs, getTaskServerLogsByTag, getTaskStates, getTasksToSchedule, getUsers, getUserSpaceURIs, getUsersWithJobs, isConnected, kill, killJob, killJob, killTask, killTask, linkResourceManager, listenJobLogs, listenJobLogs, pause, pauseJob, pauseJob, preemptTask, preemptTask, reloadPolicyConfiguration, removeEventListener, removeJob, removeJob, renewSession, restartAllInErrorTasks, restartInErrorTask, restartTask, restartTask, resume, resumeJob, resumeJob, shutdown, start, stop, submit

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

getAccountUsage, getMyAccountUsage

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

putThirdPartyCredential, removeThirdPartyCredential, thirdPartyCredentialsKeySet

Method Detail

init

void init(ConnectionInfo connectionInfo)
   throws Exception

Initialize this instance.

Parameters:

connectionInfo - various info about the connection attempt

Throws:

Exception - if an error occurs during the initialization

getConnectionInfo

ConnectionInfo getConnectionInfo()

Returns the connection info, if initialized previously

Returns:

the connection info

setSession

void setSession(String sid)

Sets the session identifier explicitly. This might run on an uninitialized client.

Parameters:

sid - session identifier

getSession

String getSession()

Retrieves the current session identifier, or null if the session was not initialized yet.

Returns:

the current session identifier if initialize, null otherwise

submit

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

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.

Parameters:

job - a job provided as a local File

Returns:

the generated new job ID.

Throws:

NotConnectedException

JobCreationException

PermissionException

SubmissionClosedException

submit

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

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.

Parameters:

job - a job provided as a url

Returns:

the generated new job ID.

Throws:

NotConnectedException

JobCreationException

PermissionException

SubmissionClosedException

submit

JobId submit(URL job,
             Map<String,String> variables)
      throws NotConnectedException,
             PermissionException,
             SubmissionClosedException,
             JobCreationException

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.

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

JobCreationException

PermissionException

SubmissionClosedException

submit

JobId submit(Map<String,String> genericInfos,
             URL job,
             Map<String,String> variables)
      throws NotConnectedException,
             PermissionException,
             SubmissionClosedException,
             JobCreationException

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.

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

JobCreationException

PermissionException

SubmissionClosedException

submit

JobId submit(URL job,
             Map<String,String> variables,
             Map<String,String> headerParams)
      throws NotConnectedException,
             PermissionException,
             SubmissionClosedException,
             JobCreationException

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.

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

JobCreationException

PermissionException

SubmissionClosedException

submit

JobId submit(URL job,
             Map<String,String> variables,
             Map<String,String> genericInfos,
             Map<String,String> headerParams)
      throws NotConnectedException,
             PermissionException,
             SubmissionClosedException,
             JobCreationException

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.

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

JobCreationException

PermissionException

SubmissionClosedException

submit

JobId submit(File job,
             Map<String,String> variables)
      throws NotConnectedException,
             PermissionException,
             SubmissionClosedException,
             JobCreationException

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.

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

JobCreationException

PermissionException

SubmissionClosedException

submit

JobId submit(File job,
             Map<String,String> variables,
             Map<String,String> genericInfos)
      throws NotConnectedException,
             PermissionException,
             SubmissionClosedException,
             JobCreationException

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.

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

JobCreationException

PermissionException

SubmissionClosedException

submitFromCatalog

JobId submitFromCatalog(String catalogRestURL,
                        String bucketName,
                        String workflowName,
                        Map<String,String> variables)
                 throws NotConnectedException,
                        PermissionException,
                        SubmissionClosedException,
                        JobCreationException

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.

Parameters:

catalogRestURL -

bucketName -

workflowName -

variables -

Returns:

Throws:

NotConnectedException

PermissionException

SubmissionClosedException

JobCreationException

submitFromCatalog

JobId submitFromCatalog(String catalogRestURL,
                        String bucketName,
                        String workflowName,
                        Map<String,String> variables,
                        Map<String,String> genericInfo)
                 throws NotConnectedException,
                        PermissionException,
                        SubmissionClosedException,
                        JobCreationException

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.

Parameters:

catalogRestURL -

bucketName -

workflowName -

variables -

genericInfo - map with generic information

Returns:

Throws:

NotConnectedException

PermissionException

SubmissionClosedException

JobCreationException

submitFromCatalog

JobId submitFromCatalog(String catalogRestURL,
                        String bucketName,
                        String workflowName)
                 throws NotConnectedException,
                        PermissionException,
                        SubmissionClosedException,
                        JobCreationException

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.

Parameters:

catalogRestURL -

bucketName -

workflowName -

Returns:

Throws:

NotConnectedException

PermissionException

SubmissionClosedException

JobCreationException

submitFromCatalog

JobId submitFromCatalog(String catalogRestURL,
                        String calledWorkflow)
                 throws NotConnectedException,
                        PermissionException,
                        SubmissionClosedException,
                        JobCreationException

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.

Parameters:

catalogRestURL -

calledWorkflow -

Returns:

Throws:

NotConnectedException

PermissionException

SubmissionClosedException

JobCreationException

submitFromCatalog

JobId submitFromCatalog(String catalogRestURL,
                        String calledWorkflow,
                        Map<String,String> variables)
                 throws NotConnectedException,
                        PermissionException,
                        SubmissionClosedException,
                        JobCreationException

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.

Parameters:

catalogRestURL -

calledWorkflow -

variables -

Returns:

Throws:

NotConnectedException

PermissionException

SubmissionClosedException

JobCreationException

submitFromCatalog

JobId submitFromCatalog(String catalogRestURL,
                        String calledWorkflow,
                        Map<String,String> variables,
                        Map<String,String> genericInfo)
                 throws NotConnectedException,
                        PermissionException,
                        SubmissionClosedException,
                        JobCreationException

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.

Parameters:

catalogRestURL -

calledWorkflow -

variables -

genericInfo - map with generic information

Returns:

Throws:

NotConnectedException

PermissionException

SubmissionClosedException

JobCreationException

isJobFinished

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

Returns true, if the scheduler has finished the execution of the specified job.

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

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

Returns true, if the scheduler has terminated the execution of the specified job.

Parameters:

jobId - the job identifier string

Throws:

NotConnectedException

UnknownJobException

PermissionException

See Also:

isJobFinished(JobId)

waitForJob

JobResult waitForJob(JobId jobId,
                     long timeout)
              throws NotConnectedException,
                     UnknownJobException,
                     PermissionException,
                     TimeoutException

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.

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

JobResult waitForJob(String jobId,
                     long timeout)
              throws NotConnectedException,
                     UnknownJobException,
                     PermissionException,
                     TimeoutException

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.

Parameters:

jobId - the job identifier string

Throws:

NotConnectedException

UnknownJobException

PermissionException

TimeoutException

See Also:

waitForJob(JobId, long)

isTaskFinished

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

Returns true, if the scheduler has finished the execution of the task.

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

TaskResult waitForTask(String jobId,
                       String taskName,
                       long timeout)
                throws UnknownJobException,
                       NotConnectedException,
                       PermissionException,
                       UnknownTaskException,
                       TimeoutException

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.

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

List<JobResult> waitForAllJobs(List<String> jobIds,
                               long timeout)
                        throws NotConnectedException,
                               UnknownJobException,
                               PermissionException,
                               TimeoutException

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.

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

Map.Entry<String,JobResult> waitForAnyJob(List<String> jobIds,
                                          long timeout)
                                   throws NotConnectedException,
                                          UnknownJobException,
                                          PermissionException,
                                          TimeoutException

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.

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

Map.Entry<String,TaskResult> waitForAnyTask(String jobId,
                                            List<String> taskNames,
                                            long timeout)
                                     throws UnknownJobException,
                                            NotConnectedException,
                                            PermissionException,
                                            UnknownTaskException,
                                            TimeoutException

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.

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

List<Map.Entry<String,TaskResult>> waitForAllTasks(String jobId,
                                                   List<String> taskNames,
                                                   long timeout)
                                            throws UnknownJobException,
                                                   NotConnectedException,
                                                   PermissionException,
                                                   UnknownTaskException,
                                                   TimeoutException

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.

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

boolean pushFile(String spacename,
                 String pathname,
                 String filename,
                 String file)
          throws NotConnectedException,
                 PermissionException

Transfers the specified file from the local file system to the specified dataspace at the server

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

void pullFile(String space,
              String pathname,
              String outputFile)
       throws NotConnectedException,
              PermissionException

Retrieves the specified file from the server.

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

boolean deleteFile(String space,
                   String pathname)
            throws NotConnectedException,
                   PermissionException

Deletes the specified file from the server.

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