com.revo.deployr.client.api

Interface RProjectExecuteCalls

All Known Subinterfaces:

RProject

public interface RProjectExecuteCalls

Defines execution related interfaces for DeployR-managed project.

Method Summary

Modifier and Type	Method and Description
void	deleteResults() Delete execution results on project.
java.io.InputStream	downloadResults() Download execution results on project.
RProjectExecution	executeCode(java.lang.String code) Execute code on project.
RProjectExecution	executeCode(java.lang.String code, ProjectExecutionOptions options) Execute code on project.
RProjectExecution	executeExternal(java.lang.String externalSource, ProjectExecutionOptions options) Execute a single script found on a URL/path or a chain of scripts found on a set of URLs/paths on the current project.
RProjectExecution	executeScript(java.lang.String scriptName, java.lang.String scriptAuthor, java.lang.String scriptVersion) Deprecated. As of release 7.1, use executeScript method that supports scriptDirectory parameter. This deprecated call assumes each script is found in the root directory.
RProjectExecution	executeScript(java.lang.String scriptName, java.lang.String scriptAuthor, java.lang.String scriptVersion, ProjectExecutionOptions options) Deprecated. As of release 7.1, use executeScript method that supports scriptDirectory parameter. This deprecated call assumes each script is found in the root directory.
RProjectExecution	executeScript(java.lang.String scriptName, java.lang.String scriptDirectory, java.lang.String scriptAuthor, java.lang.String scriptVersion) Execute a single repository-managed script or a chain of repository-managed scripts on the current project.
RProjectExecution	executeScript(java.lang.String scriptName, java.lang.String scriptDirectory, java.lang.String scriptAuthor, java.lang.String scriptVersion, ProjectExecutionOptions options) Execute a single repository-managed script or a chain of repository-managed scripts on the current project.
void	flushHistory() Flush execution history on project.
java.lang.String	getConsole() Retrieve console output on latest execution on project.
java.util.List<RProjectExecution>	getHistory() Retrieve execution history on project.
void	interruptExecution() Interrupt execution on project.
java.util.List<RProjectResult>	listResults() Retreive execution result list on project.

Method Detail

executeCode

RProjectExecution executeCode(java.lang.String code)
                       throws RClientException,
                              RSecurityException,
                              RDataException,
                              RGridException

Execute code on project.

Throws:

RClientException - if RClient fails to complete call.

RSecurityException - if DeployR server security conditions not met on call.

RDataException

RGridException

executeCode

RProjectExecution executeCode(java.lang.String code,
                              ProjectExecutionOptions options)
                       throws RClientException,
                              RSecurityException,
                              RDataException,
                              RGridException

Execute code on project.

Throws:

RClientException - if RClient fails to complete call.

RSecurityException - if DeployR server security conditions not met on call.

RDataException

RGridException

executeScript

RProjectExecution executeScript(java.lang.String scriptName,
                                java.lang.String scriptAuthor,
                                java.lang.String scriptVersion)
                         throws RClientException,
                                RSecurityException,
                                RDataException,
                                RGridException

Deprecated. As of release 7.1, use executeScript method that supports scriptDirectory parameter. This deprecated call assumes each script is found in the root directory.

Execute a single repository-managed script or a chain of repository-managed scripts on the current project.

To execute a chain of repository-managed scripts on this call provide a comma-separated list of values on the scriptName, scriptAuthor and optionally scriptVersion parameters. Chained execution executes each of the scripts identified on the call in a sequential fashion on the R session, with execution occuring in the order specified on the parameter list.

Throws:

RClientException - if RClient fails to complete call.

RSecurityException - if DeployR server security conditions not met on call.

RDataException

RGridException

executeScript

RProjectExecution executeScript(java.lang.String scriptName,
                                java.lang.String scriptAuthor,
                                java.lang.String scriptVersion,
                                ProjectExecutionOptions options)
                         throws RClientException,
                                RSecurityException,
                                RDataException,
                                RGridException

Deprecated. As of release 7.1, use executeScript method that supports scriptDirectory parameter. This deprecated call assumes each script is found in the root directory.

Execute a single repository-managed script or a chain of repository-managed scripts on the current project.

