com.hivemq.spi.services.BlockingMetricService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hivemq-spi Show documentation

The Service Provider Interfaces for developing HiveMQ plugins.

There is a newer version: 3.4.4

/*
 * Copyright 2014 dc-square GmbH
 *
 * 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.
 */

package com.hivemq.spi.services;

import com.codahale.metrics.Metric;
import com.codahale.metrics.MetricRegistry;
import com.google.common.util.concurrent.ListenableFuture;
import com.hivemq.spi.annotations.Nullable;
import com.hivemq.spi.metrics.HiveMQMetric;

import java.util.Map;

/**
 * This service allows plugins to get or add global HiveMQ metrics.
 *
 * @author Lukas Brandl
 */
public interface BlockingMetricService {

    /**
     * Returns a specific HiveMQ metric. If the metric does not exist, this method will return
     * null.
     * 
     * For a list of all available metrics, refer to the {@link com.hivemq.spi.metrics.HiveMQMetrics} constant class.
     *
     * @param metric the metric
     * @param     the metric type
     * @return the metric (if available) or null
     */
    @Nullable
     T getHiveMQMetric(HiveMQMetric metric);

    /**
     * Returns a specific HiveMQ metric. If the metric does not exist, this method will return
     * null.
     * 
     * For a list of all available metrics, refer to the {@link com.hivemq.spi.metrics.HiveMQMetrics} constant class.
     *
     * @param metric the metric
     * @param     the metric type
     * @return the metric (if available) or null
     */
    @Nullable
     Map getClusterMetric(HiveMQMetric metric);

    /**
     * Returns the metric registry of HiveMQ.
     *
     * @return the metric registry
     */
    MetricRegistry getMetricRegistry();
}