org.ow2.proactive.scheduler.smartproxy

Class SmartProxyImpl

java.lang.Object

org.ow2.proactive.scheduler.smartproxy.common.AbstractSmartProxy<JobTrackerImpl>

org.ow2.proactive.scheduler.smartproxy.SmartProxyImpl

All Implemented Interfaces:

Serializable, org.objectweb.proactive.Active, org.objectweb.proactive.EndActive, org.objectweb.proactive.InitActive, ServiceUsingPermission, Scheduler, SchedulerEventListener, ThirdPartyCredentials, SchedulerUsage

public class SmartProxyImpl
extends AbstractSmartProxy<JobTrackerImpl>
implements org.objectweb.proactive.InitActive, org.objectweb.proactive.EndActive, Serializable

Smart proxy implementation that relies on active objects for communicating with dataspaces and pushing notifications to clients.

This implementation assumes that:

• the client application needs to submit to the scheduler jobs which require data transfer to the execution nodes
• the input data is accessible by the client on the local file system (or on location accessible on NFS)
• the output data is to be copied to the local file system (or on location accessible on NFS)
• the local file system is not visible from the computation nodes side
• There is a location (let's call it SHARED_INPUT_LOCATION), for transferring input data, accessible from both sides, client side and computation node side. Same for output data (let's call it SHARED_OUTPUT_LOCATION). These locations could be the same. It might be a shared folder or a data server. Let´s call push_url the url used by the client application in order to push the input data to SHARED_INPUT_LOCATION. Let´s call pull_url the url used by the client application in order to pull the output data from SHARED_OUTPUT_LOCATION. The job needs to specify, as input space, an url pointing to SHARED_INPUT_LOCATION. The job needs to specify, as output space, an url pointing to SHARED_OUTPUT_LOCATION. These urls might or not be the same as push_url and pull_url.

The client application will use this Proxy for communicating with the Scheduler. This Proxy is an ActiveObject.

In order to use this object, a reference to it should be obtained via the getActiveInstance() method. One of the init methods should be called afterwards.

The client could add a Listener to this object in order to receive notifications from the Scheduler. The listener is of type SchedulerEventListenerExtended which, in addition to the notifications declared by its super type SchedulerEventListener, can be notified with events related to data transfer.

Remember this is an active object. The listener object needs to be an active or remote object (in order to avoid passing the listener through deep copy). You could use, for instance:

SchedulerEventListenerExtended myListenerRemoteReference = PARemoteObject.turnRemote( new MyEventListener()); schedProxy.addEventListener(myListenerRemoteReference);

When a listener is added by the client, no new connection will be established with the scheduler. This Proxy object broadcasts events received from the Scheduler to its own listeners. In addition, it adds events related to data transfer.

When a new job is submitted, these operations will be performed:

• A temporary folder, for this execution, is created on the SHARED_INPUT_LOCATION and the SHARED_OUTPUT_LOCATION (if SHARED_INPUT_LOCATION!=SHARED_OUTPUT_LOCATION).
• The job INPUT_SPACE and OUTPUT_SPACE urls are updated with the new created temporary folders.
• The input data is pushed, via the push_url, from the local file system, to the temporary folder
• The job is added to a list of awaited jobs, in order to pull the output data once the job is finished. This list is persisted on disk and will be restored after an application restart.
• When the job is finished, the output data is pulled form the TMP_OUTPUT_LOCATION
• The client application will be notified, via the listener, about the evolution of the submitted jobs and about data transfer operations.

Each time this object is initialized, it recovers the awaited_jobs list from the persisted file and, for each finished job, it pulls the output data from the TMP_OUTPUT_LOCATION to the local file system

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Scheduler	schedulerProxy

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
SmartProxyImpl() Deprecated. Use getActiveInstance() or getInstance()

Method Summary

