com.hazelcast.config.CacheConfiguration Maven / Gradle / Ivy
/*
* Copyright (c) 2008-2018, Hazelcast, Inc. All Rights Reserved.
*
* 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 com.hazelcast.config;
import javax.cache.configuration.CacheEntryListenerConfiguration;
import javax.cache.configuration.CompleteConfiguration;
import javax.cache.configuration.Factory;
import javax.cache.expiry.ExpiryPolicy;
import javax.cache.integration.CacheLoader;
import javax.cache.integration.CacheWriter;
/**
* Mutable extension to {@link javax.cache.configuration.CompleteConfiguration}
*
* @param the type of key
* @param the type of value
*/
public interface CacheConfiguration
extends CompleteConfiguration {
/**
* Sets the expected type of keys and values for a {@link javax.cache.Cache}
* configured with this {@link javax.cache.configuration.Configuration}. Setting both to
* {@code Object.class} means type-safety checks are not required.
*
* This is used by {@link javax.cache.CacheManager} to ensure that the key and value
* types are the same as those configured for the {@link javax.cache.Cache} prior to
* returning a requested cache from this method.
*
* Implementations may further perform type checking on mutative cache operations
* and throw a {@link ClassCastException} if these checks fail.
*
* @param keyType the expected key type
* @param valueType the expected value type
* @return the {@link com.hazelcast.config.CacheConfiguration} to permit fluent-style method calls
* @throws NullPointerException should the key or value type be {@code null}
* @see javax.cache.CacheManager#getCache(String, Class, Class)
*/
CacheConfiguration setTypes(Class keyType, Class valueType);
/**
* Add a configuration for a {@link javax.cache.event.CacheEntryListener}.
*
* @param cacheEntryListenerConfiguration the {@link javax.cache.configuration.CacheEntryListenerConfiguration}
* @return the {@link com.hazelcast.config.CacheConfiguration} to permit fluent-style method calls
* @throws IllegalArgumentException if the same CacheEntryListenerConfiguration
* is used more than once
*/
CacheConfiguration addCacheEntryListenerConfiguration(CacheEntryListenerConfiguration
cacheEntryListenerConfiguration);
/**
* Remove a configuration for a {@link javax.cache.event.CacheEntryListener}.
*
* @param cacheEntryListenerConfiguration the {@link javax.cache.configuration.CacheEntryListenerConfiguration} to remove
* @return the {@link com.hazelcast.config.CacheConfiguration} to permit fluent-style method calls
*/
CacheConfiguration removeCacheEntryListenerConfiguration(CacheEntryListenerConfiguration
cacheEntryListenerConfiguration);
/**
* Set the {@link javax.cache.integration.CacheLoader} factory.
*
* @param factory the {@link javax.cache.integration.CacheLoader} {@link javax.cache.configuration.Factory}
* @return the {@link com.hazelcast.config.CacheConfiguration} to permit fluent-style method calls
*/
CacheConfiguration setCacheLoaderFactory(Factory> factory);
/**
* Set the {@link javax.cache.integration.CacheWriter} factory.
*
* @param factory the {@link javax.cache.integration.CacheWriter} {@link javax.cache.configuration.Factory}
* @return the {@link com.hazelcast.config.CacheConfiguration} to permit fluent-style method calls
*/
CacheConfiguration setCacheWriterFactory(Factory> factory);
/**
* Set the {@link javax.cache.configuration.Factory} for the {@link javax.cache.expiry.ExpiryPolicy}.
* If {@code null} is specified the default {@link javax.cache.expiry.ExpiryPolicy} is used.
*
* @param factory the {@link javax.cache.expiry.ExpiryPolicy} {@link javax.cache.configuration.Factory}
* @return the {@link com.hazelcast.config.CacheConfiguration} to permit fluent-style method calls
*/
CacheConfiguration setExpiryPolicyFactory(Factory factory);
/**
* Set if read-through caching should be used.
*
* It is an invalid configuration to set this to {@code true} without specifying a
* {@link javax.cache.integration.CacheLoader} {@link javax.cache.configuration.Factory}.
*
* @param isReadThrough {@code true} if read-through is required, {@code false} otherwise
* @return the {@link com.hazelcast.config.CacheConfiguration} to permit fluent-style method calls
*/
CacheConfiguration setReadThrough(boolean isReadThrough);
/**
* Set if write-through caching should be used.
*
* It is an invalid configuration to set this to {@code true} without specifying a
* {@link javax.cache.integration.CacheWriter} {@link javax.cache.configuration.Factory}.
*
* @param isWriteThrough {@code true} if write-through is required, {@code false} otherwise
* @return the {@link com.hazelcast.config.CacheConfiguration} to permit fluent-style method calls
*/
CacheConfiguration setWriteThrough(boolean isWriteThrough);
/**
* Set if a configured cache should use store-by-value or store-by-reference semantics.
*
* @param isStoreByValue {@code true} if store-by-value is required,
* {@code false} for store-by-reference
* @return the {@link com.hazelcast.config.CacheConfiguration} to permit fluent-style method calls
*/
CacheConfiguration setStoreByValue(boolean isStoreByValue);
/**
* Sets whether statistics gathering is enabled on a cache.
*
* Statistics may be enabled or disabled at runtime via
* {@link javax.cache.CacheManager#enableStatistics(String, boolean)}.
*
* @param enabled {@code true} to enable statistics, {@code false} to disable
* @return the {@link com.hazelcast.config.CacheConfiguration} to permit fluent-style method calls
*/
CacheConfiguration setStatisticsEnabled(boolean enabled);
/**
* Sets whether management is enabled on a cache.
*
* Management may be enabled or disabled at runtime via
* {@link javax.cache.CacheManager#enableManagement(String, boolean)}.
*
* @param enabled {@code true} to enable statistics, {@code false} to disable
* @return the {@link com.hazelcast.config.CacheConfiguration} to permit fluent-style method calls
*/
CacheConfiguration setManagementEnabled(boolean enabled);
}