io.micronaut.microstream.cache.MicroStreamCacheConfigurationProperties Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2017-2022 original authors
 *
 * 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
 *
 * https://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.micronaut.microstream.cache;

import io.micronaut.context.annotation.EachProperty;
import io.micronaut.context.annotation.Parameter;
import io.micronaut.core.annotation.NonNull;
import io.micronaut.core.annotation.Nullable;

/**
 * @author Sergio del Amo
 * @since 1.0.0
 * @param  Key Type
 * @param  Value Type
 */
@EachProperty(MicroStreamCacheConfigurationProperties.PREFIX)
public class MicroStreamCacheConfigurationProperties implements MicroStreamCacheConfiguration {

    public static final String PREFIX = "microstream.cache";

    /**
     * Whether this cache is enabled by default.
     */
    @SuppressWarnings("WeakerAccess")
    public static final boolean DEFAULT_ENABLED = true;

    private boolean enabled = DEFAULT_ENABLED;

    @Nullable
    private Class keyType;

    @Nullable
    private Class valueType;

    @Nullable
    private String storage;

    @Nullable
    private Boolean readThrough;

    @Nullable
    private Boolean writeThrough;

    @Nullable
    private Boolean storeByValue;

    @Nullable
    private Boolean statisticsEnabled;

    @Nullable
    private Boolean managementEnabled;

    private final String name;

    public MicroStreamCacheConfigurationProperties(@Parameter String name) {
        this.name = name;
    }

    @Override
    @NonNull
    public Class getKeyType() {
        return keyType != null ? keyType : (Class) Object.class;
    }

    @Override
    @NonNull
    public Class getValueType() {
        return valueType != null ? valueType : (Class) Object.class;
    }

    @Nullable
    @Override
    public String getStorage() {
        return storage;
    }

    @Override
    @Nullable
    public Boolean isReadThrough() {
        return readThrough;
    }

    @Override
    @Nullable
    public Boolean isWriteThrough() {
        return writeThrough;
    }

    @Override
    @Nullable
    public Boolean isStoreByValue() {
        return storeByValue;
    }

    @Override
    @Nullable
    public Boolean isStatisticsEnabled() {
        return statisticsEnabled;
    }

    @Override
    @Nullable
    public Boolean isManagementEnabled() {
        return managementEnabled;
    }

    @Override
    @NonNull
    public String getName() {
        return name;
    }

    /**
     *
     * @param keyType The required type of keys for the Cache.
     */
    public void setKeyType(@Nullable Class keyType) {
        this.keyType = keyType;
    }

    /**
     *
     * @param valueType Determines type of values for the Cache.
     */
    public void setValueType(@Nullable Class valueType) {
        this.valueType = valueType;
    }

    /**
     *
     * @param storage Name qualifier for MicroStream Storage Manager
     */
    public void setStorage(@Nullable String storage) {
        this.storage = storage;
    }

    /**
     * When in "read-through" mode, cache misses that occur due to cache entries not existing as a result of performing a "get" will appropriately cause the configured CacheLoader to be invoked. When you set a Storage Manager, "read-through" mode is activated.
     * @param readThrough Whether to use "read-through" mode
     */
    public void setReadThrough(Boolean readThrough) {
        this.readThrough = readThrough;
    }

    /**
     * When in "write-through" mode, cache updates that occur as a result of performing "put" operations will appropriately cause the configured CacheWriter to be invoked.When you set a Storage Manager, "write-through" mode is activated.
     * @param writeThrough Whether to use "write-through" mode.
     */
    public void setWriteThrough(Boolean writeThrough) {
        this.writeThrough = writeThrough;
    }

    /**
     * When a cache is storeByValue, any mutation to the key or value does not affect the key of value stored in the cache.
     * @param storeByValue When a cache is storeByValue, any mutation to the key or value does not affect the key of value stored in the cache.
     */
    public void setStoreByValue(Boolean storeByValue) {
        this.storeByValue = storeByValue;
    }

    /**
     * Whether statistics collection is enabled in this cache.
     * @param statisticsEnabled Whether statistics collection is enabled in this cache.
     */
    public void setStatisticsEnabled(Boolean statisticsEnabled) {
        this.statisticsEnabled = statisticsEnabled;
    }

    /**
     * Whether management is enabled on this cache.
     * @param managementEnabled Whether management is enabled on this cache.
     */
    public void setManagementEnabled(Boolean managementEnabled) {
        this.managementEnabled = managementEnabled;
    }

    @Override
    public boolean isEnabled() {
        return enabled;
    }

    /**
     * Whether this cache is enabled. Default Value: {@value #DEFAULT_ENABLED}
     * @param enabled Whether this cache is enabled.
     */
    public void setEnabled(boolean enabled) {
        this.enabled = enabled;
    }

}