Modifier and Type	Method and Description
protected Scheduler	_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	changeStartAt(List<JobId> jobIdList, String startAt) Change the START_AT generic information for multiple jobs at job level and reset the scheduledAt at task level
boolean	checkJobPermissionMethod(String jobId, String method) Check if the connected user has the permission to execute the method passed as argument
List<String>	checkJobsPermissionMethod(List<String> jobIds, String method) Check if the connected user has the permission to execute the method passed as argument
boolean	checkPermission(String method) Checks if the current user is allowed to execute the provided method
protected void	createFolder(String fUri)
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 t_name, 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
void	endActivity(org.objectweb.proactive.Body body)
boolean	finishInErrorTask(String jobId, String taskName)
static SmartProxyImpl	getActiveInstance() Returns a stub to the only active instance of the proxy (proactive singleton pattern)
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
static SmartProxyImpl	getInstance() Returns the real singleton instance of the proxy
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
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(JobId jobId, String taskName) Get the result for the given task name in the given jobId.
TaskResult	getTaskResult(String jobId, String taskName) Get the result for the given task name in the given jobId.
List<TaskResult>	getTaskResultAllIncarnations(JobId jobId, String taskName) Get the result for the given task name and all result incarnations in the given jobId.
List<TaskResult>	getTaskResultAllIncarnations(String jobId, String taskName) Get the result for the given task name and all result incarnations in the given jobId.
TaskResult	getTaskResultFromIncarnation(JobId jobId, String taskName, int inc) Get the result for the given task name and the given incarnation in the given jobId.
TaskResult	getTaskResultFromIncarnation(String jobId, String taskName, int inc) Get the result for the given task name and the given incarnation in the given jobId.
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<String>	getUserSpaceURIs() Returns the USER DataSpace URIs associated with the current user
void	init(ConnectionInfo connectionInfo) Connects to the scheduler
void	init(String url, CredData credData)
void	init(String url, Credentials credentials)
void	initActivity(org.objectweb.proactive.Body body)
void	reconnect() Reconnects this smart proxy to the scheduler
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)
JobId	submit(Job job) Submit a new job to the scheduler.
List<JobIdDataAndError>	submit(List<Job> jobs) Submit multiple jobs
void	terminateFast() This method forcefully terminates the activity of the proxy This method should not be called via a proactive stub
void	updateLogo(byte[] image) Updates the logo on all portals
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

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, getTaskResultsByTag, getTaskResultsByTag, getTaskServerLogs, getTaskServerLogsByTag, getTaskState, getTasksToSchedule, 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, 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

Field Detail

schedulerProxy

protected transient Scheduler schedulerProxy

Constructor Detail

SmartProxyImpl

public SmartProxyImpl()

Deprecated. Use getActiveInstance() or getInstance()

Empty constructor required by ProActive.

Method Detail

getActiveInstance

public static SmartProxyImpl getActiveInstance()
                                        throws org.objectweb.proactive.ActiveObjectCreationException,
                                               org.objectweb.proactive.core.node.NodeException

Returns a stub to the only active instance of the proxy (proactive singleton pattern)

Returns:

instance of the proxy

Throws:

org.objectweb.proactive.ActiveObjectCreationException

org.objectweb.proactive.core.node.NodeException

getInstance

public static SmartProxyImpl getInstance()

Returns the real singleton instance of the proxy

Returns:

instance of the proxy

init

public void init(ConnectionInfo connectionInfo)
          throws SchedulerException,
                 LoginException

Description copied from class: AbstractSmartProxy

Connects to the scheduler

Specified by:

init in class AbstractSmartProxy<JobTrackerImpl>

Throws:

LoginException

SchedulerException

init

public void init(String url,
                 Credentials credentials)
          throws SchedulerException,
                 LoginException

Throws:

SchedulerException

LoginException

init

public void init(String url,
                 CredData credData)
          throws SchedulerException,
                 LoginException

Throws:

SchedulerException

LoginException

disconnect

public void disconnect()
                throws NotConnectedException,
                       PermissionException

Description copied from class: AbstractSmartProxy

Disconnect from the scheduler

Specified by:

disconnect in interface Scheduler

Specified by:

disconnect in class AbstractSmartProxy<JobTrackerImpl>

Throws:

NotConnectedException - if you are not authenticated.

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<JobTrackerImpl>

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<JobTrackerImpl>

Returns:

a Map of eligible jobs.

Throws:

NotConnectedException

PermissionException

_getScheduler

protected Scheduler _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<JobTrackerImpl>

Returns:

a proxy instance to the Scheduler.

reconnect

public void reconnect()
               throws SchedulerException,
                      LoginException

Description copied from class: AbstractSmartProxy

Reconnects this smart proxy to the scheduler

Overrides:

reconnect in class AbstractSmartProxy<JobTrackerImpl>

Throws:

SchedulerException

LoginException

registerAsListener

public void registerAsListener()
                        throws NotConnectedException,
                               PermissionException

Specified by:

registerAsListener in class AbstractSmartProxy<JobTrackerImpl>

Throws:

NotConnectedException

PermissionException

uploadInputfiles

