asyncCopy

This method has been deprecated.

* Performs an asynchronous file copy on multiple files in a list. If one file path is incorrect only this file will not be copied.

Input Parameters

name type description
sourcePaths string[] An array of source paths where the files will be copied from.
In format: /nodePath/hotfolderRootPath/filePath.
destinationPaths string[] An array of destination paths where the files will be copied to.
In format: /nodePath/hotfolderRootPath/filePath.
processId string The unique message ID for process instance. Identifies ESB message which will be used by ESB service continuator.
makeUniquePath boolean the make unique path

Faults

name description
RepositoryManagerWebServiceFault If a error occurs while trying to locate or copy the source file.

asyncDelete

This method has been deprecated.

Performs an asynchronous file deletion on multiple files. If one file path is incorrect only this file will not be removed.

Input Parameters

name type description
sourcePaths string[] An array of source paths where the files will be deleted from.
In format: /nodePath/hotfolderRootPath/filePath.
processId string The unique message ID for process instance. Identifies ESB message which will be used by ESB service continuator.

Faults

name description
RepositoryManagerWebServiceFault If any error occurs while trying to locate or delete the source file.

asynchronousBatchCopy

Performs an asynchronous file batch copy on multiple files in a list. Source files and destinations are specified byfileOperationPathsList parameter. For each fileOperationPaths object in this array copy operation will be executed and all files fromFileOperationPaths#getSourcePaths() will be copied to folders specified by FileOperationPaths#getDestinationPaths();Path format is following: /nodePath/hotfolderRootPath/filePath

Input Parameters

name type description
fileOperationPathsArray FileOperationPaths[] (no documentation provided)
createContentFiles boolean A boolean indicating whether files with known zip extensions should be unzipped when they are moved
collisionBehaviorType repositoryManagerCollisionBehaviorTypeEnum An enum value indicating how the system should handle name collisions. If collisionBehaviorType is set to UNIQUE_SUBDIR then unique directory will always be generated even when there are no collisions
operationProfile operationProfile A bean containing information used by the system to notify an external system of the completion status of the job.
filePathOption repositoryManagerFilePathEnum Whether the original file's path should be replaced at the target location.
pathProcessor string representing a path processor plugin component name

Faults

name description
RepositoryManagerWebServiceFault If failed to perform async copy operation.

asynchronousBatchHlsCopy

Performs an asynchronous file batch hls copy on multiple files in a list. Source files and destinations are specified byfileOperationPathsList parameter. For each fileOperationPaths object in this array copy operation will be executed and all files fromFileOperationPaths#getSourcePaths() will be moved to folders specified by FileOperationPaths#getDestinationPaths();Path format is following: /nodePath/hotfolderRootPath/filePath

Input Parameters

name type description
fileOperationPathsArray FileOperationPaths[] (no documentation provided)
createContentFiles boolean A boolean indicating whether files with known zip extensions should be unzipped when they are moved
collisionBehaviorType repositoryManagerCollisionBehaviorTypeEnum An enum value indicating how the system should handle name collisions. If collisionBehaviorType is set to UNIQUE_SUBDIR then unique directory will always be generated even when there are no collisions
operationProfile operationProfile A bean containing information used by the system to notify an external system of the completion status of the job.
filePathOption repositoryManagerFilePathEnum Whether the original file's path should be replaced at the target location.
pathProcessor string representing a path processor plugin component name

Faults

name description
RepositoryManagerWebServiceFault If failed to perform async batch hls copy operation.

asynchronousBatchHlsMove

Performs an asynchronous file batch hls move on multiple files in a list. Source files and destinations are specified byfileOperationPathsList parameter. For each fileOperationPaths object in this array copy operation will be executed and all files fromFileOperationPaths#getSourcePaths() will be moved to folders specified by FileOperationPaths#getDestinationPaths();Path format is following: /nodePath/hotfolderRootPath/filePath

Input Parameters

