com.unboundid.ldap.sdk.unboundidds.monitors.DiskSpaceInfo Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of unboundid-ldapsdk Show documentation
Show all versions of unboundid-ldapsdk Show documentation
The UnboundID LDAP SDK for Java is a fast, comprehensive, and easy-to-use
Java API for communicating with LDAP directory servers and performing
related tasks like reading and writing LDIF, encoding and decoding data
using base64 and ASN.1 BER, and performing secure communication. This
package contains the Standard Edition of the LDAP SDK, which is a
complete, general-purpose library for communicating with LDAPv3 directory
servers.
/*
* Copyright 2008-2018 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright (C) 2015-2018 Ping Identity Corporation
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License (GPLv2 only)
* or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see .
*/
package com.unboundid.ldap.sdk.unboundidds.monitors;
import java.io.Serializable;
import com.unboundid.util.NotMutable;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;
/**
* 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
* {@code 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.
*
*/
@NotMutable()
@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public final class DiskSpaceInfo
implements Serializable
{
/**
* The serial version UID for this serializable class.
*/
private static final long serialVersionUID = -7798824641501237274L;
// The number of total bytes at the specified path.
private final Long totalBytes;
// The number of usable bytes at the specified path.
private final Long usableBytes;
// The percentage of the total space that is usable.
private final Long usablePercent;
// The name of the associated disk space consumer.
private final String consumerName;
// The path in which the disk space is being consumed.
private final String path;
/**
* Creates a new disk space info object with the provided information.
*
* @param consumerName The name of the server component which may consume
* disk space.
* @param path The path in which the server component may consume
* disk space.
* @param totalBytes The total amount of space in bytes on the volume
* that holds the specified path.
* @param usableBytes The amount of usable space in bytes on the volume
* that holds the specified path.
* @param usablePercent The percentage of the total space that is usable on
* the volume that holds the specified path.
*/
public DiskSpaceInfo(final String consumerName, final String path,
final Long totalBytes, final Long usableBytes,
final long usablePercent)
{
this.consumerName = consumerName;
this.path = path;
this.totalBytes = totalBytes;
this.usableBytes = usableBytes;
this.usablePercent = usablePercent;
}
/**
* The name of the server component which may consume disk space.
*
* @return The name of the server component which may consume disk space, or
* {@code null} if that is not available.
*/
public String getConsumerName()
{
return consumerName;
}
/**
* Retrieves the path in which the server component may consume disk space.
*
* @return The path in which the server component may consume disk space, or
* {@code null} if that is not available.
*/
public String getPath()
{
return path;
}
/**
* Retrieves the total amount of space in bytes on the volume that holds the
* specified path.
*
* @return The total amount of space in bytes on the volume that holds the
* specified path, or {@code null} if that is not available.
*/
public Long getTotalBytes()
{
return totalBytes;
}
/**
* Retrieves the amount of usable free space in bytes on the volume that holds
* the specified path.
*
* @return The total amount of usable free space in bytes on the volume that
* holds the specified path, or {@code null} if that is not
* available.
*/
public Long getUsableBytes()
{
return usableBytes;
}
/**
* Retrieves the percentage of the total space on the volume that holds the
* specified path which is free and usable by the Directory Server.
*
* @return The percentage of the total space on the volume that holds the
* specified path which is free and usable by the Directory Server.
*/
public Long getUsablePercent()
{
return usablePercent;
}
/**
* Retrieves a string representation of this disk space info object.
*
* @return A string representation of this disk space info object.
*/
@Override()
public String toString()
{
final StringBuilder buffer = new StringBuilder();
toString(buffer);
return buffer.toString();
}
/**
* Appends a string representation of this disk space info object to the
* provided buffer.
*
* @param buffer The buffer to which the information should be appended.
*/
public void toString(final StringBuilder buffer)
{
buffer.append("DiskSpaceInfo(consumerName='");
buffer.append(consumerName);
buffer.append("', path='");
buffer.append(path);
buffer.append("', totalBytes=");
buffer.append(totalBytes);
buffer.append(", usableBytes=");
buffer.append(usableBytes);
buffer.append(", usablePercent=");
buffer.append(usablePercent);
buffer.append(')');
}
}