io.github.bucket4j.distributed.proxy.optimization.predictive.PredictiveOptimization Maven / Gradle / Ivy
/*-
* ========================LICENSE_START=================================
* Bucket4j
* %%
* Copyright (C) 2015 - 2020 Vladimir Bukhtoyarov
* %%
* Licensed 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.
* =========================LICENSE_END==================================
*/
package io.github.bucket4j.distributed.proxy.optimization.predictive;
import io.github.bucket4j.TimeMeter;
import io.github.bucket4j.distributed.proxy.AsyncCommandExecutor;
import io.github.bucket4j.distributed.proxy.CommandExecutor;
import io.github.bucket4j.distributed.proxy.optimization.Optimization;
import io.github.bucket4j.distributed.proxy.optimization.DelayParameters;
import io.github.bucket4j.distributed.proxy.optimization.OptimizationListener;
import io.github.bucket4j.distributed.proxy.optimization.PredictionParameters;
import io.github.bucket4j.distributed.proxy.optimization.batch.AsyncBatchingExecutor;
import io.github.bucket4j.distributed.proxy.optimization.batch.BatchingExecutor;
import io.github.bucket4j.distributed.proxy.optimization.batch.BatchingOptimization;
import io.github.bucket4j.distributed.proxy.optimization.delay.DelayOptimization;
/**
* Optimization that can serve requests locally without synchronization with external storage until thresholds are not violated.
* This optimization is based on top of {@link BatchingOptimization} and {@link DelayOptimization},
* and in additionally this optimization tries to predict aggregated consumption rate in whole cluster in order to reduce the risk of overconsumption that caused by {@link DelayOptimization}.
*
* Usage of this optimization can lead to temporal over-consumption because the synchronization with external storage is performed periodically when thresholds are violated,
* as well as under-consumption in case of the wrong prediction of aggregated consumption rate.
*
* @see DelayParameters
* @see PredictionParameters
*/
public class PredictiveOptimization implements Optimization {
private final DelayParameters delayParameters;
private final PredictionParameters predictionParameters;
private final OptimizationListener listener;
private final TimeMeter timeMeter;
public PredictiveOptimization(PredictionParameters predictionParameters, DelayParameters delayParameters, OptimizationListener listener, TimeMeter timeMeter) {
this.delayParameters = delayParameters;
this.predictionParameters = predictionParameters;
this.listener = listener;
this.timeMeter = timeMeter;
}
@Override
public Optimization withListener(OptimizationListener listener) {
return new PredictiveOptimization(predictionParameters, delayParameters, listener, timeMeter);
}
@Override
public CommandExecutor apply(CommandExecutor originalExecutor) {
PredictiveCommandExecutor predictiveCommandExecutor = new PredictiveCommandExecutor(originalExecutor, delayParameters, predictionParameters, listener, timeMeter);
return new BatchingExecutor(predictiveCommandExecutor, listener);
}
@Override
public AsyncCommandExecutor apply(AsyncCommandExecutor originalExecutor) {
PredictiveCommandExecutor predictiveCommandExecutor = new PredictiveCommandExecutor(originalExecutor, delayParameters, predictionParameters, listener, timeMeter);
return new AsyncBatchingExecutor(predictiveCommandExecutor, listener);
}
}