name type description
fileOperationPathsArray FileOperationPaths[] (no documentation provided)
createContentFiles boolean A boolean indicating whether files with known zip extensions should be unzipped when they are moved
collisionBehaviorType repositoryManagerCollisionBehaviorTypeEnum An enum value indicating how the system should handle name collisions. If collisionBehaviorType is set to UNIQUE_SUBDIR then unique directory will always be generated even when there are no collisions
operationProfile operationProfile A bean containing information used by the system to notify an external system of the completion status of the job.
filePathOption repositoryManagerFilePathEnum Whether the original file's path should be replaced at the target location.
pathProcessor string representing a path processor plugin component name

Faults

name description
RepositoryManagerWebServiceFault If failed to perform async batch hls copy operation.

asynchronousBatchMove

Performs an asynchronous file batch move on multiple files in a list. Source files and destinations are specified byfileOperationPathsList parameter. For each fileOperationPaths object in this array copy operation will be executed and all files fromFileOperationPaths#getSourcePaths() will be moved to folders specified by FileOperationPaths#getDestinationPaths();Path format is following: /nodePath/hotfolderRootPath/filePath

Input Parameters

name type description
fileOperationPathsArray FileOperationPaths[] (no documentation provided)
createContentFiles boolean A boolean indicating whether files with known zip extensions should be unzipped when they are moved
collisionBehaviorType repositoryManagerCollisionBehaviorTypeEnum An enum value indicating how the system should handle name collisions. If collisionBehaviorType is set to UNIQUE_SUBDIR then unique directory will always be generated even when there are no collisions
operationProfile operationProfile A bean containing information used by the system to notify an external system of the completion status of the job.
filePathOption repositoryManagerFilePathEnum Whether the original file's path should be replaced at the target location.
pathProcessor string representing a path processor plugin component name

Faults

name description
RepositoryManagerWebServiceFault If failed to perform async copy operation.

asynchronousCopy

Performs an asynchronous file copy on multiple files in a list.

Input Parameters

name type description
sourcePaths string[] An array of source paths where the files will be moved from.
In format: /nodePath/hotfolderRootPath/filePath.
destPaths string[] (no documentation provided)
createContentFiles boolean A boolean indicating whether files with known zip extensions should be unzipped when they are moved
collisionBehaviorType repositoryManagerCollisionBehaviorTypeEnum An enum value indicating how the system should handle name collisions. If collisionBehaviorType is set to UNIQUE_SUBDIR then unique directory will always be generated even when there are no collisions
operationProfile operationProfile A bean containing information used by the system to notify an external system of the completion status of the job.
filePathOption repositoryManagerFilePathEnum Whether the original file's path should be replaced at the target location.
pathProcessor string representing a path processor plugin component name

Faults

name description
RepositoryManagerWebServiceFault If failed to perform async copy operation.

asynchronousCopyAndRename

Performs an asynchronous file copy and renaming on multiple files in a list.

Input Parameters

name type description
sourcePaths string[] An array of source paths where the files will be moved from.
In format: /nodePath/hotfolderRootPath/filePath.
destinationFileNames string[] An array of destination file names that the source file is going to rename to after copy operation
destPaths string[] (no documentation provided)
createContentFiles boolean A boolean indicating whether files with known zip extensions should be unzipped when they are moved
collisionBehaviorType repositoryManagerCollisionBehaviorTypeEnum An enum value indicating how the system should handle name collisions. If collisionBehaviorType is set to UNIQUE_SUBDIR then unique directory will always be generated even when there are no collisions
operationProfile operationProfile A bean containing information used by the system to notify an external system of the completion status of the job.
filePathOption repositoryManagerFilePathEnum Whether the original file's path should be replaced at the target location.
pathProcessor string representing a path processor plugin component name

Faults

name description
RepositoryManagerWebServiceFault If failed to perform async copy operation.

asynchronousCopyAndUnzip

Asynchronously unzip files from archives, specified by sourcePaths, to folders, specified by destPats parameter.

Input Parameters

