src/main/java/org/apache/sling/engine/jmx/FilterProcessorMBean.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.sling.engine.jmx;

import org.osgi.annotation.versioning.ProviderType;

/**
 * This is the management interface for the Filter.
 */
@ProviderType
public interface FilterProcessorMBean {

    /**
     * Returns the number of invocations collected since last resetting the
     * statistics.
     *
     * @return Get invocation count
     * @see #resetStatistics()
     */
    long getInvocationsCount();

    /**
     * Returns the mean filter invocation time in milliseconds since resetting
     * the statistics.
     *
     * @return Get mean filter duration
     * @see #resetStatistics()
     */
    double getMeanFilterDurationMsec();

    /**
     * Resets all statistics values and restarts from zero.
     */
    void resetStatistics();
}