FederationMBean (Apache Hadoop HDFS-RBF 3.4.1.200-dep-1000 API)

All Known Implementing Classes:

RBFMetrics
```
@Private
@Evolving
public interface FederationMBean
```
JMX interface for the federation statistics.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`java.lang.String`	`getBlockPoolId()`	Deprecated. Use `RouterMBean.getBlockPoolId()` instead.
`java.lang.String`	`getClusterId()`	Deprecated. Use `RouterMBean.getClusterId()` instead.
`java.lang.String`	`getCompiledDate()`	Deprecated. Use `RouterMBean.getCompiledDate()` instead.
`java.lang.String`	`getCompileInfo()`	Deprecated. Use `RouterMBean.getCompileInfo()` instead.
`int`	`getCorruptFilesCount()`	Get the number of corrupts files.
`long`	`getCurrentTokensCount()`	Deprecated. Use `RouterMBean.getCurrentTokensCount()` instead.
`long`	`getHighestPriorityLowRedundancyECBlocks()`	Gets the total number of erasure coded low redundancy blocks on the cluster with the highest risk of loss.
`long`	`getHighestPriorityLowRedundancyReplicatedBlocks()`	Gets the total number of replicated low redundancy blocks on the cluster with the highest risk of loss.
`java.lang.String`	`getHostAndPort()`	Deprecated. Use `RouterMBean.getHostAndPort()` instead.
`java.lang.String`	`getMountTable()`	Get the mount table for the federated filesystem or null if failure.
`java.lang.String`	`getNamenodes()`	Get information about all the namenodes in the federation or null if failure.
`java.lang.String`	`getNameservices()`	Get the latest info for each registered nameservice.
`java.lang.String`	`getNodeUsage()`	Get Max, Median, Min and Standard Deviation of DataNodes usage.
`long`	`getNumberOfMissingBlocksWithReplicationFactorOne()`	Gets the total number of missing blocks on the cluster with replication factor 1.
`long`	`getNumBlocks()`	Get the number of blocks in the federation.
`int`	`getNumDeadNodes()`	Get the number of dead datanodes.
`int`	`getNumDecomDeadNodes()`	Get the number of dead decommissioned datanodes.
`int`	`getNumDecomLiveNodes()`	Get the number of live decommissioned datanodes.
`int`	`getNumDecommissioningNodes()`	Get the number of decommissioning datanodes.
`int`	`getNumEnteringMaintenanceDataNodes()`	Get the number of datanodes which are entering maintenance.
`int`	`getNumExpiredNamenodes()`	Get the number of expired namenodes.
`long`	`getNumFiles()`	Get the number of files in the federation.
`int`	`getNumInMaintenanceDeadDataNodes()`	Get the number of dead datanodes which are under maintenance.
`int`	`getNumInMaintenanceLiveDataNodes()`	Get the number of live datanodes which are under maintenance.
`int`	`getNumLiveNodes()`	Get the number of live datanodes.
`int`	`getNumNamenodes()`	Get the number of namenodes.
`int`	`getNumNameservices()`	Get the number of nameservices in the federation.
`long`	`getNumOfBlocksPendingDeletion()`	Get the number of pending deletion blocks in the federation.
`long`	`getNumOfBlocksPendingReplication()`	Get the number of pending replication blocks in the federation.
`long`	`getNumOfBlocksUnderReplicated()`	Get the number of under replicated blocks in the federation.
`long`	`getNumOfMissingBlocks()`	Get the number of missing blocks in the federation.
`int`	`getNumStaleNodes()`	Get the number of stale datanodes.
`int`	`getPendingSPSPaths()`	Returns the number of paths to be processed by storage policy satisfier.
`long`	`getProvidedSpace()`	Get the total remote storage capacity mounted in the federated cluster.
`long`	`getRemainingCapacity()`	Get the remaining capacity of the federated cluster.
`java.math.BigInteger`	`getRemainingCapacityBigInt()`	Get the remaining capacity (big integer) of the federated cluster.
`java.lang.String`	`getRouterId()`	Deprecated. Use `RouterMBean.getRouterId()` instead.
`java.lang.String`	`getRouters()`	Get the latest state of all routers.
`java.lang.String`	`getRouterStarted()`	Deprecated. Use `RouterMBean.getRouterStarted()` instead.
`java.lang.String`	`getRouterStatus()`	Deprecated. Use `RouterMBean.getRouterStatus()` instead.
`long`	`getScheduledReplicationBlocks()`	Blocks scheduled for replication.
`long`	`getTotalCapacity()`	Get the total capacity of the federated cluster.
`java.math.BigInteger`	`getTotalCapacityBigInt()`	Get the total capacity (big integer) of the federated cluster.
`long`	`getUsedCapacity()`	Get the used capacity of the federated cluster.
`java.math.BigInteger`	`getUsedCapacityBigInt()`	Get the used capacity (big integer) of the federated cluster.
`java.lang.String`	`getVersion()`	Deprecated. Use `RouterMBean.getVersion()` instead.
`boolean`	`isSecurityEnabled()`	Deprecated. Use `RouterMBean.isSecurityEnabled()` instead.

