com.revo.deployr.client.api

Interface RUserRepositoryFileCalls

All Known Subinterfaces:

RUser

public interface RUserRepositoryFileCalls

Defines repository-managed file related interfaces for a DeployR-managed user.

Method Summary

Methods

Modifier and Type	Method and Description
void	copyFiles(java.lang.String destinationDirectory, java.util.List<RRepositoryFile> files, java.util.List<java.lang.String> fileRenames) Copy one or more files to a repository-managed directory.
RRepositoryFile	fetchFile(java.lang.String filename, java.lang.String directory, java.lang.String author, java.lang.String version) Fetch latest meta-data on repository-managed file.
java.util.List<RRepositoryFile>	listFiles() List files in user repository.
java.util.List<RRepositoryFile>	listFiles(boolean archived, boolean shared, boolean published) List files including those archived by the caller or those shared or published by other users in the repository.
java.util.List<RRepositoryFile>	listFiles(java.lang.String filename, java.lang.String directory) List versions of named file in user repository-managed directory.
void	moveFiles(java.lang.String destinationDirectory, java.util.List<RRepositoryFile> files) Move one or more files to a repository-managed directory.
RRepositoryFile	transferFile(java.net.URL url, RepoUploadOptions options) Transfer file to user repository.
RRepositoryFile	uploadFile(java.io.InputStream fileStream, RepoUploadOptions options) Upload file to user repository.
RRepositoryFile	writeFile(java.lang.String text, RepoUploadOptions options) Write file to user repository.

Method Detail

listFiles

java.util.List<RRepositoryFile> listFiles()
                                          throws RClientException,
                                                 RSecurityException

List files in user repository.

Throws:

RClientException - if RClient fails to complete call.

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

listFiles

java.util.List<RRepositoryFile> listFiles(boolean archived,
                                        boolean shared,
                                        boolean published)
                                          throws RClientException,
                                                 RSecurityException

List files including those archived by the caller or those shared or published by other users in the repository. The list of shared files will include any restricted files that the caller can access.

Throws:

RClientException - if RClient fails to complete call.

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

listFiles

java.util.List<RRepositoryFile> listFiles(java.lang.String filename,
                                        java.lang.String directory)
                                          throws RClientException,
                                                 RSecurityException

List versions of named file in user repository-managed directory.

Throws:

RClientException - if RClient fails to complete call.

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

fetchFile

RRepositoryFile fetchFile(java.lang.String filename,
                        java.lang.String directory,
                        java.lang.String author,
                        java.lang.String version)
                          throws RClientException,
                                 RSecurityException

Fetch latest meta-data on repository-managed file.

Throws:

RClientException - if RClient fails to complete call.

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

uploadFile

RRepositoryFile uploadFile(java.io.InputStream fileStream,
                         RepoUploadOptions options)
                           throws RClientException,
                                  RSecurityException

Upload file to user repository.

Throws:

RClientException - if RClient fails to complete call.

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

writeFile

RRepositoryFile writeFile(java.lang.String text,
                        RepoUploadOptions options)
                          throws RClientException,
                                 RSecurityException

Write file to user repository.

Throws:

RClientException - if RClient fails to complete call.

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

transferFile

RRepositoryFile transferFile(java.net.URL url,
                           RepoUploadOptions options)
                             throws RClientException,
                                    RSecurityException

Transfer file to user repository.

Throws:

RClientException - if RClient fails to complete call.

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

copyFiles

void copyFiles(java.lang.String destinationDirectory,
             java.util.List<RRepositoryFile> files,
             java.util.List<java.lang.String> fileRenames)
               throws RClientException,
                      RSecurityException

Copy one or more files to a repository-managed directory. The fileRenames parameter is optional. If specified, it can be used to rename each file as it is copied.

Throws:

RClientException - if RClient fails to complete call.

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

moveFiles

void moveFiles(java.lang.String destinationDirectory,
             java.util.List<RRepositoryFile> files)
               throws RClientException,
                      RSecurityException

Move one or more files to a repository-managed directory.

Throws:

RClientException - if RClient fails to complete call.

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