com.revo.deployr.client

Interface RClient

public interface RClient

Represents a DeployR client connection. Supports top level DeployR API calls and provides access to the DeployR Service Management objects.

Method Summary

Methods

Modifier and Type	Method and Description
RScriptExecution	executeExternal(java.lang.String externalSource, AnonymousProjectExecutionOptions options) Execute a single script found on a URL/path or a chain of scripts found on a set of URLs/paths on an anonymous project.
RScriptExecution	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.
RScriptExecution	executeScript(java.lang.String scriptName, java.lang.String scriptAuthor, java.lang.String scriptVersion, AnonymousProjectExecutionOptions 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.
RScriptExecution	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 an anonymous project.
RScriptExecution	executeScript(java.lang.String scriptName, java.lang.String scriptDirectory, java.lang.String scriptAuthor, java.lang.String scriptVersion, AnonymousProjectExecutionOptions options) Execute a single repository-managed script or a chain of repository-managed scripts on an anonymous project.
java.util.List<java.lang.String>	executeShell(java.lang.String shellName, java.lang.String shellDirectory, java.lang.String shellAuthor, java.lang.String shellVersion, java.lang.String args) Execute a repository-managed shell script.
void	interruptScript() Interrupts the current execution on the HTTP blackbox project associated with the current HTTP session.
RUser	login(RAuthentication pAuthentication) Authenticate with the DeployR server.
RUser	login(RAuthentication pAuthentication, boolean disableautosave) Authenticate with the DeployR server.
void	logout(RUser user) Logout from the DeployR server.
void	release() Shutdown the client connection releasing any resources associated with the connection.
java.net.URL	renderScript(java.lang.String scriptName, java.lang.String scriptDirectory, java.lang.String scriptAuthor, java.lang.String scriptVersion, AnonymousProjectExecutionOptions options) Execute a single repository-managed script or a chain of repository-managed scripts on an anonymous project and render the outputs to a HTML page.

Method Detail

login

RUser login(RAuthentication pAuthentication)
            throws RClientException,
                   RSecurityException

Authenticate with the DeployR server.

Parameters:

pAuthentication - - an authentication token.

Throws:

RClientException - if RClient fails to complete call.

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

See Also:

RUser

login

RUser login(RAuthentication pAuthentication,
          boolean disableautosave)
            throws RClientException,
                   RSecurityException

Authenticate with the DeployR server.

Parameters:

pAuthentication - - an authentication token.

disableautosave - - when true, disables persistent project auto-save semantics for duration of user session.

Throws:

RClientException - if RClient fails to complete call.

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

logout

void logout(RUser user)
            throws RClientException,
                   RSecurityException

Logout from the DeployR server.

Parameters:

user - a managed user reference

Throws:

RClientException - if RClient fails to complete call.

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

executeScript

@Deprecated
RScriptExecution 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 an anonymous 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

See Also:

RScriptExecution

executeScript

@Deprecated
RScriptExecution executeScript(java.lang.String scriptName,
                                        java.lang.String scriptAuthor,
                                        java.lang.String scriptVersion,
                                        AnonymousProjectExecutionOptions 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 an anonymous 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

See Also:

RScriptExecution

executeScript

RScriptExecution 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 an anonymous 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

See Also:

RScriptExecution

executeScript

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

Execute a single repository-managed script or a chain of repository-managed scripts on an anonymous 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

See Also:

RScriptExecution

executeExternal

RScriptExecution executeExternal(java.lang.String externalSource,
                               AnonymousProjectExecutionOptions 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 an anonymous 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

See Also:

RScriptExecution

renderScript

java.net.URL renderScript(java.lang.String scriptName,
                        java.lang.String scriptDirectory,
                        java.lang.String scriptAuthor,
                        java.lang.String scriptVersion,
                        AnonymousProjectExecutionOptions options)
                          throws RClientException,
                                 RDataException

Execute a single repository-managed script or a chain of repository-managed scripts on an anonymous project and render the outputs to a HTML page.

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

See Also:

RScriptExecution

executeShell

java.util.List<java.lang.String> executeShell(java.lang.String shellName,
                                            java.lang.String shellDirectory,
                                            java.lang.String shellAuthor,
                                            java.lang.String shellVersion,
                                            java.lang.String args)
                                              throws RClientException,
                                                     RSecurityException,
                                                     RDataException

Execute a repository-managed shell script. Execution occurs on the DeployR server. The response captures the line-by-line console output generated by the execution of the shell script on the server. Only shell scripts created by an ADMIN user on the DeployR server can be executed on this call. All attempts to execute shell scripts not created by an ADMIN user will be rejected. Access to shell scripts is also governed by standard repository access controls.

Throws:

RClientException - if RClient fails to complete call.

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

RDataException

interruptScript

void interruptScript()
                     throws RClientException,
                            RSecurityException

Interrupts the current execution on the HTTP blackbox project associated with the current HTTP session.

Throws:

RClientException - if RClient fails to complete call.

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

See Also:

RScriptExecution

release

void release()

Shutdown the client connection releasing any resources associated with the connection. If needed, the user will be automatically logged out as a result of this call.