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

import org.osgi.annotation.versioning.ProviderType;

/**
 * This service can be used to gather information about requests processed by the
 * engine.
 *
 * @since 2.5
 */
@ProviderType
public interface RequestInfoProvider {

    /**
     * Is recording of requests enabled?
     * @return {@code true} if enabled, {@code} false} otherwise
     * @since 2.6
     */
    boolean isEnabled();

    /**
     * Is recording of requests for this path enabled?
     * @param path The path
     * @return {@code true} if enabled, {@code} false} otherwise
     * @since 2.6
     */
    boolean isEnabledFor(String path);

    /**
     * Get the request info for the id
     * @param id The id
     * @return The request info or {@code null}
     */
    RequestInfo getRequestInfo(String id);

    /**
     * Get the request infos
     * @return An iterator for the request infos
     */
    Iterable<RequestInfo> getRequestInfos();

    /**
     * Get the maximum number of provided infos
     * @return The maximum number, {@code 0} if no infos are recorded
     * @deprecated Use {@link #getMaxNumberOfInfos()}
     */
    @Deprecated
    int getMayNumberOfInfos();

    /**
     * Get the maximum number of provided infos
     * @return The maximum number, {@code 0} if no infos are recorded
     * @since 2.6
     */
    int getMaxNumberOfInfos();

    /**
     * Clear all request infos
     */
    void clear();
}