name type description
sourcePaths string[] An array of source paths where the files will be moved from.
In format: /nodePath/hotfolderRootPath/filePath.
destPaths string[] An array of destination paths where the files will be moved to.
In format: /nodePath/hotfolderRootPath/filePath.
createContentFiles boolean A boolean indicating whether to create content file for output files
collisionBehaviorType repositoryManagerCollisionBehaviorTypeEnum An enum value indicating how the system should handle name collisions. If collisionBehaviorType is set to UNIQUE_SUBDIR then unique directory will always be generated even when there are no collisions
operationProfile operationProfile A bean containing information used by the system to notify an external system of the completion status of the job.

Faults

name description
RepositoryManagerWebServiceFault If failed to perform async copy and unzip operation.

asynchronousCopyAndZip

Asynchronously zip files from archives, specified by sourcePaths, to folders, specified by destPats parameter.

Input Parameters

name type description
sourcePaths string[] An array of source paths where the files will be moved from.
In format: /nodePath/hotfolderRootPath/filePath.
outputFilenameMacro string the output filename macro
destPaths string[] An array of destination paths where the files will be moved to.
In format: /nodePath/hotfolderRootPath/filePath.
archiverFormat archiverFormatEnum the archiver format
compressorFormat compressorFormatEnum the compressor format
createContentFiles boolean A boolean indicating whether files with known zip extensions should be zipped when they are copied
collisionBehaviorType repositoryManagerCollisionBehaviorTypeEnum An enum value indicating how the system should handle name collisions. If collisionBehaviorType is set to UNIQUE_SUBDIR then unique directory will always be generated even when there are no collisions
operationProfile operationProfile A bean containing information used by the system to notify an external system of the completion status of the job.

Faults

name description
RepositoryManagerWebServiceFault If failed to perform async copy and zip operation.

asynchronousFilesetDelete

Performs an asynchronous fileset deletion.

Input Parameters

name type description
sourcePaths string[] An array of source paths where the filesets will be removed.
In format: /nodePath/hotfolderRootPath/filePath.
deleteContentFiles boolean A boolean indicating whether master manifest should be deleted
operationProfile operationProfile A bean containing information used by the system to notify an external system of the completion status of the job.

Faults

name description
RepositoryManagerWebServiceFault If failed to perform async fileset delete operation.

asynchronousHlsCopy

Performs an asynchronous file HLS folder copy.

Input Parameters

name type description
sourcePaths string[] An array of source paths where the files will be moved from.
In format: /nodePath/hotfolderRootPath/filePath.
destPaths string[] (no documentation provided)
createContentFiles boolean A boolean indicating whether creating content file for output files
collisionBehaviorType repositoryManagerCollisionBehaviorTypeEnum An enum value indicating how the system should handle name collisions. If collisionBehaviorType is set to UNIQUE_SUBDIR then unique directory will always be generated even when there are no collisions
operationProfile operationProfile A bean containing information used by the system to notify an external system of the completion status of the job.
filePathOption repositoryManagerFilePathEnum Whether the original file's path should be replaced at the target location.
pathProcessor string representing a path processor plugin component name

Faults

name description
RepositoryManagerWebServiceFault If failed to perform async copy operation.

asynchronousHlsMove

Performs an asynchronous file HLS folder move.

Input Parameters

name type description
sourcePaths string[] An array of source paths where the files will be moved from.
In format: /nodePath/hotfolderRootPath/filePath.
destPaths string[] (no documentation provided)
createContentFiles boolean A boolean indicating whether files with known zip extensions should be unzipped when they are moved
collisionBehaviorType repositoryManagerCollisionBehaviorTypeEnum An enum value indicating how the system should handle name collisions. If collisionBehaviorType is set to UNIQUE_SUBDIR then unique directory will always be generated even when there are no collisions
operationProfile operationProfile A bean containing information used by the system to notify an external system of the completion status of the job.
filePathOption repositoryManagerFilePathEnum Whether the original file's path should be replaced at the target location.
pathProcessor string representing a path processor plugin component name

