|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface BatchRepositoryResourceService
A service for performing batch operations in the repository. The methods on this service are a best effort which means if an error occurs with one resource, it will continue on to the next.
Each method returns an ActionStatus
with a
ActionStatus.SummaryStatusCode
and message indicating the overall status. The ActionStatus
also contains a list of ActionStatusEntry
s which provides the status of each file.
Method Summary | |
---|---|
ActionStatus |
checkin(List<String> paths,
ResourceCheckinSpecification checkinSpec)
Checks in all files specified in the list of paths (can contain container and file paths) that are ready for checkin. |
ActionStatus |
checkout(List<String> paths)
Checks out all files specified in the list of paths (can contain container and file paths). |
ActionStatus |
downloadAsZip(Set<String> paths,
String localFilePath,
boolean overwrite)
Takes the repository paths in the selected set and downloads them to the zip file specified in local path. |
ActionStatus |
uploadAndExpand(String parentPath,
String localZipFilePath,
boolean enableVersioningOnAllNewFiles,
ResourceCheckinSpecification checkinSpec,
boolean createParentFolders)
Unzips the zip file specified in localZipFilePath and saves the contents to the repository location specified in parentPath. |
Method Detail |
---|
ActionStatus checkout(List<String> paths)
paths
- List of paths to be checked out
ActionStatus checkin(List<String> paths, ResourceCheckinSpecification checkinSpec)
paths
- List of paths to be checked incheckinSpec
- The specification of how the files should be checked in. If null is provided and the file is
versioned, it will default to a MINOR version.
ActionStatus uploadAndExpand(String parentPath, String localZipFilePath, boolean enableVersioningOnAllNewFiles, ResourceCheckinSpecification checkinSpec, boolean createParentFolders)
parentPath
- The parent path of the container in which to create the expand the contents of the specified
zip.localZipFilePath
- The local file path of the zip in which to upload and expand.enableVersioningOnAllNewFiles
- Whether to enable versioning on new filescheckinSpec
- The specification of how the files should be checked in. Applies to existing versioned files,
as well as new files if enableVersioningOnAllNewFiles is true.createParentFolders
- Whether to create parent containers if they do not exist.
ActionStatus downloadAsZip(Set<String> paths, String localFilePath, boolean overwrite)
paths
- List of paths to be downloaded to a ziplocalFilePath
- The local file path in which to save the zip.overwrite
- Whether to overwrite the local zip file if it exists.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |