HSM Modules

HSM Modules

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

  • Return : File Object that is used in FileCopy Service.

#storeHSMFile
(FileCopy Service)

Store given File to HSM. Return filename (fileID).

  • Parameter

  • Return : String with filename (fileID of File Entity in DB).

#failedHSMFile
(FileCopy Service)

Called if FileCopy failed.

  • Parameter

  • Return : void

#fetchHSMFile
(TarRetriever Service)

Fetch a File from HSM.

  • Parameter

  • Return : File Object.

#queryStatus
(SyncFileStatus Service)

Query status of file in HSM.

  • Parameter

  • Return : Integer value represents the File Status.