public boolean uploadInputfiles(TaskFlowJob job,
                                String localInputFolderPath)
                         throws Exception

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<JobTrackerImpl>

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

Exception

downloadTaskOutputFiles

protected void downloadTaskOutputFiles(AwaitedJob awaitedjob,
                                       String jobId,
                                       String t_name,
                                       String localFolder)
                                throws Exception

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<JobTrackerImpl>

jobId - job to pull data for

t_name - name of the task

localFolder - local output folder, if not null, it overrides the folder specified as output folder for the job

Throws:

Exception

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<JobTrackerImpl>

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<JobTrackerImpl>

Parameters:

jobs - a list of jobs to submit

Returns:

a list of objects containing, for each job, a job id or any error occurring during job submission

Throws:

NotConnectedException

reSubmit

public JobId reSubmit(JobId currentJobId,
                      Map<String,String> jobVariables,
                      Map<String,String> jobGenericInfos,
                      String sessionId)
               throws NotConnectedException,
                      UnknownJobException,
                      PermissionException,
                      JobCreationException,
                      SubmissionClosedException

Specified by:

reSubmit in interface Scheduler

Parameters:

currentJobId - id of the already submitted job

jobVariables - new job variables which is merged to existing job variables of the submitted job

jobGenericInfos - new generic information which is merged to existing generic info of the submitted job

Returns:

job id of the newly submitted job

Throws:

UnknownJobException - if currentJobId does not correspond to any submitted job

PermissionException - if user cannot access job with currentJobId

NotConnectedException

JobCreationException

SubmissionClosedException

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<JobTrackerImpl>

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<JobTrackerImpl>

Parameters:

jobId - the job in which the task result is.

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

Returns:

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

Throws:

NotConnectedException - if you are not authenticated.

UnknownJobException - if the job does not exist.

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

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

getTaskResult

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

Description copied from interface: Scheduler

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

Specified by:

getTaskResult in interface Scheduler

Overrides:

getTaskResult in class AbstractSmartProxy<JobTrackerImpl>

Parameters:

jobId - the job in which the task result is.

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

Returns:

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

Throws:

NotConnectedException - if you are not authenticated.

UnknownJobException - if the job does not exist.

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

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

getTaskResultFromIncarnation

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

Description copied from interface: Scheduler

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

A user can only get HIS result back.

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

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

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

Specified by:

getTaskResultFromIncarnation in interface Scheduler

Overrides:

getTaskResultFromIncarnation in class AbstractSmartProxy<JobTrackerImpl>

Parameters:

jobId - the job in which the task result is.

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

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

Returns:

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

Throws:

NotConnectedException - if you are not authenticated.

UnknownJobException - if the job does not exist.

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

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

getTaskResultAllIncarnations

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

Description copied from interface: Scheduler

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

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

Specified by:

getTaskResultAllIncarnations in interface Scheduler

Overrides:

getTaskResultAllIncarnations in class AbstractSmartProxy<JobTrackerImpl>

Parameters:

jobId - the job in which the task result is.

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

Returns:

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

Throws:

NotConnectedException - if you are not authenticated.

UnknownJobException - if the job does not exist.

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

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

getTaskResultAllIncarnations

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

Description copied from interface: Scheduler

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

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

Specified by:

getTaskResultAllIncarnations in interface Scheduler

Overrides:

getTaskResultAllIncarnations in class AbstractSmartProxy<JobTrackerImpl>

Parameters:

jobId - the job in which the task result is.

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

Returns:

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

Throws:

NotConnectedException - if you are not authenticated.

UnknownJobException - if the job does not exist.

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

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

getTaskResultFromIncarnation

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

Description copied from interface: Scheduler

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

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

Specified by:

getTaskResultFromIncarnation in interface Scheduler

Overrides:

getTaskResultFromIncarnation in class AbstractSmartProxy<JobTrackerImpl>

Parameters:

jobId - the job in which the task result is.

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

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

Returns:

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

Throws:

NotConnectedException - if you are not authenticated.

UnknownJobException - if the job does not exist.

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

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

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

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.

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.

updateLogo

public void updateLogo(byte[] image)
                throws NotConnectedException,
                       PermissionException,
                       ImageValidationException

Description copied from interface: Scheduler

Updates the logo on all portals

Specified by:

updateLogo in interface Scheduler

Throws:

NotConnectedException - if you are not authenticated.

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

ImageValidationException

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<JobTrackerImpl>

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<JobTrackerImpl>

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<JobTrackerImpl>