Faults

name description
RepositoryManagerWebServiceFault If failed to perform async copy operation.

asynchronousMove

Performs an asynchronous file move on multiple files in a list.

Input Parameters

name type description
sourcePaths string[] An array of source paths where the files will be moved from.
In format: /nodePath/hotfolderRootPath/filePath.
destPaths string[] An array of destination paths where the files will be moved to.
In format: /nodePath/hotfolderRootPath/filePath.
createContentFiles boolean A boolean indicating whether files with known zip extensions should be unzipped when they are moved
collisionBehaviorType repositoryManagerCollisionBehaviorTypeEnum An enum value indicating how the system should handle name collisions. If collisionBehaviorType is set to UNIQUE_SUBDIR then unique directory will always be generated even when there are no collisions
operationProfile operationProfile A bean containing information used by the system to notify an external system of the completion status of the job.
filePathOption repositoryManagerFilePathEnum Whether the original file's path should be replaced at the target location.
pathProcessor string representing a path processor plugin component name

Faults

name description
RepositoryManagerWebServiceFault If failed to perform async move operation.

asynchronousMoveAndRename

Performs an asynchronous file move and renaming on multiple files in a list.

Input Parameters

name type description
sourcePaths string[] An array of source paths where the files will be moved from.
In format: /nodePath/hotfolderRootPath/filePath.
destinationFileNames string[] An array of destination file names that the source file is going to rename to after copy operation
destPaths string[] (no documentation provided)
createContentFiles boolean A boolean indicating whether files with known zip extensions should be unzipped when they are moved
collisionBehaviorType repositoryManagerCollisionBehaviorTypeEnum An enum value indicating how the system should handle name collisions. If collisionBehaviorType is set to UNIQUE_SUBDIR then unique directory will always be generated even when there are no collisions
operationProfile operationProfile A bean containing information used by the system to notify an external system of the completion status of the job.
filePathOption repositoryManagerFilePathEnum Whether the original file's path should be replaced at the target location.
pathProcessor string representing a path processor plugin component name

Faults

name description
RepositoryManagerWebServiceFault If failed to perform async copy operation.

asynchronousMoveAndUnzip

Asynchronously unzip files from archives, specified by sourcePaths, to folders, specified by destPats parameter. Archives will be deletedafter unzipping.

Input Parameters

name type description
sourcePaths string[] An array of source paths where the files will be moved from.
In format: /nodePath/hotfolderRootPath/filePath.
destPaths string[] An array of destination paths where the files will be moved to.
In format: /nodePath/hotfolderRootPath/filePath.
createContentFiles boolean A boolean indicating whether to create content file for output files
collisionBehaviorType repositoryManagerCollisionBehaviorTypeEnum An enum value indicating how the system should handle name collisions. If collisionBehaviorType is set to UNIQUE_SUBDIR then unique directory will always be generated even when there are no collisions
operationProfile operationProfile A bean containing information used by the system to notify an external system of the completion status of the job.

Faults

name description
RepositoryManagerWebServiceFault If failed to perform async move and unzip operation.

asynchronousMoveAndZip

Asynchronously zip files from archives, specified by sourcePaths, to folders, specified by destPats parameter. Archives will be deletedafter zipping.

Input Parameters

name type description
sourcePaths string[] An array of source paths where the files will be moved from.
In format: /nodePath/hotfolderRootPath/filePath.
outputFilenameMacro string A string that is the output filename macro
destPaths string[] An array of destination paths where the files will be moved to.
In format: /nodePath/hotfolderRootPath/filePath.
archiverFormat archiverFormatEnum the archiver format
compressorFormat compressorFormatEnum the compressor format
createContentFiles boolean A boolean indicating whether to create content file for output files
collisionBehaviorType repositoryManagerCollisionBehaviorTypeEnum An enum value indicating how the system should handle name collisions. If collisionBehaviorType is set to UNIQUE_SUBDIR then unique directory will always be generated even when there are no collisions
operationProfile operationProfile A bean containing information used by the system to notify an external system of the completion status of the job.

