JmxManagerView (TrueZIP Extension JMX/JUL 7.4.2 API)

java.lang.Object
- javax.management.StandardMBean
- - de.schlichtherle.truezip.fs.inst.jmx.JmxManagerView

All Implemented Interfaces:

JmxManagerViewMXBean, DynamicMBean, MBeanRegistration
```
@DefaultAnnotation(value=edu.umd.cs.findbugs.annotations.NonNull.class)
final class JmxManagerView
extends StandardMBean
implements JmxManagerViewMXBean
```
The MXBean implementation for a file system manager.

Author:

Christian Schlichtherle

Field Summary

Fields
Modifier and Type Field and Description

private static MBeanServer mbs

private FsManager model

private static BitField<FsSyncOption> SYNC_OPTIONS

Fields
Modifier and Type	Field and Description
`private static MBeanServer`	`mbs`
`private FsManager`	`model`
`private static BitField<FsSyncOption>`	`SYNC_OPTIONS`

Constructor Summary

Constructors
Modifier Constructor and Description

private JmxManagerView(FsManager model)

Constructors
Modifier	Constructor and Description
`private`	`JmxManagerView(FsManager model)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clearStatistics()`
`protected String`	`getDescription(MBeanAttributeInfo info)`
`protected String`	`getDescription(MBeanInfo info)`
`protected String`	`getDescription(MBeanOperationInfo info)` Override customization hook: You can supply a customized description for MBeanOperationInfo.getDescription()
`protected String`	`getDescription(MBeanOperationInfo op, MBeanParameterInfo param, int sequence)` Override customization hook: You can supply a customized description for MBeanParameterInfo.getDescription()
`JmxModelViewMXBean[]`	`getFederatedFileSystems()` Returns a new array of all managed federated file systems.
`int`	`getFileSystemsTotal()` Returns the total number of managed federated file systems.
`int`	`getFileSystemsTouched()` Returns the number of managed federated file systems which have been touched and need synchronization by calling `FsManager.sync(de.schlichtherle.truezip.util.BitField<de.schlichtherle.truezip.fs.FsSyncOption>)`.
`MBeanInfo`	`getMBeanInfo()`
`MBeanNotificationInfo[]`	`getNotificationInfo()`
`private static ObjectName`	`getObjectName(FsManager model)`
`protected String`	`getParameterName(MBeanOperationInfo op, MBeanParameterInfo param, int sequence)` Override customization hook: You can supply a customized description for MBeanParameterInfo.getName()
`int`	`getTopLevelFileSystemsTotal()` Returns the total number of managed top level federated file systems.
`int`	`getTopLevelFileSystemsTouched()` Returns the number of managed top level federated file systems which have been touched and need synchronization by calling `FsManager.sync(de.schlichtherle.truezip.util.BitField<de.schlichtherle.truezip.fs.FsSyncOption>)`.
`(package private) static JmxManagerViewMXBean`	`register(FsManager model)`
`void`	`umount()` Unmounts all managed federated file systems.
`(package private) static void`	`unregister(FsManager model)`

Methods inherited from class javax.management.StandardMBean
cacheMBeanInfo, getAttribute, getAttributes, getCachedMBeanInfo, getClassName, getConstructors, getDescription, getDescription, getDescription, getImpact, getImplementation, getImplementationClass, getMBeanInterface, getParameterName, invoke, postDeregister, postRegister, preDeregister, preRegister, setAttribute, setAttributes, setImplementation

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - mbs
```
private static final MBeanServer mbs
```
  - model
```
private final FsManager model
```
  - SYNC_OPTIONS
```
private static final BitField<FsSyncOption> SYNC_OPTIONS
```
- Constructor Detail
  - JmxManagerView
```
private JmxManagerView(FsManager model)
```
- Method Detail
  - clearStatistics
```
public void clearStatistics()
```
    Specified by:
    
    clearStatistics in interface JmxManagerViewMXBean
  - getDescription
```
protected String getDescription(MBeanAttributeInfo info)
```
    Overrides:
    
    getDescription in class StandardMBean
  - getDescription
```
protected String getDescription(MBeanInfo info)
```
    Overrides:
    
    getDescription in class StandardMBean
  - getDescription
