io.helidon.integrations.microstream.cache.CacheBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of helidon-integrations-microstream-cache Show documentation
Microstream JCache implementation
There is a newer version: 4.1.4
Show newest version
/*
 * Copyright (c) 2021 Oracle and/or its affiliates.
 *
 * 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.helidon.integrations.microstream.cache;

import javax.cache.Caching;

import io.helidon.config.Config;

import one.microstream.cache.types.Cache;
import one.microstream.cache.types.CacheConfiguration;
import one.microstream.cache.types.CacheManager;
import one.microstream.cache.types.CachingProvider;

/**
 * Builder for a Microstream - JCache instance.
 *
 * @param  type of the cache key
 * @param  type of the cache value
 */
public class CacheBuilder {
    private static final String MICROSTREAM_CACHING_PROVIDER = "one.microstream.cache.types.CachingProvider";

    private final CachingProvider provider;
    private final CacheManager cacheManager;
    private final CacheConfiguration configuration;

    protected CacheBuilder(CacheConfiguration configuration) {
        super();

        this.configuration = configuration;
        this.provider = (CachingProvider) Caching.getCachingProvider(MICROSTREAM_CACHING_PROVIDER);
        this.cacheManager = provider.getCacheManager();
    }

    protected CacheBuilder(Class keyType, Class valueType) {
        this.provider = (CachingProvider) Caching.getCachingProvider(MICROSTREAM_CACHING_PROVIDER);
        this.cacheManager = provider.getCacheManager();
        this.configuration = CacheConfiguration.Builder(keyType, valueType).build();
    }

    /**
     * Create a new cache builder using the provided microstream cache configuration.
     *
     * @param  type of the cache key
     * @param  type of the cache value
     * @param configuration CacheConfiguration
     * @param keyType class of the cache key
     * @param valueType class of the cache key
     * @return cache builder
     */
    public static  CacheBuilder builder(CacheConfiguration configuration,
                                                    Class keyType,
                                                    Class valueType) {
        return new CacheBuilder<>(configuration);
    }

    /**
     * Set the name of the cache.
     *
     * @param name the cache name
     * @return the new cache instance
     */
    public Cache build(String name) {
        return cacheManager.createCache(name, configuration);
    }

    /**
     *  Create a named cache using the provided helidon configuration.
     *
     * @param name the cache name
     * @param config the helidon configuration
     * @param keyType class of the cache key
     * @param valueType class of the cache key
     * @return the new cache instance
     */
    public static Cache create(String name, Config config, Class keyType, Class valueType) {

        CacheConfiguration cacheConfig = MicrostreamCacheConfigurationBuilder.builder(config, keyType, valueType)
                .build();
        return new CacheBuilder<>(cacheConfig).build(name);
    }
}