This File Based Module supports a WORM (write once, read many) like storage.
Therefore the file is set to readonly.
The access time of the file is set to current date + RetentionTime to indicate how long
a file should be in WORM state.
(This feature must be supported by the underlying filesystem/storage!)
This module supports synchronization of file status by checking existence
of files with specific extendions (see StatusExtensions and queryStatus).
]]>
org.dcm4chex.archive.hsm.module.HSMFileBasedModule
The default constructor
HSMFileBasedModule
Use a leading '+' to set access time after the file is set ReadOnly. (default is before ;
Please ensure that your filesystem/command allows setting access time when file is ReadOnly!)
]]>
RetentionTime
java.lang.String
%f will be replaced by the file
%d will be replaced by the retention date (current date + retentionTime)
NONE = Access Time of file will not be changed.
]]>
AccessTimeCmd
java.lang.String
DatePattern
java.lang.String
Used in queryStatus to get actual status of a file.
Enumerated status values: DEFAULT, TO_ARCHIVE, ARCHIVED, QUERY_HSM_FAILED
Format: <extension>=<status>
A entry without <extension>= is used if no file with configured extension exists.
This could also be set to NONE (do not change the file status).
]]>
StatusExtensions
java.lang.String
Enable verification of tar files when a status file (file with status extension) exists.
Set file status to MD5_CHECK_FAILED (-3) if verify failed.
CheckMD5forStatusChange
boolean
MountFailedCheckFile
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
Check the existence of a file with extensions configured in
StatusExtensions and set the corresponding status.
]]>
queryStatus
File system ID
fsID
java.lang.String
File Path
filePath
java.lang.String
User info associated with the file system
userInfo
java.lang.String
java.lang.Integer