Command based HSM Module for File Copy Service.
org.dcm4chex.archive.hsm.module.HSMCommandModule
The default constructor
HSMCommandModule
%p will be replaced by the path of file/tarball to copy,
%d will be replaced by the destination file system name,
%f will be replaced by the destination filename
Alternatively a suffix of ':%f' specifies, that the filename
on the destination file system shall be returned from the command
in stdout.
NONE = write tarball on local accessable file system.
]]>
CopyCommand
java.lang.String
CopyCommand. A relative path name is resolved
relative to archive-install-directory/server/default/.]]>
OutgoingDirectory
java.lang.String
%d will be replaced by the source file system name,
%f will be replaced by the path of tarball on the source file system,
%p will be replaced by the destination path.
NONE = TAR file on local accessable file system.
Note: The destination file given with %p always exists and must be overwritten!
]]>
FetchCommand
java.lang.String
FetchCommand. A relative path name is resolved
relative to archive-install-directory/server/default/.
Not effective if FetchCommand=NONE]]>
IncomingDirectory
java.lang.String
%d will be replaced by file system name (directory path/mount point),
%f will be replaced by the file path,
%i will be replaced by user info associated with the file system.
]]>
QueryCommand
java.lang.String
Pattern
java.lang.String
New file status, if the query command could not be executed.
Enumerated values: DEFAULT, TO_ARCHIVE, ARCHIVED, QUERY_HSM_FAILED
CommandFailedFileStatus
java.lang.String
New file status, if query command returns non-zero exit code.
Enumerated values: DEFAULT, TO_ARCHIVE, ARCHIVED, QUERY_HSM_FAILED
NonZeroExitFileStatus
java.lang.String
New file status, if the query result does NOT match specified pattern.
Enumerated values: DEFAULT, TO_ARCHIVE, ARCHIVED, QUERY_HSM_FAILED
NoMatchFileStatus
java.lang.String
New file status, if the query result does match specified pattern.
Enumerated values: DEFAULT, TO_ARCHIVE, ARCHIVED, QUERY_HSM_FAILED
MatchFileStatus
java.lang.String
Used internally. Do NOT modify.
FileCopyServiceName
javax.management.ObjectName
&defaultAttributes;
&defaultOperations;
]]>
prepareHSMFile
File system ID
fsID
java.lang.String
File path relative to file system (fsID)
filePath
java.lang.String
java.io.File
Store given File to HSM. Return filename (fileID)
storeHSMFile
File to store in HSM
file
java.io.File
File system ID
fsID
java.lang.String
File path relative to file system (fsID)
filePath
java.lang.String
java.lang.String
Called if FileCopy failed.
failedHSMFile
File to store in HSM
file
java.io.File
File system ID
fsID
java.lang.String
File path relative to file system (fsID)
filePath
java.lang.String
void
Fetch a File from HSM.
fetchHSMFile
File system ID
fsID
java.lang.String
File path relative to file system (fsID)
filePath
java.lang.String
java.io.File
Called from TarRetriever to finish Fetch of a File from HSM. (Cleanup temporary resources)
fetchHSMFileFinished
File system ID
fsID
java.lang.String
File path relative to file system (fsID)
filePath
java.lang.String
File object (returned from fetchHSMFile)
file
java.io.File
void
Query status of file in HSM.
queryStatus
File system ID
fsID
java.lang.String
File path relative to file system (fsID)
filePath
java.lang.String
User info associated with the file system
userInfo
java.lang.String
java.lang.Integer
Apply pattern to given string
applyPattern
string
java.lang.String
boolean