JBoss

JMX MBean View
Back to Agent View Refresh MBean View

MBean description:

Command based HSM Module for File Copy Service.

List of MBean attributes:

Name Type Access Value Description
CopyCommand java.lang.String RW External command to copy files or tarballs to the destination, with
%p will be replaced by the path of file/tarball to copy,
%d will be replaced by the destination file system name,
%f will be replaced by the destination filename
Alternatively a suffix of ':%f' specifies, that the filename on the destination file system shall be returned from the command in stdout.
NONE = write tarball on local accessable file system.
OutgoingDirectory java.lang.String RW Directory from which files/tarballs shall be copied by external CopyCommand. A relative path name is resolved relative to archive-install-directory/server/default/.
FetchCommand java.lang.String RW External command to fetch files/tarballs from the source file system, with
%d will be replaced by the source file system name,
%f will be replaced by the path of tarball on the source file system,
%p will be replaced by the destination path.
NONE = TAR file on local accessable file system.
Note: The destination file given with %p always exists and must be overwritten!
IncomingDirectory java.lang.String RW Directory in which files/tarballs shall be retrieved by external FetchCommand. A relative path name is resolved relative to archive-install-directory/server/default/. Not effective if FetchCommand=NONE
QueryCommand java.lang.String RW Command to query status of specific file.
%d will be replaced by file system name (directory path/mount point),
%f will be replaced by the file path,
%i will be replaced by user info associated with the file system.
Pattern java.lang.String RW Regular expression, applied to stdout of command. Result determines if status is changed to MatchFileStatus or NoMatchFileStatus.
CommandFailedFileStatus java.lang.String RW New file status, if the query command could not be executed. Enumerated values: DEFAULT, TO_ARCHIVE, ARCHIVED, QUERY_HSM_FAILED
NonZeroExitFileStatus java.lang.String RW New file status, if query command returns non-zero exit code. Enumerated values: DEFAULT, TO_ARCHIVE, ARCHIVED, QUERY_HSM_FAILED
NoMatchFileStatus java.lang.String RW New file status, if the query result does NOT match specified pattern. Enumerated values: DEFAULT, TO_ARCHIVE, ARCHIVED, QUERY_HSM_FAILED
MatchFileStatus java.lang.String RW New file status, if the query result does match specified pattern. Enumerated values: DEFAULT, TO_ARCHIVE, ARCHIVED, QUERY_HSM_FAILED
FileCopyServiceName javax.management.ObjectName RW View MBean Used internally. Do NOT modify.
Name java.lang.String R HSMCommandModule 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.

Param ParamType ParamValue ParamDescription
fsID java.lang.String File system ID
filePath java.lang.String File path relative to file system (fsID)
userInfo java.lang.String User info associated with the file system

boolean applyPattern()

Apply pattern to given string

Param ParamType ParamValue ParamDescription
string java.lang.String (no description)