io.github.bucket4j.grid.hazelcast.HazelcastProxyManager Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of bucket4j_jdk11-hazelcast-4 Show documentation
Show all versions of bucket4j_jdk11-hazelcast-4 Show documentation
Bucket4j integration with Hazelcast 3.x branch
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==================================
*/
/*
*
* Copyright 2015-2018 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.
*/
package io.github.bucket4j.grid.hazelcast;
import java.util.Objects;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.CompletionStage;
import com.hazelcast.config.SerializationConfig;
import com.hazelcast.config.SerializerConfig;
import com.hazelcast.map.IMap;
import io.github.bucket4j.distributed.proxy.AbstractProxyManager;
import io.github.bucket4j.distributed.proxy.ClientSideConfig;
import io.github.bucket4j.distributed.remote.CommandResult;
import io.github.bucket4j.distributed.remote.Request;
import io.github.bucket4j.distributed.serialization.InternalSerializationHelper;
import io.github.bucket4j.distributed.versioning.Version;
import io.github.bucket4j.grid.hazelcast.Bucket4jHazelcast.HazelcastProxyManagerBuilder;
import io.github.bucket4j.grid.hazelcast.serialization.HazelcastEntryProcessorSerializer;
import io.github.bucket4j.grid.hazelcast.serialization.HazelcastOffloadableEntryProcessorSerializer;
import io.github.bucket4j.grid.hazelcast.serialization.SerializationUtilities;
import io.github.bucket4j.grid.hazelcast.serialization.SimpleBackupProcessorSerializer;
import io.github.bucket4j.grid.hazelcast.serialization.VersionedBackupProcessorSerializer;
import static io.github.bucket4j.distributed.serialization.InternalSerializationHelper.deserializeResult;
/**
* The extension of Bucket4j library addressed to support Hazelcast in-memory data grid.
*/
public class HazelcastProxyManager extends AbstractProxyManager {
private final IMap map;
private final String offloadableExecutorName;
HazelcastProxyManager(HazelcastProxyManagerBuilder builder) {
super(builder.getClientSideConfig());
this.map = builder.map;
this.offloadableExecutorName = builder.offloadableExecutorName;
}
/**
* @deprecated use {@link Bucket4jHazelcast#entryProcessorBasedBuilder(IMap)}
*/
@Deprecated
public HazelcastProxyManager(IMap map) {
this(map, ClientSideConfig.getDefault());
}
/**
* @deprecated use {@link Bucket4jHazelcast#entryProcessorBasedBuilder(IMap)}
*/
@Deprecated
public HazelcastProxyManager(IMap map, ClientSideConfig clientSideConfig) {
super(clientSideConfig);
this.map = Objects.requireNonNull(map);
this.offloadableExecutorName = null;
}
/**
* @deprecated use {@link Bucket4jHazelcast#entryProcessorBasedBuilder(IMap)}
*/
@Deprecated
public HazelcastProxyManager(IMap map, ClientSideConfig clientSideConfig, String offlodableExecutorName) {
super(clientSideConfig);
this.map = Objects.requireNonNull(map);
this.offloadableExecutorName = Objects.requireNonNull(offlodableExecutorName);
}
@Override
public CommandResult execute(K key, Request request) {
HazelcastEntryProcessor entryProcessor = offloadableExecutorName == null?
new HazelcastEntryProcessor<>(request) :
new HazelcastOffloadableEntryProcessor<>(request, offloadableExecutorName);
byte[] response = map.executeOnKey(key, entryProcessor);
Version backwardCompatibilityVersion = request.getBackwardCompatibilityVersion();
return deserializeResult(response, backwardCompatibilityVersion);
}
@Override
public boolean isAsyncModeSupported() {
return true;
}
@Override
public boolean isExpireAfterWriteSupported() {
return true;
}
@Override
public CompletableFuture> executeAsync(K key, Request request) {
HazelcastEntryProcessor entryProcessor = offloadableExecutorName == null?
new HazelcastEntryProcessor<>(request) :
new HazelcastOffloadableEntryProcessor<>(request, offloadableExecutorName);
CompletionStage future = map.submitToKey(key, entryProcessor);
Version backwardCompatibilityVersion = request.getBackwardCompatibilityVersion();
return (CompletableFuture) future.thenApply((byte[] bytes) -> InternalSerializationHelper.deserializeResult(bytes, backwardCompatibilityVersion));
}
@Override
public void removeProxy(K key) {
map.remove(key);
}
@Override
protected CompletableFuture removeAsync(K key) {
CompletionStage hazelcastFuture = map.removeAsync(key);
CompletableFuture resultFuture = new CompletableFuture<>();
hazelcastFuture.whenComplete((oldState, error) -> {
if (error == null) {
resultFuture.complete(null);
} else {
resultFuture.completeExceptionally(error);
}
});
return resultFuture;
}
/**
* Registers custom Hazelcast serializers for all classes from Bucket4j library which can be transferred over network.
* Each serializer will have different typeId, and this id will not be changed in the feature releases.
*
*
* Note: it would be better to leave an empty space in the Ids in order to handle the extension of Bucket4j library when new classes can be added to library.
* For example if you called {@code getAllSerializers(10000)} then it would be reasonable to avoid registering your custom types in the interval 10000-10100.
*
*
* @param typeIdBase a starting number from for typeId sequence
*/
public static void addCustomSerializers(SerializationConfig serializationConfig, final int typeIdBase) {
serializationConfig.addSerializerConfig(
new SerializerConfig()
.setImplementation(new HazelcastEntryProcessorSerializer(SerializationUtilities.getSerializerTypeId(HazelcastEntryProcessorSerializer.class, typeIdBase)))
.setTypeClass(HazelcastEntryProcessor.class)
);
serializationConfig.addSerializerConfig(
new SerializerConfig()
.setImplementation(new SimpleBackupProcessorSerializer(SerializationUtilities.getSerializerTypeId(SimpleBackupProcessorSerializer.class, typeIdBase)))
.setTypeClass(SimpleBackupProcessor.class)
);
serializationConfig.addSerializerConfig(
new SerializerConfig()
.setImplementation(new HazelcastOffloadableEntryProcessorSerializer(SerializationUtilities.getSerializerTypeId(HazelcastOffloadableEntryProcessorSerializer.class, typeIdBase)))
.setTypeClass(HazelcastOffloadableEntryProcessor.class)
);
serializationConfig.addSerializerConfig(
new SerializerConfig()
.setImplementation(new VersionedBackupProcessorSerializer(SerializationUtilities.getSerializerTypeId(VersionedBackupProcessorSerializer.class, typeIdBase)))
.setTypeClass(VersionedBackupProcessor.class)
);
}
}