Faults

name description
RepositoryManagerWebServiceFault If failed to perform async move and zip operation.

asynchronousPgpDecrypt

Decrypt PGP file

Input Parameters

name type description
sourcePaths string[] sourcePaths An array of source paths where the PGP files will be decrypted.
outputFolders string[] output Folders
pgpPrikey string PGP pri key
passphrase string PGP passphrase
operationProfile operationProfile A bean containing information used by the system to notify an external system of the completion status of the job.

Faults

name description
RepositoryManagerWebServiceFault If failed to perform PGP encryption operation.

asynchronousSearch

Asynchronous search which send callback to continuator with list of strings containing repository paths of files at the path parameterwith paths matching the pattern parameter

Input Parameters

name type description
searchCriterias list<fileDiscoverySearchCriteria> List of search criterias. Each of them contains the root repository path for the search, the regular expression to match and a boolean indicating whether the search should recurse into subdirectories
includeDirectories boolean A Boolean indicating whether directories should be included in the search results
excludePatterns string[] List of regexp patterns of file names to be excluded from search
processId string The unique message ID for process instance. Identifies ESB message which will be used by ESB service continuator.

Faults

name description
RepositoryManagerWebServiceFault (no documentation provided)

changeOperationJobStatus

Change operation job status. This method is invoked by workflow that requires file operations to pause, resume or stop.

Input Parameters

name type description
instanceOrTokenId string (no documentation provided)
statusToChange operationStatus The status to change.

Faults

name description
RepositoryManagerWebServiceFault If an error occurs when updating operation job status.

checkHlsFilset

Check hls fileset

Input Parameters

name type description
repositoryPath string Master manifest repository path

Return Value

type description
list Hls file if fileset is processed, otherwise return null

Faults

name description
RepositoryManagerWebServiceFault If failed to perform fileset check.

checkRepositoryNodePathIsValid

Check if given Repository Node path is valid

Input Parameters

name type description
repositoryNodeName string Repository Node name
relativePathToDestinationFolder string relative path to destination folder (should not contain Repository Node name)

Return Value

type description
boolean True if Repository Node path is valid

copyFolder

Copies a folder and all its contents including content of sub-folders to a new location.

Input Parameters

name type description
sourcePath string The source path where the folder and contents will be copied from.
In format: /nodePath/hotfolderRootPath/filePath.
destinationPath string The destination path where the folder will be copied to.
In format: /nodePath/hotfolderRootPath/filePath.

Faults

name description
RepositoryManagerWebServiceFault If any error occurs while trying to locate or copy the source folder or its contents.

createDirectiory

Creates directory with specified repository path.

Input Parameters

name type description
repositoryPath string The fully qualified path for the repository.

Faults

name description
RepositoryManagerWebServiceFault If the repository path cannot be found or the directory can not be created

createFileUsingBytes

Creates file in provided repositoryPath

Input Parameters

name type description
repositoryPath string The repository path.
fileBytes byte[] Array of file bytes.

Faults

name description
RepositoryManagerWebServiceFault if file cannot be created.

createFileUsingString

Creates file in provided repositoryPath.

Input Parameters

name type description
repositoryPath string The fully qualified path for the repository.
fileContent string text content of file to create.

Faults

name description
RepositoryManagerWebServiceFault if file cannot be created.

deleteFile

Deletes a file by repository path. ContentFile entity will be removed

Input Parameters

name type description
repositoryPath string The fully qualified path for the repository.

Faults

name description
RepositoryManagerWebServiceFault If an error occurs while trying to locate or delete the intended file.

deleteFileByUUID

Deletes content file entity and physical file by contentFileUUID.

Input Parameters

name type description
contentFileUUID string The UUID of the content file to delete.

Faults

name description
RepositoryManagerWebServiceFault if directory cannot be created.

deleteFiles

Deletes the files by repository path list. ContentFile entity will be removed

