Page tree
Skip to end of metadata
Go to start of metadata

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 : String with filename (fileID of File Entity in DB).

#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 : void

#fetchHSMFile (TarRetriever Service)

Fetch a File from HSM.

  • Parameter

    fsID

    File system ID

    filePath

    File path relative to file system (fsID)

  • Return : File Object.

#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 : Integer value represents the File Status.

    QUERY_HSM_FAILED

    -4

    MD5_CHECK_FAILED

    -3

    VERIFY_COMPRESS_FAILED

    -2

    COMPRESS_FAILED

    -1

    DEFAULT

    0

    TO_ARCHIVE

    1

    ARCHIVED

    2

    COMPRESSING

    3

  • No labels