/*
 * Licensed to Elasticsearch under one or more contributor
 * license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright
 * ownership. Elasticsearch 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.lucene.store;

import org.apache.lucene.store.RateLimiter.SimpleRateLimiter;
import org.elasticsearch.common.Nullable;
import org.elasticsearch.common.unit.ByteSizeValue;

/**
 */
public class StoreRateLimiting {

    public interface Provider {

        StoreRateLimiting rateLimiting();
    }

    public interface Listener {

        void onPause(long nanos);
    }

    public enum Type {
        NONE,
        MERGE,
        ALL;

        public static Type fromString(String type) {
            if ("none".equalsIgnoreCase(type)) {
                return NONE;
            } else if ("merge".equalsIgnoreCase(type)) {
                return MERGE;
            } else if ("all".equalsIgnoreCase(type)) {
                return ALL;
            }
            throw new IllegalArgumentException("rate limiting type [" + type + "] not valid, can be one of [all|merge|none]");
        }
    }

    private final SimpleRateLimiter rateLimiter = new SimpleRateLimiter(0);
    private volatile SimpleRateLimiter actualRateLimiter;

    private volatile Type type;

    public StoreRateLimiting() {

    }

    @Nullable
    public RateLimiter getRateLimiter() {
        return actualRateLimiter;
    }

    public void setMaxRate(ByteSizeValue rate) {
        if (rate.getBytes() <= 0) {
            actualRateLimiter = null;
        } else if (actualRateLimiter == null) {
            actualRateLimiter = rateLimiter;
            actualRateLimiter.setMBPerSec(rate.getMbFrac());
        } else {
            assert rateLimiter == actualRateLimiter;
            rateLimiter.setMBPerSec(rate.getMbFrac());
        }
    }

    public Type getType() {
        return type;
    }

    public void setType(Type type) {
        this.type = type;
    }

    public void setType(String type) {
        this.type = Type.fromString(type);
    }
}

@@ -956,69 +956,309 @@
 mon.
-unit.ByteSizeValue;%0A%0A/**%0A */%0Apublic class StoreRateLimiting %7B
+logging.DeprecationLogger;%0Aimport org.elasticsearch.common.logging.Loggers;%0Aimport org.elasticsearch.common.unit.ByteSizeValue;%0A%0A/**%0A */%0Apublic class StoreRateLimiting %7B%0A%0A    private static final DeprecationLogger DEPRECATION_LOGGER = new DeprecationLogger(Loggers.getLogger(StoreRateLimiting.class));
 %0A%0A  
@@ -2776,24 +2776,174 @@
 ype = type;%0A
+        if (type != Type.NONE) %7B%0A            DEPRECATION_LOGGER.deprecated(%22Store rate limiting is deprecated and will be removed in 6.0%22);%0A        %7D%0A
     %7D%0A%0A    p
@@ -2984,28 +2984,24 @@
         
-this.type = 
+setType(
 Type.fro
@@ -3013,16 +3013,17 @@
 ng(type)
+)
 ;%0A    %7D%0A

Add deprecation logging for the case that store throttling is used. (#21618)