Input Parameters

name type description
repositoryPathList list The list of the fully qualified paths for the repository.

Faults

name description
RepositoryManagerWebServiceFault If an error occurs while trying to locate or delete the intended file.

deleteFolder

Deletes a file by repository path. ContentFile entity will be removed.

Input Parameters

name type description
repositoryPath string The fully qualified path for the repository.

Faults

name description
RepositoryManagerWebServiceFault If an error occurs while trying to locate or delete the intended folder.

deleteFolderRecursivelyNoContentFiles

Delete folder and files that do not have content files, this is specific method for input files of Armada service.

Input Parameters

name type description
folderPath string the folder path

Faults

name description
RepositoryManagerWebServiceFault the repository manager web service fault

exists

Confirms the existence of a specific path.

Input Parameters

name type description
path string The fully qualified name of the path to confirm.

Return Value

type description
boolean A boolean indicating whether or not the specified path exists.

Faults

name description
RepositoryManagerWebServiceFault If any error occurs while trying to confirm that the path exists.

fileCopy

Enables synchronous file copying. This method is invoked remotely using web services.

Input Parameters

name type description
sourcePath string The source path where the file will be copied from.
destinationPath string The destination path where the file will be copied to.
processId string The unique process ID for this file copy operation.

Faults

name description
RepositoryManagerWebServiceFault If an error occurs when trying to locate or copy the source file.

fileCopyRewrite

Enables synchronous file copying. This method is invoked remotely using web services.

Input Parameters

name type description
sourcePath string The source path where the file will be copied from.
destinationPath string The destination path where the file will be copied to.

Return Value

type description
string repository path to file.

Faults

name description
RepositoryManagerWebServiceFault If an error occurs when trying to locate or copy the source file.

getContentFilesForRepositoryPaths

Returns a List of the ContentFile records representing the repository paths specified in the repositoryPaths parameter. ContentFilerecords may not exist for all supplied paths.

Input Parameters

name type description
repositoryPaths string[] The repository paths of the ContentFiles to be retrieved.

Return Value

type description
list<contentFile> a List of the ContentFile records representing the repository paths specified in the repositoryPaths parameter.

Faults

name description
RepositoryManagerWebServiceFault If failed to get content File for repository paths.

getFileInfo

Returns FileInfo instance for fileObject with specified absolute path.

Input Parameters

name type description
absolutePath string file absolute path

Return Value

type description
FileInfoWrapper information about file at specified absolute path

Faults

name description
RepositoryManagerWebServiceFault error occurs when If failed to perform PGP encryption operationget file information

getFileSize

Reads the value of file size

Input Parameters

name type description
repositoryPath string The repository path.

Return Value

type description
long The file size.

Faults

name description
RepositoryManagerWebServiceFault If the source file cannot be found or if an error occurs when trying to perform the operation.

getRepositoryNodeByName

Gets a RepositoryNode entity based on a specified name.

Input Parameters

name type description
repositoryName string entity name

Return Value

type description
RepositoryNode The RepositoryNode entity at the specified primary key.

Faults

name description
RepositoryManagerWebServiceFault If the repository node cannot be found using the specified name.

getRepositoryNodeByPk

Gets a RepositoryNode entity based on a specified primary key.

Input Parameters

name type description
repositoryNodePk integer entity primary key

Return Value

type description
RepositoryNode The RepositoryNode entity at the specified primary key.

Faults

name description
RepositoryManagerWebServiceFault If the repository node cannot be found using the specified primary key.

getRepositoryNodeByRepositoryPath

Gets a RepositoryNode entity based on a specified repository path.

Input Parameters

name type description
repositoryPath string The path of the repository location.

Return Value

type description
RepositoryNode The RepositoryNode entity at the specified repository path.

Faults

name description
RepositoryManagerWebServiceFault If the repository node cannot be found using the specified repository path.

getRepositoryNodeList

Returns all repository nodes

Return Value

type description
list<RepositoryNode> list of all repository nodes

