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

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>	listExternalFiles() List files in the user's external repository.
java.util.List<RRepositoryFile>	listExternalFiles(boolean shared, boolean published) List files in the user's external repository.
java.util.List<RRepositoryFile>	listExternalFiles(RRepositoryFile.Category categoryFilter, java.lang.String directoryFilter) List files in the user's external repository using filters to constrain the files in the response markup.
java.util.List<RRepositoryFile>	listFiles() List files in the user's default repository.
java.util.List<RRepositoryFile>	listFiles(boolean archived, boolean shared, boolean published) List files in the user's default repository.
java.util.List<RRepositoryFile>	listFiles(RRepositoryFile.Category categoryFilter, java.lang.String directoryFilter) List files in the user's default repository using filters to constrain the files in the response markup.
java.util.List<RRepositoryFile>	listFiles(java.lang.String filename, java.lang.String directory) List versions of named file in user's default repository.
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 the user's default 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 in the user's default repository. If the archived parameter is enabled, then archived files by the user will be included in the response. If the shared parameter is enabled, then files shared by other users will be included in the response. The list of shared files will include any restricted files that the caller can access. If the published parameter is enabled, then files published by other users will be included in the response.

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's default 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(RRepositoryFile.Category categoryFilter,
                                          java.lang.String directoryFilter)
                                   throws RClientException,
                                          RSecurityException

List files in the user's default repository using filters to constrain the files in the response markup. If categoryFilter is specified only files matching the Category indicated will be included in the response. If directoryFilter is specified then only files found in the directory indicated will be included in the response. If both categoryFilter and directoryFilter are specified then only files matching the Category within the directory indicated will be included in the response.

Throws:

RClientException - if RClient fails to complete call.

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

listExternalFiles

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

List files in the user's external repository.

Throws:

RClientException - if RClient fails to complete call.

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

listExternalFiles

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

List files in the user's external repository. If the shared parameter is enabled, then external files shared by other users will be included in the response. If the published parameter is enabled, then external files published by other users will be included in the response.

Throws:

RClientException - if RClient fails to complete call.

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

listExternalFiles

java.util.List<RRepositoryFile> listExternalFiles(RRepositoryFile.Category categoryFilter,
                                                  java.lang.String directoryFilter)
                                           throws RClientException,
                                                  RSecurityException

List files in the user's external repository using filters to constrain the files in the response markup. If categoryFilter is specified only files matching the Category indicated will be included in the response. If directoryFilter is specified then only files found in the external directory indicated will be included in the response. If both categoryFilter and directoryFilter are specified then only files matching the Category within the external directory indicated will be included in the response.

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.