Description
HSM Modules are MBeans that implements a set of operations to store, retrieve and query Files of a specific HSM system.
Each module should register/unregister to a FileCopy service.
This behaviour is already implemented in class AbstractHSMModule by calling registerHSMModule in startService() and unregisterHSMModule in stopService() of the configured FileCopy service.
Dependencies
Operations
#prepareHSMFile (FileCopy Service)
Prepare File for storage to HSM. Return File Object that is used in FileCopy Service.
- Parameter
fsID
File system ID
filePath
File path relative to file system (fsID)
- Return : File Object that is used in FileCopy Service.
#storeHSMFile (FileCopy Service)
Store given File to HSM. Return filename (fileID).
- Parameter
file
File to store in HSM
fsID
File system ID
filePath
File path relative to file system (fsID)
- Return : File Object that is used in FileCopy Service.
#failedHSMFile (FileCopy Service)
Called if FileCopy failed.
- Parameter
file
File to store in HSM
fsID
File system ID
filePath
File path relative to file system (fsID)
- Return : File Object that is used in FileCopy Service.
#fetchHSMFile (TarRetriever Service)
Fetch a File from HSM.
- Parameter
fsID
File system ID
filePath
File path relative to file system (fsID)
- Return : File Object that is used in FileCopy Service.
#queryStatus (SyncFileStatus Service)
Query status of file in HSM.
- Parameter
fsID
File system ID
filePath
File path relative to file system (fsID)
userInfo
User info associated with the file system
- Return : File Object that is used in FileCopy Service.