Faults

name description
RepositoryManagerWebServiceFault error occurs when If failed to retrieve all repository nodes

list

Retrieves lists folders at the specified repository path.

Input Parameters

name type description
repositoryPath string The repository path for which folders (and optionally files) should be listed.
listFiles boolean A boolean value that specifies whether files should be listed for a particular folder within the specified repository path.

Return Value

type description
list list of folders

Faults

name description
RepositoryManagerWebServiceFault If the repository path cannot be found or if an error occurs when getting the folder or filelistings.

listAsFileInfo

Returns list of folders or folders and files at the absolute path specified in the path parameter.

Input Parameters

name type description
absolutePath string (no documentation provided)
listFiles boolean return files as well if true

Return Value

type description
list<FileInfoWrapper> list of file info wrappers

Faults

name description
RepositoryManagerWebServiceFault If the repository path cannot be found

listFile

Retrieves list of files URLs at the repository path specified in the path parameter.

Input Parameters

name type description
repositoryPath string The repository path for which files should be listed.

Return Value

type description
list List of String URLs

Faults

name description
RepositoryManagerWebServiceFault If the repository path cannot be found.

moveFiles

This method has been deprecated.

Performs an move operation on multiple files in a list.

Input Parameters

name type description
sourcePaths string[] An array of source paths where the files will be moved from.
In format: /nodePath/hotfolderRootPath/filePath.
destinationPaths string[] An array of destination paths where the files will be moved to.
In format: /nodePath/hotfolderRootPath/filePath.
processId string The unique message ID for process instance. Identifies ESB message which will be used by ESB service continuator.

Faults

name description
RepositoryManagerWebServiceFault If any error occurs while trying to locate or move the source file.

readFileAsString

Reads file and returns string representation of it

Input Parameters

name type description
repositoryPath string repository path of file that should be read.

Return Value

type description
string string representation of file specified by repository path

Faults

name description
RepositoryManagerWebServiceFault if failed to read file

readXmlFileAsByteArray

Reads xml file as byte array.

Input Parameters

name type description
repositoryPath string The repository path for file which should be read.

Return Value

type description
byte[] The byte array that represents xml file.

Faults

name description
RepositoryManagerWebServiceFault If file could not be read.

readXmlFileAsString

Reads the value of an XML document at a specified location and returns the contents of the XML document.

Input Parameters

name type description
repositoryPath string The repository location path for the XML file.

Return Value

type description
string The contents of the XML file as a String.

Faults

name description
RepositoryManagerWebServiceFault If the specified repository path cannot be resolved, if an error occurs while attempting toreference the physical file, or while trying to read data from the physical file.

rename

Renames a file within the repository.

Input Parameters

name type description
sourcePath string The source path for the file that will be renamed.
In format: /nodePath/hotfolderRootPath/filePath.
renameTo string The new name for the file.

Faults

name description
RepositoryManagerWebServiceFault If the source file cannot be found or if an error occurs when trying to perform the renameoperation.

search

Returns a List of Strings containing repository paths of files at the path parameter with paths matching the pattern parameter

Input Parameters

name type description
path string The root repository path for the search
pattern string A String containing the regular expression to match
recursive boolean A Boolean indicating whether the search should recurse into subdirectories
includeDirectories boolean A Boolean indicating whether directories should be included in the search results
excludePatterns string[] List of regexp patterns of file names to be excluded from search

Return Value

type description
list A list of repository paths representing found files

Faults

name description
RepositoryManagerWebServiceFault (no documentation provided)

verifyMD5Checksum

Calculate MD5 checksum for file and verify against value contained in MD5 file

Input Parameters

name type description
repositoryPath string Repository file path to file to generate checksum for.
md5RepositoryPath string Repository file path to file containing previously generated MD5 checksum.

Return Value

type description
boolean True if generated checksum matches value in MD5 file. False if value does not match.

Faults

name description
RepositoryManagerWebServiceFault If checksum could not be properly generated or verified.