Throws:

NotConnectedException

PermissionException

removeJobIO

protected void removeJobIO(Job job,
                           String pushURL,
                           String pullURL,
                           String newFolderName)

Specified by:

removeJobIO in class AbstractSmartProxy<JobTrackerImpl>

createFolder

protected void createFolder(String fUri)
                     throws NotConnectedException,
                            PermissionException

Specified by:

createFolder in class AbstractSmartProxy<JobTrackerImpl>

Throws:

NotConnectedException

PermissionException

initActivity

public void initActivity(org.objectweb.proactive.Body body)

Specified by:

initActivity in interface org.objectweb.proactive.InitActive

endActivity

public void endActivity(org.objectweb.proactive.Body body)

Specified by:

endActivity in interface org.objectweb.proactive.EndActive

terminateFast

public void terminateFast()

This method forcefully terminates the activity of the proxy This method should not be called via a proactive stub

getTaskIds

public Page<TaskId> getTaskIds(String taskTag,
                               long from,
                               long to,
                               boolean mytasks,
                               Set<TaskStatus> taskStatuses,
                               int offset,
                               int limit)
                        throws SchedulerException

Description copied from interface: Scheduler

Retrieve a tasks names list from the scheduler.

Specified by:

getTaskIds in interface Scheduler

Parameters:

taskTag - a complete tag to use to filter tasks

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

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

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

taskStatuses - Set of task statuses which is used as filter

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

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

Returns:

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

Throws:

SchedulerException

getTaskStates

public Page<TaskState> getTaskStates(String taskTag,
                                     long from,
                                     long to,
                                     boolean mytasks,
                                     Set<TaskStatus> statusFilter,
                                     int offset,
                                     int limit,
                                     SortSpecifierContainer sortParams)
                              throws SchedulerException

Description copied from interface: Scheduler

Retrieve a taskstates list from the scheduler.

Specified by:

getTaskStates in interface Scheduler

Parameters:

taskTag - a complete tag to use to filter tasks

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

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

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

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

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

Returns:

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

Throws:

SchedulerException

getJobInfo

public JobInfo getJobInfo(String jobId)
                   throws SchedulerException

Description copied from interface: Scheduler

Retrieve a job info by it id.

Specified by:

getJobInfo in interface Scheduler

Parameters:

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

Returns:

the JobInfo associated to the given id

Throws:

SchedulerException

changeStartAt

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

Description copied from interface: Scheduler

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

Specified by:

changeStartAt in interface Scheduler

Parameters:

jobId - id of the job that needs to be updated

startAt - its value should be ISO 8601 compliant

Throws:

NotConnectedException

UnknownJobException

PermissionException

changeStartAt

public boolean changeStartAt(List<JobId> jobIdList,
                             String startAt)
                      throws NotConnectedException,
                             UnknownJobException,
                             PermissionException

Description copied from interface: Scheduler

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

Specified by:

changeStartAt in interface Scheduler

Parameters:

jobIdList - id of the jobs that needs to be updated

startAt - its value should be ISO 8601 compliant

Throws:

NotConnectedException

UnknownJobException

PermissionException

getJobContent

public String getJobContent(JobId jobId)
                     throws SchedulerException

Specified by:

getJobContent in interface Scheduler

Parameters:

jobId - job id of existing job

Returns:

copy of the xml which was submitted to the scheduler

Throws:

SchedulerException

getPortalConfiguration

public Map<Object,Object> getPortalConfiguration()
                                          throws SchedulerException

Specified by:

getPortalConfiguration in interface Scheduler

Returns:

Throws:

PermissionException

NotConnectedException

SchedulerException

getCurrentUser

public String getCurrentUser()
                      throws NotConnectedException

Description copied from interface: Scheduler

Returns the user currently connected

Specified by:

getCurrentUser in interface Scheduler

Returns:

user name

Throws:

NotConnectedException

getCurrentUserData

public UserData getCurrentUserData()
                            throws NotConnectedException

Description copied from interface: Scheduler

Returns the user data object associated with the user currently connected

Specified by:

getCurrentUserData in interface Scheduler

Returns:

a user data object

Throws:

NotConnectedException

getSubject

public Subject getSubject()
                   throws NotConnectedException

Description copied from interface: Scheduler

Returns the current user JaaS subject

Specified by:

getSubject in interface Scheduler

Returns:

jaas subject

Throws:

NotConnectedException

getSchedulerProperties

public Map<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

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