```
protected String getDescription(MBeanOperationInfo info)
```
    Override customization hook: You can supply a customized description for MBeanOperationInfo.getDescription()
    
    Overrides:
    
    getDescription in class StandardMBean
  - getDescription
```
protected String getDescription(MBeanOperationInfo op,
                    MBeanParameterInfo param,
                    int sequence)
```
    Override customization hook: You can supply a customized description for MBeanParameterInfo.getDescription()
    
    Overrides:
    
    getDescription in class StandardMBean
  - getFederatedFileSystems
```
public JmxModelViewMXBean[] getFederatedFileSystems()
```
    Description copied from interface: JmxManagerViewMXBean
    
    Returns a new array of all managed federated file systems.
    
    Specified by:
    
    getFederatedFileSystems in interface JmxManagerViewMXBean
    
    Returns:
    A new array of all managed federated file systems.
  - getFileSystemsTotal
```
public int getFileSystemsTotal()
```
    Description copied from interface: JmxManagerViewMXBean
    
    Returns the total number of managed federated file systems.
    
    Specified by:
    
    getFileSystemsTotal in interface JmxManagerViewMXBean
  - getFileSystemsTouched
```
public int getFileSystemsTouched()
```
    Description copied from interface: JmxManagerViewMXBean
    
    Returns the number of managed federated file systems which have been touched and need synchronization by calling FsManager.sync(de.schlichtherle.truezip.util.BitField<de.schlichtherle.truezip.fs.FsSyncOption>).
    Note that you should not use the returned value to synchronize conditionally - this is unreliable!
    
    Specified by:
    
    getFileSystemsTouched in interface JmxManagerViewMXBean
  - getMBeanInfo
```
public MBeanInfo getMBeanInfo()
```
    Specified by:
    
    getMBeanInfo in interface DynamicMBean
    
    Overrides:
    
    getMBeanInfo in class StandardMBean
  - getNotificationInfo
```
public MBeanNotificationInfo[] getNotificationInfo()
```
  - getObjectName
```
private static ObjectName getObjectName(FsManager model)
```
  - getParameterName
```
protected String getParameterName(MBeanOperationInfo op,
                      MBeanParameterInfo param,
                      int sequence)
```
    Override customization hook: You can supply a customized description for MBeanParameterInfo.getName()
    
    Overrides:
    
    getParameterName in class StandardMBean
  - getTopLevelFileSystemsTotal
```
public int getTopLevelFileSystemsTotal()
```
    Description copied from interface: JmxManagerViewMXBean
    
    Returns the total number of managed top level federated file systems.
    
    Specified by:
    
    getTopLevelFileSystemsTotal in interface JmxManagerViewMXBean
  - getTopLevelFileSystemsTouched
```
public int getTopLevelFileSystemsTouched()
```
    Description copied from interface: JmxManagerViewMXBean
    
    Returns the number of managed top level federated file systems which have been touched and need synchronization by calling FsManager.sync(de.schlichtherle.truezip.util.BitField<de.schlichtherle.truezip.fs.FsSyncOption>).
    
    Specified by:
    
    getTopLevelFileSystemsTouched in interface JmxManagerViewMXBean
  - register
```
static JmxManagerViewMXBean register(FsManager model)
```
  - umount
```
public void umount()
            throws FsSyncException
```
    Description copied from interface: JmxManagerViewMXBean
    
    Unmounts all managed federated file systems.
    
    Specified by:
    
    umount in interface JmxManagerViewMXBean
    
    Throws:
    
    FsSyncException - If any managed federated file system is busy with I/O.
  - unregister
```
static void unregister(FsManager model)
```

Class JmxManagerView

Field Summary

Constructor Summary

Method Summary

Methods inherited from class javax.management.StandardMBean

Methods inherited from class java.lang.Object

Field Detail

mbs

model

SYNC_OPTIONS

Constructor Detail

JmxManagerView

Method Detail

clearStatistics

getDescription

getDescription

getDescription

getDescription

getFederatedFileSystems

getFileSystemsTotal

getFileSystemsTouched

getMBeanInfo

getNotificationInfo

getObjectName

getParameterName

getTopLevelFileSystemsTotal

getTopLevelFileSystemsTouched

register

umount

unregister