All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.unboundid.ldap.sdk.unboundidds.monitors.NumericGaugeMonitorEntry Maven / Gradle / Ivy

/*
 * Copyright 2014-2024 Ping Identity Corporation
 * All Rights Reserved.
 */
/*
 * Copyright 2014-2024 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-2024 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.util.ArrayList;
import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.StringTokenizer;

import com.unboundid.ldap.sdk.Entry;
import com.unboundid.util.Debug;
import com.unboundid.util.NotMutable;
import com.unboundid.util.NotNull;
import com.unboundid.util.Nullable;
import com.unboundid.util.StaticUtils;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;

import static com.unboundid.ldap.sdk.unboundidds.monitors.MonitorMessages.*;



/**
 * This class defines a numeric gauge monitor entry, which obtains its
 * information from a numeric value in a 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 NumericGaugeMonitorEntry extends GaugeMonitorEntry { /** * The structural object class used in gauge monitor entries. */ @NotNull static final String NUMERIC_GAUGE_MONITOR_OC = "ds-numeric-gauge-monitor-entry"; /** * The serial version UID for this serializable class. */ private static final long serialVersionUID = 2049893927290436280L; // The current value for the gauge. @Nullable private final Double currentValue; // The maximum value observed for the gauge. @Nullable private final Double maximumValue; // The minimum value observed for the gauge. @Nullable private final Double minimumValue; // The current value for the gauge. @Nullable private final Double previousValue; // The set of observed values for the gauge. @NotNull private final List observedValues; /** * Creates a new numeric gauge monitor entry from the provided entry. * * @param entry The entry to be parsed as a numeric gauge monitor entry. It * must not be {@code null}. */ public NumericGaugeMonitorEntry(@NotNull final Entry entry) { super(entry); currentValue = getDouble("value"); previousValue = getDouble("previous-value"); minimumValue = getDouble("value-minimum"); maximumValue = getDouble("value-maximum"); final String observedStr = getString("observed-values"); if ((observedStr == null) || observedStr.isEmpty()) { observedValues = Collections.emptyList(); } else { final ArrayList values = new ArrayList<>(10); try { final StringTokenizer tokenizer = new StringTokenizer(observedStr, ","); while (tokenizer.hasMoreTokens()) { values.add(Double.parseDouble(tokenizer.nextToken())); } } catch (final Exception e) { Debug.debugException(e); values.clear(); } observedValues = Collections.unmodifiableList(values); } } /** * Retrieves the current value for the gauge, if available. * * @return The current value for the gauge, or {@code null} if it was not * included in the monitor entry. */ @Nullable() public Double getCurrentValue() { return currentValue; } /** * Retrieves the previous value for the gauge, if available. * * @return The previous value for the gauge, or {@code null} if it was not * included in the monitor entry. */ @Nullable() public Double getPreviousValue() { return previousValue; } /** * Retrieves the minimum value observed for the gauge, if available. * * @return The minimum value observed for the gauge, or {@code null} if it * was not included in the monitor entry. */ @Nullable() public Double getMinimumValue() { return minimumValue; } /** * Retrieves the maximum value observed for the gauge, if available. * * @return The maximum value observed for the gauge, or {@code null} if it * was not included in the monitor entry. */ @Nullable() public Double getMaximumValue() { return maximumValue; } /** * Retrieves the set of observed values for the gauge, if available. * * @return The set of observed values for the gauge, or {@code null} if it * was not included in the monitor entry. */ @NotNull() public List getObservedValues() { return observedValues; } /** * {@inheritDoc} */ @Override() @NotNull() public String getMonitorDisplayName() { return INFO_NUMERIC_GAUGE_MONITOR_DISPNAME.get(); } /** * {@inheritDoc} */ @Override() @NotNull() public String getMonitorDescription() { return INFO_NUMERIC_GAUGE_MONITOR_DESC.get(); } /** * {@inheritDoc} */ @Override() @NotNull() public Map getMonitorAttributes() { final Map superAttributes = super.getMonitorAttributes(); final LinkedHashMap attrs = new LinkedHashMap<>( StaticUtils.computeMapCapacity(superAttributes.size() + 5)); attrs.putAll(superAttributes); if (currentValue != null) { addMonitorAttribute(attrs, "value", INFO_NUMERIC_GAUGE_DISPNAME_CURRENT_VALUE.get(), INFO_NUMERIC_GAUGE_DESC_CURRENT_VALUE.get(), currentValue); } if (previousValue != null) { addMonitorAttribute(attrs, "previous-value", INFO_NUMERIC_GAUGE_DISPNAME_PREVIOUS_VALUE.get(), INFO_NUMERIC_GAUGE_DESC_PREVIOUS_VALUE.get(), previousValue); } if (minimumValue != null) { addMonitorAttribute(attrs, "value-minimum", INFO_NUMERIC_GAUGE_DISPNAME_MINIMUM_VALUE.get(), INFO_NUMERIC_GAUGE_DESC_MINIMUM_VALUE.get(), minimumValue); } if (maximumValue != null) { addMonitorAttribute(attrs, "value-maximum", INFO_NUMERIC_GAUGE_DISPNAME_MAXIMUM_VALUE.get(), INFO_NUMERIC_GAUGE_DESC_MAXIMUM_VALUE.get(), maximumValue); } if (! observedValues.isEmpty()) { final Double[] values = new Double[observedValues.size()]; observedValues.toArray(values); attrs.put("observed-values", new MonitorAttribute("observed-values", INFO_NUMERIC_GAUGE_DISPNAME_OBSERVED_VALUES.get(), INFO_NUMERIC_GAUGE_DESC_OBSERVED_VALUES.get(), values)); } return Collections.unmodifiableMap(attrs); } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy