Package com.unboundid.ldap.sdk.unboundidds.monitors

Class DiskSpaceInfo

  • All Implemented Interfaces:
    java.io.Serializable
    @NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class DiskSpaceInfo
extends java.lang.Object
implements java.io.Serializable
    This class provides a data structure that may be used to hold information about disk space information for a Directory Server component.
    NOTE: This class, and other classes within the com.unboundid.ldap.sdk.unboundidds package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      DiskSpaceInfo​(java.lang.String consumerName, java.lang.String path, java.lang.Long totalBytes, java.lang.Long usableBytes, long usablePercent)
      Deprecated.
      Use the constructor that takes a Long object for the usableBytes parameter.
      DiskSpaceInfo​(java.lang.String consumerName, java.lang.String path, java.lang.Long totalBytes, java.lang.Long usableBytes, java.lang.Long usablePercent)
      Creates a new disk space info object with the provided information.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getConsumerName()
      The name of the server component which may consume disk space.
      java.lang.String getPath()
      Retrieves the path in which the server component may consume disk space.
      java.lang.Long getTotalBytes()
      Retrieves the total amount of space in bytes on the volume that holds the specified path.
      java.lang.Long getUsableBytes()
      Retrieves the amount of usable free space in bytes on the volume that holds the specified path.
      java.lang.Long getUsablePercent()
      Retrieves the percentage of the total space on the volume that holds the specified path which is free and usable by the Directory Server.
      java.lang.String toString()
      Retrieves a string representation of this disk space info object.
      void toString​(java.lang.StringBuilder buffer)
      Appends a string representation of this disk space info object to the provided buffer.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • DiskSpaceInfo

        @Deprecated
public DiskSpaceInfo​(@Nullable
                     java.lang.String consumerName,
                     @Nullable
                     java.lang.String path,
                     @Nullable
                     java.lang.Long totalBytes,
                     @Nullable
                     java.lang.Long usableBytes,
                     long usablePercent)
        Deprecated.
        Use the constructor that takes a Long object for the usableBytes parameter.
        Creates a new disk space info object with the provided information.
        Parameters:
        consumerName - The name of the server component which may consume disk space.
        path - The path in which the server component may consume disk space.
        totalBytes - The total amount of space in bytes on the volume that holds the specified path.
        usableBytes - The amount of usable space in bytes on the volume that holds the specified path.
        usablePercent - The percentage of the total space that is usable on the volume that holds the specified path.

      • DiskSpaceInfo

        public DiskSpaceInfo​(@Nullable
                     java.lang.String consumerName,
                     @Nullable
                     java.lang.String path,
                     @Nullable
                     java.lang.Long totalBytes,
                     @Nullable
                     java.lang.Long usableBytes,
                     @Nullable
                     java.lang.Long usablePercent)
        Creates a new disk space info object with the provided information.
        Parameters:
        consumerName - The name of the server component which may consume disk space.
        path - The path in which the server component may consume disk space.
        totalBytes - The total amount of space in bytes on the volume that holds the specified path.
        usableBytes - The amount of usable space in bytes on the volume that holds the specified path.
        usablePercent - The percentage of the total space that is usable on the volume that holds the specified path.

    • Method Detail

      • getConsumerName

        @Nullable
public java.lang.String getConsumerName()
        The name of the server component which may consume disk space.
        Returns:
        The name of the server component which may consume disk space, or null if that is not available.

      • getPath

        @Nullable
public java.lang.String getPath()
        Retrieves the path in which the server component may consume disk space.
        Returns:
        The path in which the server component may consume disk space, or null if that is not available.

      • getTotalBytes

        @Nullable
public java.lang.Long getTotalBytes()
        Retrieves the total amount of space in bytes on the volume that holds the specified path.
        Returns:
        The total amount of space in bytes on the volume that holds the specified path, or null if that is not available.

      • getUsableBytes

        @Nullable
public java.lang.Long getUsableBytes()
        Retrieves the amount of usable free space in bytes on the volume that holds the specified path.
        Returns:
        The total amount of usable free space in bytes on the volume that holds the specified path, or null if that is not available.

      • getUsablePercent

        @Nullable
public java.lang.Long getUsablePercent()
        Retrieves the percentage of the total space on the volume that holds the specified path which is free and usable by the Directory Server.
        Returns:
        The percentage of the total space on the volume that holds the specified path which is free and usable by the Directory Server.

      • toString

        @NotNull
public java.lang.String toString()
        Retrieves a string representation of this disk space info object.
        Overrides:
        toString in class java.lang.Object
        Returns:
        A string representation of this disk space info object.

      • toString

        public void toString​(@NotNull
                     java.lang.StringBuilder buffer)
        Appends a string representation of this disk space info object to the provided buffer.
        Parameters:
        buffer - The buffer to which the information should be appended.