trunk/oak-api/src/main/java/org/apache/jackrabbit/oak/api/jmx/RepositoryStatsMBean.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.jackrabbit.oak.api.jmx;

import javax.management.openmbean.CompositeData;

import org.osgi.annotation.versioning.ProviderType;

/**
 * MBean for providing repository wide statistics.
 * This MBean exposes the time series provided by
 * {@code org.apache.jackrabbit.api.stats.RepositoryStatistics RepositoryStatistics}
 * through JMX as {@code CompositeData} of arrays.
 */
@ProviderType
public interface RepositoryStatsMBean {
    String TYPE = "RepositoryStats";

    /**
     * See {@code org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#SESSION_COUNT}
     */
    CompositeData getSessionCount();

    /**
     * See {@code org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#SESSION_LOGIN_COUNTER}
     */
    CompositeData getSessionLogin();

    /**
     * See {@code org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#SESSION_READ_COUNTER}
     */
    CompositeData getSessionReadCount();

    /**
     * See {@code org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#SESSION_READ_DURATION}
     */
    CompositeData getSessionReadDuration();

    /**
     * See {@code org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#SESSION_READ_AVERAGE}
     */
    CompositeData getSessionReadAverage();

    /**
     * See {@code org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#SESSION_WRITE_COUNTER}
     */
    CompositeData getSessionWriteCount();

    /**
     * See {@code org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#SESSION_READ_DURATION}
     */
    CompositeData getSessionWriteDuration();

    /**
     * See {@code org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#SESSION_WRITE_AVERAGE}
     */
    CompositeData getSessionWriteAverage();

    /**
     * See {@code org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#QUERY_COUNT}
     */
    CompositeData getQueryCount();

    /**
     * See {@code org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#QUERY_DURATION}
     */
    CompositeData getQueryDuration();

    /**
     * See {@code org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#QUERY_AVERAGE}
     */
    CompositeData getQueryAverage();

    /**
     * See {@code org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#OBSERVATION_EVENT_COUNTER}
     */
    CompositeData getObservationEventCount();

    /**
     * See {@code org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#OBSERVATION_EVENT_DURATION}
     */
    CompositeData getObservationEventDuration();

    /**
     * See {@code org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#OBSERVATION_EVENT_AVERAGE}
     */
    CompositeData getObservationEventAverage();

    /**
     * Maximum length of observation queue in the respective time period.
     */
    CompositeData getObservationQueueMaxLength();
}