io.github.bucket4j.distributed.remote.commands.GetAvailableTokensCommand Maven / Gradle / Ivy
The newest version!
/*-
* ========================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.remote.commands;
import io.github.bucket4j.distributed.remote.CommandResult;
import io.github.bucket4j.distributed.remote.MutableBucketEntry;
import io.github.bucket4j.distributed.remote.RemoteBucketState;
import io.github.bucket4j.distributed.remote.RemoteCommand;
import io.github.bucket4j.distributed.serialization.DeserializationAdapter;
import io.github.bucket4j.distributed.serialization.Scope;
import io.github.bucket4j.distributed.serialization.SerializationAdapter;
import io.github.bucket4j.distributed.serialization.SerializationHandle;
import io.github.bucket4j.distributed.versioning.Version;
import io.github.bucket4j.distributed.versioning.Versions;
import io.github.bucket4j.util.ComparableByContent;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
import static io.github.bucket4j.distributed.serialization.PrimitiveSerializationHandles.LONG_HANDLE;
import static io.github.bucket4j.distributed.versioning.Versions.v_7_0_0;
public class GetAvailableTokensCommand implements RemoteCommand, ComparableByContent {
public static final SerializationHandle SERIALIZATION_HANDLE = new SerializationHandle<>() {
@Override
public GetAvailableTokensCommand deserialize(DeserializationAdapter adapter, S input) throws IOException {
int formatNumber = adapter.readInt(input);
Versions.check(formatNumber, v_7_0_0, v_7_0_0);
return new GetAvailableTokensCommand();
}
@Override
public void serialize(SerializationAdapter adapter, O output, GetAvailableTokensCommand command, Version backwardCompatibilityVersion, Scope scope) throws IOException {
adapter.writeInt(output, v_7_0_0.getNumber());
// do nothing
}
@Override
public int getTypeId() {
return 27;
}
@Override
public Class getSerializedType() {
return GetAvailableTokensCommand.class;
}
@Override
public GetAvailableTokensCommand fromJsonCompatibleSnapshot(Map snapshot) {
int formatNumber = readIntValue(snapshot, "version");
Versions.check(formatNumber, v_7_0_0, v_7_0_0);
return new GetAvailableTokensCommand();
}
@Override
public Map toJsonCompatibleSnapshot(GetAvailableTokensCommand command, Version backwardCompatibilityVersion, Scope scope) {
Map result = new HashMap<>();
result.put("version", v_7_0_0.getNumber());
return result;
}
@Override
public String getTypeName() {
return "GetAvailableTokensCommand";
}
};
@Override
public CommandResult execute(MutableBucketEntry mutableEntry, long currentTimeNanos) {
if (!mutableEntry.exists()) {
return CommandResult.bucketNotFound();
}
RemoteBucketState state = mutableEntry.get();
state.refillAllBandwidth(currentTimeNanos);
return CommandResult.success(state.getAvailableTokens(), LONG_HANDLE);
}
@Override
public SerializationHandle getSerializationHandle() {
return SERIALIZATION_HANDLE;
}
@Override
public boolean equalsByContent(GetAvailableTokensCommand other) {
return true;
}
@Override
public boolean isImmediateSyncRequired(long unsynchronizedTokens, long nanosSinceLastSync) {
return false;
}
@Override
public long estimateTokensToConsume() {
return 0;
}
@Override
public long getConsumedTokens(Long result) {
return 0;
}
@Override
public Version getRequiredVersion() {
return v_7_0_0;
}
}