hadoop-hdfs-project/hadoop-hdfs-client/src/main/java/org/apache/hadoop/hdfs/protocol/DatanodeVolumeInfo.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.hadoop.hdfs.protocol;

import org.apache.hadoop.classification.InterfaceAudience;
import org.apache.hadoop.classification.InterfaceStability;
import org.apache.hadoop.fs.StorageType;
import org.apache.hadoop.util.StringUtils;

/**
 * Locally available datanode volume information.
 */
@InterfaceAudience.Private
@InterfaceStability.Evolving
public class DatanodeVolumeInfo {
  private long usedSpace;
  private long freeSpace;
  private long reservedSpace;
  private long reservedSpaceForReplicas;
  private long numBlocks;
  private StorageType storageType;
  private String path;

  public DatanodeVolumeInfo(String path, long usedSpace, long freeSpace,
      long reservedSpace, long reservedSpaceForReplicas, long numBlocks,
      StorageType type) {
    this.usedSpace = usedSpace;
    this.freeSpace = freeSpace;
    this.reservedSpace = reservedSpace;
    this.reservedSpaceForReplicas = reservedSpaceForReplicas;
    this.numBlocks = numBlocks;
    this.storageType = type;
    this.path = path;
  }

  /** get used space. */
  public long getUsedSpace() {
    return usedSpace;
  }

  /**
   * get free space.
   */
  public long getFreeSpace() {
    return freeSpace;
  }

  /**
   * get reserved space.
   */
  public long getReservedSpace() {
    return reservedSpace;
  }

  /**
   * get reserved space for replicas.
   */
  public long getReservedSpaceForReplicas() {
    return reservedSpaceForReplicas;
  }

  /**
   * get number of blocks.
   */
  public long getNumBlocks() {
    return numBlocks;
  }

  /**
   * get storage type.
   */
  public StorageType getStorageType() {
    return storageType;
  }

  /**
   * get volume path.
   */
  public String getPath() {
    return path;
  }

  /**
   * get volume report.
   */
  public String getDatanodeVolumeReport() {
    StringBuilder report = new StringBuilder();
    report
        .append("Directory: " + path)
        .append("\nStorageType: " + storageType)
        .append(
            "\nCapacity Used: " + usedSpace + "("
                + StringUtils.byteDesc(usedSpace) + ")")
        .append(
            "\nCapacity Left: " + freeSpace + "("
                + StringUtils.byteDesc(freeSpace) + ")")
        .append(
            "\nCapacity Reserved: " + reservedSpace + "("
                + StringUtils.byteDesc(reservedSpace) + ")")
        .append(
            "\nReserved Space for Replicas: " + reservedSpaceForReplicas + "("
                + StringUtils.byteDesc(reservedSpaceForReplicas) + ")")
        .append("\nBlocks: " + numBlocks);
    return report.toString();
  }
}