JBoss

JMX MBean View
Back to Agent View Refresh MBean View

MBean description:

File Based HSM Module Service.
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). This Module is able to handle tar retrievals from FileSystems, which have got a dicey IO behaviour.

List of MBean attributes:

Name Type Access Value Description
IncomingDirectory java.lang.String RW Directory in which files/tarballs shall be retrieved. A relative path name is resolved relative to archive-install-directory/server/default/.
ReadTimeOut int RW Read TimeOut for file access [seconds]
RetentionTime java.lang.String RW Time in y (years), M (month) or d (days) a modification / deletion of a file is not permitted.
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!)
AccessTimeCmd java.lang.String RW External command to set Access Time of a file (retention), with
%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.
DatePattern java.lang.String RW Date pattern that is used to format retention date for %d in AccessTimeCmd.
StatusExtensions java.lang.String RW File extension to File Status mapping.
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).
CheckMD5forStatusChange boolean RW True False 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.
MountFailedCheckFile java.lang.String RW If the specified file exists in the root of an filesystem, this signals a failed mount.
FileCopyServiceName javax.management.ObjectName RW View MBean Used internally. Do NOT modify.
Name java.lang.String R DiceyFSModule The class name of the MBean
State int R 3 The status of the MBean
StateString java.lang.String R Started The status of the MBean in text form

List of MBean operations:

void create()

Standard MBean lifecycle method

void start()

The start lifecycle operation

void stop()

The stop lifecycle operation

void destroy()

The destroy lifecycle operation

void jbossInternalLifecycle()

The detyped lifecycle operation (for internal use only)

Param ParamType ParamValue ParamDescription
method java.lang.String The lifecycle operation

java.io.File prepareHSMFile()

Prepare File for storage to HSM. Return File Object that is used in FileCopy Service.

Param ParamType ParamValue ParamDescription
fsID java.lang.String File system ID
filePath java.lang.String File path relative to file system (fsID)

java.lang.String storeHSMFile()

Store given File to HSM. Return filename (fileID)

Param ParamType ParamValue ParamDescription
file java.io.File File to store in HSM
fsID java.lang.String File system ID
filePath java.lang.String File path relative to file system (fsID)

void failedHSMFile()

Called if FileCopy failed.

Param ParamType ParamValue ParamDescription
file java.io.File File to store in HSM
fsID java.lang.String File system ID
filePath java.lang.String File path relative to file system (fsID)

java.io.File fetchHSMFile()

Fetch a File from HSM.

Param ParamType ParamValue ParamDescription
fsID java.lang.String File system ID
filePath java.lang.String File path relative to file system (fsID)

void fetchHSMFileFinished()

Called from TarRetriever to finish Fetch of a File from HSM. (Cleanup temporary resources)

Param ParamType ParamValue ParamDescription
fsID java.lang.String File system ID
filePath java.lang.String File path relative to file system (fsID)
file java.io.File File object (returned from fetchHSMFile)

java.lang.Integer queryStatus()

Query status of file in HSM.
Check the existence of a file with extensions configured in StatusExtensions and set the corresponding status.

Param ParamType ParamValue ParamDescription
fsID java.lang.String File system ID
filePath java.lang.String File Path
userInfo java.lang.String User info associated with the file system