com.revo.deployr.client.api

Interface RUserRepositoryDirectoryCalls

All Known Subinterfaces:

RUser

public interface RUserRepositoryDirectoryCalls

Defines repository-managed directory related interfaces for DeployR-managed user.

Method Summary

Modifier and Type	Method and Description
void	copyDirectory(java.lang.String sourceDirectory, java.lang.String destinationDirectory, java.util.List<RRepositoryFile> files) Copies one or more repository-managed files from a source user directory to a destination user directory.
RRepositoryDirectory	createDirectory(java.lang.String directory) Creates a new custom user directory in the default repository.
java.util.List<RRepositoryDirectory>	listDirectories() List directories in the user's default repository.
java.util.List<RRepositoryDirectory>	listDirectories(boolean userfiles, boolean archived, boolean shared, boolean published) List directories in the user's default repository.
java.util.List<RRepositoryDirectory>	listDirectories(RRepositoryFile.Category categoryFilter, java.lang.String directoryFilter) List directories in the user's default repository using filters to constrain the files in the response markup.
java.util.List<RRepositoryDirectory>	listExternalDirectories() List directories in the user's external repository.
java.util.List<RRepositoryDirectory>	listExternalDirectories(boolean userfiles, boolean shared, boolean published) List directories in the user's external repository.
java.util.List<RRepositoryDirectory>	listExternalDirectories(RRepositoryFile.Category categoryFilter, java.lang.String directoryFilter) List directories in the user's external repository using filters to constrain the files in the response markup.
void	moveDirectory(java.lang.String sourceDirectory, java.lang.String destinationDirectory, java.util.List<RRepositoryFile> files) Moves one or more repository-managed files from a source user directory to a destination user directory.
void	uploadDirectory(java.io.InputStream zipStream, RepoUploadOptions options) Uploads a set of files in a single zip archive into an existing repository-managed user directory.

Method Detail

listDirectories

java.util.List<RRepositoryDirectory> listDirectories()
                                              throws RClientException,
                                                     RSecurityException

List directories in the user's default repository.

Throws:

RClientException - if RClient fails to complete call.

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

listDirectories

java.util.List<RRepositoryDirectory> listDirectories(boolean userfiles,
                                                     boolean archived,
                                                     boolean shared,
                                                     boolean published)
                                              throws RClientException,
                                                     RSecurityException

List directories in the user's default repository. If the userfiles parameter is enabled, then files in the user's directories are included in the response. If the archived parameter is enabled, then files in the user's archive directories are included in the response. If the shared parameter is enabled, then files shared by other users will be included in the response. If the published parameter is enabled, then files shared 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.

listDirectories

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

List directories 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.

listExternalDirectories

java.util.List<RRepositoryDirectory> listExternalDirectories()
                                                      throws RClientException,
                                                             RSecurityException

List directories in the user's external repository.

Throws:

RClientException - if RClient fails to complete call.

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

listExternalDirectories

java.util.List<RRepositoryDirectory> listExternalDirectories(boolean userfiles,
                                                             boolean shared,
                                                             boolean published)
                                                      throws RClientException,
                                                             RSecurityException

List directories in the user's external repository. If the userfiles parameter is enabled, then files in the user's external directories are included in the response. 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.

listExternalDirectories

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

List directories 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.

createDirectory

RRepositoryDirectory createDirectory(java.lang.String directory)
                              throws RClientException,
                                     RSecurityException

Creates a new custom user directory in the default repository.

Throws:

RClientException - if RClient fails to complete call.

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

copyDirectory

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

Copies one or more repository-managed files from a source user directory to a destination user directory.

If the files parameter is null, all files in the source directory will be copied to the destination directory.

Throws:

RClientException - if RClient fails to complete call.

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

moveDirectory

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

Moves one or more repository-managed files from a source user directory to a destination user directory.

If the files parameter is null, all files in the source directory will be moved to the destination directory.

Throws:

RClientException - if RClient fails to complete call.

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

uploadDirectory

void uploadDirectory(java.io.InputStream zipStream,
                     RepoUploadOptions options)
              throws RClientException,
                     RSecurityException

Uploads a set of files in a single zip archive into an existing repository-managed user directory. The files are extracted from the zip archive and placed file-by-file into the directory.

The options.filename property is ignored on this call and can be left blank.

Throws:

RClientException - if RClient fails to complete call.

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