- Method Detail
  - getNamenodes
```
java.lang.String getNamenodes()
```
    Get information about all the namenodes in the federation or null if failure.
    
    Returns:
    
    JSON with all the Namenodes.
  - getNameservices
```
java.lang.String getNameservices()
```
    Get the latest info for each registered nameservice.
    
    Returns:
    
    JSON with all the nameservices.
  - getMountTable
```
java.lang.String getMountTable()
```
    Get the mount table for the federated filesystem or null if failure.
    
    Returns:
    
    JSON with the mount table.
  - getRouters
```
java.lang.String getRouters()
```
    Get the latest state of all routers.
    
    Returns:
    
    JSON with all the known routers or null if failure.
  - getTotalCapacity
```
long getTotalCapacity()
```
    Get the total capacity of the federated cluster. The number could overflow if too big. In that case use getTotalCapacityBigInt() instead.
    
    Returns:
    
    Total capacity of the federated cluster.
  - getUsedCapacity
```
long getUsedCapacity()
```
    Get the used capacity of the federated cluster. The number could overflow if too big. In that case use getUsedCapacityBigInt() instead.
    
    Returns:
    
    Used capacity of the federated cluster.
  - getRemainingCapacity
```
long getRemainingCapacity()
```
    Get the remaining capacity of the federated cluster. The number could overflow if too big. In that case use getRemainingCapacityBigInt() instead.
    
    Returns:
    
    Remaining capacity of the federated cluster.
  - getTotalCapacityBigInt
```
java.math.BigInteger getTotalCapacityBigInt()
```
    Get the total capacity (big integer) of the federated cluster.
    
    Returns:
    
    Total capacity of the federated cluster.
  - getUsedCapacityBigInt
```
java.math.BigInteger getUsedCapacityBigInt()
```
    Get the used capacity (big integer) of the federated cluster.
    
    Returns:
    
    Used capacity of the federated cluster.
  - getRemainingCapacityBigInt
```
java.math.BigInteger getRemainingCapacityBigInt()
```
    Get the remaining capacity (big integer) of the federated cluster.
    
    Returns:
    
    Remaining capacity of the federated cluster.
  - getProvidedSpace
```
long getProvidedSpace()
```
    Get the total remote storage capacity mounted in the federated cluster.
    
    Returns:
    
    Remote capacity of the federated cluster.
  - getNumNameservices
```
int getNumNameservices()
```
    Get the number of nameservices in the federation.
    
    Returns:
    
    Number of nameservices in the federation.
  - getNumNamenodes
```
int getNumNamenodes()
```
    Get the number of namenodes.
    
    Returns:
    
    Number of namenodes.
  - getNumExpiredNamenodes
```
int getNumExpiredNamenodes()
```
    Get the number of expired namenodes.
    
    Returns:
    
    Number of expired namenodes.
  - getNumLiveNodes
```
int getNumLiveNodes()
```
    Get the number of live datanodes.
    
    Returns:
    
    Number of live datanodes.
  - getNumDeadNodes
```
int getNumDeadNodes()
```
    Get the number of dead datanodes.
    
    Returns:
    
    Number of dead datanodes.
  - getNumStaleNodes
