oak-store-document/src/main/java/org/apache/jackrabbit/oak/plugins/document/Throttler.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.plugins.document;

/**
 * Interface to implement throttling for document store.
 *
 * Concrete implementations for this interface are required provide implementation
 * for throttling time based on their internal usage/statistics
 */
public interface Throttler {

    /**
     * The time duration (in Millis) for which we need to throttle the system.
     * @return the throttling time duration (in Millis)
     */
    long throttlingTime();

    /**
     * Default implementation with no throttling
     */
    Throttler NO_THROTTLING = () -> 0;

}