com.unboundid.ldap.sdk.unboundidds.monitors.ResultCodeInfo 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
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.
There is a newer version: 7.0.2
Show newest version
/*
 * Copyright 2014-2023 Ping Identity Corporation
 * All Rights Reserved.
 */
/*
 * Copyright 2014-2023 Ping Identity Corporation
 *
 * Licensed 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.
 */
/*
 * Copyright (C) 2014-2023 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.ldap.sdk.OperationType;
import com.unboundid.util.NotMutable;
import com.unboundid.util.NotNull;
import com.unboundid.util.Nullable;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;



/**
 * This class provides a data structure that encapsulates information about a
 * result code included in the result code monitor entry.
 * 

 * 
 *   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 ResultCodeInfo
       implements Serializable
{
  /**
   * The serial version UID for this serializable class.
   */
  private static final long serialVersionUID = 1223217954357101681L;



  // The average response time, in milliseconds, for operations with this result
  // code.
  private final double averageResponseTimeMillis;

  // The percent of operations of the associated type with this result code.
  private final double percent;

  // The sum of all response times, in milliseconds, for operations with this
  // result code.
  private final double totalResponseTimeMillis;

  // The integer value for this result code.
  private final int intValue;

  // The total number of operations of the specified type with this result code.
  private final long count;

  // The operation type for which this information is maintained, or null if
  // it applies to all types of operations.
  @Nullable private final OperationType operationType;

  // The name for this result code.
  @NotNull private final String name;



  /**
   * Creates a new result code info object with the provided information.
   *
   * @param  intValue                   The integer value for this result code.
   * @param  name                       The name for this result code.
   * @param  operationType              The type of operation to which the
   *                                    statistics apply.  This may be
   *                                    {@code null} if the statistics apply to
   *                                    all types of operations.
   * @param  count                      The total number of operations of the
   *                                    specified type with this result code.
   * @param  percent                    The percent of operations of the
   *                                    specified type with this result code.
   * @param  totalResponseTimeMillis    The total response time, in
   *                                    milliseconds, for all operations of the
   *                                    specified type with this result code.
   * @param  averageResponseTimeMillis  The average response time, in
   *                                    milliseconds, for operations of the
   *                                    specified type with this result code.
   */
  ResultCodeInfo(final int intValue, @NotNull final String name,
                 @Nullable final OperationType operationType, final long count,
                 final double percent, final double totalResponseTimeMillis,
                 final double averageResponseTimeMillis)
  {
    this.intValue                  = intValue;
    this.name                      = name;
    this.operationType             = operationType;
    this.count                     = count;
    this.totalResponseTimeMillis   = totalResponseTimeMillis;
    this.averageResponseTimeMillis = averageResponseTimeMillis;
    this.percent                   = percent;
  }



  /**
   * Retrieves the integer value for this result code.
   *
   * @return  The integer value for this result code.
   */
  public int intValue()
  {
    return intValue;
  }



  /**
   * Retrieves the name for this result code.
   *
   * @return  The name for this result code.
   */
  @NotNull()
  public String getName()
  {
    return name;
  }



  /**
   * Retrieves the type of operation with which the result code statistics are
   * associated, if appropriate.
   *
   * @return  The type of operation with which the result code statistics are
   *          associated, or {@code null} if the statistics apply to all types
   *          of operations.
   */
  @Nullable()
  public OperationType getOperationType()
  {
    return operationType;
  }



  /**
   * The total number of operations of the associated type (or of all
   * operations if the operation type is {@code null}) with this result code.
   *
   * @return  The total number of operations of the associated type with this
   *          result code.
   */
  public long getCount()
  {
    return count;
  }



  /**
   * The percent of operations of the associated type (or of all operations if
   * the operation type is {@code null}) with this result code.
   *
   * @return  The percent of operations of the associated type with this result
   *          code.
   */
  public double getPercent()
  {
    return percent;
  }



  /**
   * The sum of the response times, in milliseconds, for all operations of the
   * associated type (or of all operations if the operation type is
   * {@code null}) with this result code.
   *
   * @return  The sum of the response times, in milliseconds, for all operations
   *          of the associated type with this result code.
   */
  public double getTotalResponseTimeMillis()
  {
    return totalResponseTimeMillis;
  }



  /**
   * The average response time, in milliseconds, for all operations of the
   * associated type (or of all operations if the operation type is
   * {@code null}) with this result code.
   *
   * @return  The average response time, in milliseconds, for all operations of
   *          the associated type with this result code.
   */
  public double getAverageResponseTimeMillis()
  {
    return averageResponseTimeMillis;
  }
}