```
int getNumStaleNodes()
```
    Get the number of stale datanodes.
    
    Returns:
    
    Number of stale datanodes.
  - getNumDecommissioningNodes
```
int getNumDecommissioningNodes()
```
    Get the number of decommissioning datanodes.
    
    Returns:
    
    Number of decommissioning datanodes.
  - getNumDecomLiveNodes
```
int getNumDecomLiveNodes()
```
    Get the number of live decommissioned datanodes.
    
    Returns:
    
    Number of live decommissioned datanodes.
  - getNumDecomDeadNodes
```
int getNumDecomDeadNodes()
```
    Get the number of dead decommissioned datanodes.
    
    Returns:
    
    Number of dead decommissioned datanodes.
  - getNumInMaintenanceLiveDataNodes
```
int getNumInMaintenanceLiveDataNodes()
```
    Get the number of live datanodes which are under maintenance.
    
    Returns:
    
    Number of live datanodes which are under maintenance.
  - getNumInMaintenanceDeadDataNodes
```
int getNumInMaintenanceDeadDataNodes()
```
    Get the number of dead datanodes which are under maintenance.
    
    Returns:
    
    Number of dead datanodes which are under maintenance.
  - getNumEnteringMaintenanceDataNodes
```
int getNumEnteringMaintenanceDataNodes()
```
    Get the number of datanodes which are entering maintenance.
    
    Returns:
    
    Number of datanodes which are entering maintenance.
  - getNodeUsage
```
java.lang.String getNodeUsage()
```
    Get Max, Median, Min and Standard Deviation of DataNodes usage.
    
    Returns:
    
    the DataNode usage information, as a JSON string.
  - getNumBlocks
```
long getNumBlocks()
```
    Get the number of blocks in the federation.
    
    Returns:
    
    Number of blocks in the federation.
  - getNumOfMissingBlocks
```
long getNumOfMissingBlocks()
```
    Get the number of missing blocks in the federation.
    
    Returns:
    
    Number of missing blocks in the federation.
  - getNumOfBlocksPendingReplication
```
long getNumOfBlocksPendingReplication()
```
    Get the number of pending replication blocks in the federation.
    
    Returns:
    
    Number of pending replication blocks in the federation.
  - getNumOfBlocksUnderReplicated
```
long getNumOfBlocksUnderReplicated()
```
    Get the number of under replicated blocks in the federation.
    
    Returns:
    
    Number of under replicated blocks in the federation.
  - getNumOfBlocksPendingDeletion
```
long getNumOfBlocksPendingDeletion()
```
    Get the number of pending deletion blocks in the federation.
    
    Returns:
    
    Number of pending deletion blocks in the federation.
  - getNumFiles
```
long getNumFiles()
```
    Get the number of files in the federation.
    
    Returns:
    
    Number of files in the federation.
  - getRouterStarted
```
@Deprecated
java.lang.String getRouterStarted()
```
    Deprecated.
    Use RouterMBean.getRouterStarted() instead.
    
    When the router started.
    
    Returns:
    
    Date as a string the router started.
  - getVersion
```
@Deprecated
java.lang.String getVersion()
```
    Deprecated.
    Use RouterMBean.getVersion() instead.
    
    Get the version of the router.
    
    Returns:
    
    Version of the router.
  - getCompiledDate
```
@Deprecated
java.lang.String getCompiledDate()
```
    Deprecated.
    Use RouterMBean.getCompiledDate() instead.
    
    Get the compilation date of the router.
    
    Returns:
    
    Compilation date of the router.
  - getCompileInfo
```
@Deprecated
java.lang.String getCompileInfo()
```
    Deprecated.
    Use RouterMBean.getCompileInfo() instead.
    
    Get the compilation info of the router.
    
    Returns:
    
    Compilation info of the router.
  - getHostAndPort
```
@Deprecated
java.lang.String getHostAndPort()
```
    Deprecated.
    Use RouterMBean.getHostAndPort() instead.
    
    Get the host and port of the router.
    
    Returns:
    
    Host and port of the router.
  - getRouterId
```
@Deprecated
java.lang.String getRouterId()
```
    Deprecated.
    Use RouterMBean.getRouterId() instead.
    
    Get the identifier of the router.
    
    Returns:
    
    Identifier of the router.
  - getClusterId