To execute a chain of repository-managed scripts on this call provide a comma-separated list of values on the scriptName, scriptAuthor and optionally scriptVersion parameters. Chained execution executes each of the scripts identified on the call in a sequential fashion on the R session, with execution occuring in the order specified on the parameter list.

Throws:

RClientException - if RClient fails to complete call.

RSecurityException - if DeployR server security conditions not met on call.

RDataException

RGridException

executeScript

RProjectExecution executeScript(java.lang.String scriptName,
                                java.lang.String scriptDirectory,
                                java.lang.String scriptAuthor,
                                java.lang.String scriptVersion)
                         throws RClientException,
                                RSecurityException,
                                RDataException,
                                RGridException

Execute a single repository-managed script or a chain of repository-managed scripts on the current project.

To execute a chain of repository-managed scripts on this call provide a comma-separated list of values on the scriptName, scriptAuthor and optionally scriptVersion parameters. Chained execution executes each of the scripts identified on the call in a sequential fashion on the R session, with execution occuring in the order specified on the parameter list.

Throws:

RClientException - if RClient fails to complete call.

RSecurityException - if DeployR server security conditions not met on call.

RDataException

RGridException

executeScript

RProjectExecution executeScript(java.lang.String scriptName,
                                java.lang.String scriptDirectory,
                                java.lang.String scriptAuthor,
                                java.lang.String scriptVersion,
                                ProjectExecutionOptions options)
                         throws RClientException,
                                RSecurityException,
                                RDataException,
                                RGridException

Execute a single repository-managed script or a chain of repository-managed scripts on the current project.

To execute a chain of repository-managed scripts on this call provide a comma-separated list of values on the scriptName, scriptAuthor and optionally scriptVersion parameters. Chained execution executes each of the scripts identified on the call in a sequential fashion on the R session, with execution occuring in the order specified on the parameter list.

Throws:

RClientException - if RClient fails to complete call.

RSecurityException - if DeployR server security conditions not met on call.

RDataException

RGridException

executeExternal

RProjectExecution executeExternal(java.lang.String externalSource,
                                  ProjectExecutionOptions options)
                           throws RClientException,
                                  RSecurityException,
                                  RDataException,
                                  RGridException

Execute a single script found on a URL/path or a chain of scripts found on a set of URLs/paths on the current project.

To execute a chain of repository-managed scripts on this call provide a comma-separated list of values on the externalSource parameter. Chained execution executes each of the scripts identified on the call in a sequential fashion on the R session, with execution occuring in the order specified on the parameter list.

POWER_USER privileges are required for this call.

Throws:

RClientException - if RClient fails to complete call.

RSecurityException - if DeployR server security conditions not met on call.

RDataException

RGridException

getConsole

java.lang.String getConsole()
                     throws RClientException,
                            RSecurityException

Retrieve console output on latest execution on project.

Throws:

RClientException - if RClient fails to complete call.

RSecurityException - if DeployR server security conditions not met on call.

interruptExecution

void interruptExecution()
                 throws RClientException,
                        RSecurityException

Interrupt execution on project.

Throws:

RClientException - if RClient fails to complete call.

RSecurityException - if DeployR server security conditions not met on call.

getHistory

java.util.List<RProjectExecution> getHistory()
                                      throws RClientException,
                                             RSecurityException

Retrieve execution history on project.

Throws:

RClientException - if RClient fails to complete call.

RSecurityException - if DeployR server security conditions not met on call.

flushHistory

void flushHistory()
           throws RClientException,
                  RSecurityException

Flush execution history on project.

Throws:

RClientException - if RClient fails to complete call.

RSecurityException - if DeployR server security conditions not met on call.

listResults

java.util.List<RProjectResult> listResults()
                                    throws RClientException,
                                           RSecurityException

Retreive execution result list on project.

Throws:

RClientException - if RClient fails to complete call.

RSecurityException - if DeployR server security conditions not met on call.

deleteResults

void deleteResults()
            throws RClientException,
                   RSecurityException

Delete execution results on project.

Throws:

RClientException - if RClient fails to complete call.

RSecurityException - if DeployR server security conditions not met on call.

downloadResults

java.io.InputStream downloadResults()
                             throws RClientException,
                                    RSecurityException

Download execution results on project.

Throws:

RClientException - if RClient fails to complete call.

RSecurityException - if DeployR server security conditions not met on call.