io.github.bucket4j.grid.hazelcast.Hazelcast Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bucket4j-hazelcast-3 Show documentation

Bucket4j integration with Hazelcast 3.x branch

There is a newer version: 8.0.1

/*-
 * ========================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.grid.hazelcast;


import com.hazelcast.core.IMap;
import io.github.bucket4j.Extension;
import io.github.bucket4j.grid.GridBucketState;
import io.github.bucket4j.grid.ProxyManager;
import io.github.bucket4j.serialization.SerializationHandle;

import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;

/**
 * The extension of Bucket4j library addressed to support Hazelcast in-memory data grid.
 *
 * Use this extension only if you need in asynchronous API, else stay at {@link io.github.bucket4j.grid.jcache.JCache}
 */
public class Hazelcast implements Extension {

    /**
     * {@inheritDoc}
     *
     * @return new instance of {@link HazelcastBucketBuilder}
     */
    @Override
    public HazelcastBucketBuilder builder() {
        return new HazelcastBucketBuilder();
    }

    /**
     * Creates {@link HazelcastProxyManager} for specified map.
     *
     * @param map map for storing state of buckets
     * @param  type of keys in the map
     * @return {@link ProxyManager} for specified map.
     */
    public  ProxyManager proxyManagerForMap(IMap map) {
        return new HazelcastProxyManager<>(map);
    }

    @Override
    public Collection> getSerializers() {
        return Arrays.asList(SimpleBackupProcessor.SERIALIZATION_HANDLE);
    }

}