```
java.lang.String getClusterId()
```
    Deprecated.
    Use RouterMBean.getClusterId() instead.
    
    Gets the cluster ids of the namenodes.
    
    Returns:
    
    the cluster ids of the namenodes.
  - getBlockPoolId
```
@Deprecated
java.lang.String getBlockPoolId()
```
    Deprecated.
    Use RouterMBean.getBlockPoolId() instead.
    
    Gets the block pool ids of the namenodes.
    
    Returns:
    
    the block pool ids of the namenodes.
  - getRouterStatus
```
@Deprecated
java.lang.String getRouterStatus()
```
    Deprecated.
    Use RouterMBean.getRouterStatus() instead.
    
    Get the current state of the router.
    
    Returns:
    
    String label for the current router state.
  - getCurrentTokensCount
```
@Deprecated
long getCurrentTokensCount()
```
    Deprecated.
    Use RouterMBean.getCurrentTokensCount() instead.
    
    Get the current number of delegation tokens in memory.
    
    Returns:
    
    number of DTs
  - isSecurityEnabled
```
@Deprecated
boolean isSecurityEnabled()
```
    Deprecated.
    Use RouterMBean.isSecurityEnabled() instead.
    
    Get the security status of the router.
    
    Returns:
    
    Security status.
  - getCorruptFilesCount
```
int getCorruptFilesCount()
```
    Get the number of corrupts files.
    
    Returns:
    
    the total number of corrupt files.
  - getScheduledReplicationBlocks
```
long getScheduledReplicationBlocks()
```
    Blocks scheduled for replication.
    
    Returns:
    
    num of blocks scheduled for replication.
  - getNumberOfMissingBlocksWithReplicationFactorOne
```
long getNumberOfMissingBlocksWithReplicationFactorOne()
```
    Gets the total number of missing blocks on the cluster with replication factor 1.
    
    Returns:
    
    the total number of missing blocks on the cluster with replication factor 1.
  - getHighestPriorityLowRedundancyReplicatedBlocks
```
long getHighestPriorityLowRedundancyReplicatedBlocks()
```
    Gets the total number of replicated low redundancy blocks on the cluster with the highest risk of loss.
    
    Returns:
    
    the total number of low redundancy blocks on the cluster with the highest risk of loss.
  - getHighestPriorityLowRedundancyECBlocks
```
long getHighestPriorityLowRedundancyECBlocks()
```
    Gets the total number of erasure coded low redundancy blocks on the cluster with the highest risk of loss.
    
    Returns:
    
    the total number of low redundancy blocks on the cluster with the highest risk of loss.
  - getPendingSPSPaths
```
int getPendingSPSPaths()
```
    Returns the number of paths to be processed by storage policy satisfier.
    
    Returns:
    
    The number of paths to be processed by sps.

Interface FederationMBean

Method Summary

Method Detail

getNamenodes

getNameservices

getMountTable

getRouters

getTotalCapacity

getUsedCapacity

getRemainingCapacity

getTotalCapacityBigInt

getUsedCapacityBigInt

getRemainingCapacityBigInt

getProvidedSpace

getNumNameservices

getNumNamenodes

getNumExpiredNamenodes

getNumLiveNodes

getNumDeadNodes

getNumStaleNodes

getNumDecommissioningNodes

getNumDecomLiveNodes

getNumDecomDeadNodes

getNumInMaintenanceLiveDataNodes

getNumInMaintenanceDeadDataNodes

getNumEnteringMaintenanceDataNodes

getNodeUsage

getNumBlocks

getNumOfMissingBlocks

getNumOfBlocksPendingReplication

getNumOfBlocksUnderReplicated

getNumOfBlocksPendingDeletion

getNumFiles

getRouterStarted

getVersion

getCompiledDate

getCompileInfo

getHostAndPort

getRouterId

getClusterId

getBlockPoolId

getRouterStatus

getCurrentTokensCount

isSecurityEnabled

getCorruptFilesCount

getScheduledReplicationBlocks

getNumberOfMissingBlocksWithReplicationFactorOne

getHighestPriorityLowRedundancyReplicatedBlocks

getHighestPriorityLowRedundancyECBlocks

getPendingSPSPaths