JBoss

JMX MBean View
Back to Agent View Refresh MBean View

MBean description:

Check File Status Service.

List of MBean attributes:

Name Type Access Value Description
MonitoredFileSystem java.lang.String RW Directory/Mount Point of the monitored File System. NONE = disabled this service.
HSMModulServicename java.lang.String RW HSM Module to query status of files on HSM systems.
MinimumFileAge java.lang.String RW Only files created longer ago than the specified intervall ##w (in weeks), ##d (in days), ##h (in hours) are checked for status change.
CheckFileStatus java.lang.String RW Checks files with the specified status for status change. Enumerated values: DEFAULT, TO_ARCHIVE, ARCHIVED, QUERY_HSM_FAILED
VerifyTar boolean RW True False Enables verification of tar files.
If enabled the tar file is verified by
1) checking MD5 sums of the tar content.
2) check if tar file contains the file.
Only applicable if filesystem is a tar filesystem!
SkipVerifyTarHSMStati java.lang.String RW List of HSM stati for which tar verify should be skipped.
Enumerated values: DEFAULT, TO_ARCHIVE, ARCHIVED, QUERY_HSM_FAILED or NONE.
Optionally HSM status can be overwritten by <hsmStatus>=<newStatus>
newStatus can be DEFAULT, TO_ARCHIVE, ARCHIVED, QUERY_HSM_FAILED or DELETE.
Only applicable if VeryfyTar is enabled!
InvalidTarStatus java.lang.String RW New file status or DELETE if verification of tar failed.
Enumerated values: DELETE or DEFAULT, TO_ARCHIVE, ARCHIVED, QUERY_HSM_FAILED, MD5_CHECK_FAILED
DELETE..Delete all file entities related to this invalid tar file.
Only applicable if VerifyTar is enabled.
NotInTarStatus java.lang.String RW New file status or DELETE if file is not found in related tar file.
Enumerated values: DELETE or DEFAULT, TO_ARCHIVE, ARCHIVED, QUERY_HSM_FAILED
DELETE..Delete such invalid file entities. Only applicable if VerifyTar is enabled.
TaskInterval java.lang.String RW Interval in which the File status is checked.
Format:
interval!from-to or NEVER
interval = ##m (in minutes), ##h (in hours).
from = start hour (0-23) when no file status check should be performed
to = end hour (0-23) when no file status check should be performed
NEVER = disable file status checking
Example:
1h!9-17 means every hour, synchronize file status, except between the hours of 9:00am and 5:00pm. By setting this type of TaskInterval, you can perform file status synchronisation outside of peak hours.
OldestCreatedTimeOfCheckFileStatus java.lang.String R UNKNOWN Creation Date of oldest file on configured filesystem with file status of configured CheckFileStatus.
NumberOfFilesPerTask int RW Maximum number of files which are checked for status change in one task.
isRunning boolean R False Current state if syncFileStatus task is running. Used to avoid concurrency!
TimerIDCheckSyncFileStatus java.lang.String RW Used internally. Do NOT modify.
TarRetrieverName javax.management.ObjectName RW View MBean Used internally. Do NOT modify.
SchedulerServiceName javax.management.ObjectName RW View MBean Used internally. Do NOT modify.
Name java.lang.String R SyncFileStatusService 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

int check()

Check files for status changes.
Return number of updated files or -1 if check is already running (Timer).

void updateOldestCreatedTimeOfCheckFileStatus()

Update OldestCreatedTimeOfCheckFileStatus. This will be done automatically every day after midnight if this service is enabled.

int syncArchivedStatusOfInstances()

Set ARCHIVED flag of Instances where files on given file system has file_status=2 (ARCHIVED).
This can be used to update instances that are already copied with a version prior to 2.16.0.

Param ParamType ParamValue ParamDescription
fsID java.lang.String File System ID where files must have file status ARCHIVED.
limit java.lang.String Limit number of files that are processed. (values < 1 --> default of 1000)