com.tangosol.coherence.jcache.CoherenceBasedCompleteConfiguration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of coherence-jcache Show documentation
Oracle Coherence Community Edition
The newest version!
/*
 * Copyright (c) 2000, 2020, Oracle and/or its affiliates.
 *
 * Licensed under the Universal Permissive License v 1.0 as shown at
 * http://oss.oracle.com/licenses/upl.
 */
package com.tangosol.coherence.jcache;

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;

/**
 * An Coherence-based {@link javax.cache.configuration.CompleteConfiguration} that provides
 * setter methods.
 * 
 * {@link CoherenceBasedCache}s that use this configuration must be JCache compliant as
 * JCache {@link javax.cache.Cache}s that use {@link CompleteConfiguration}s are compliant.
 *
 * @author bo  2013.11.12
 * @since Coherence 12.1.3
 *
 * @param   the type of the keys
 * @param   the type of the values
 */
public interface CoherenceBasedCompleteConfiguration
        extends CompleteConfiguration, CoherenceBasedConfiguration
    {
    /**
     * Sets the expected type of keys and values for a {@link CoherenceBasedCache}.
     * 

     * Setting both to Object.class means type-safety checks are not required.
     *
     * @param clzKey    the expected key type
     * @param clzValue  the expected value type
     *
     * @throws NullPointerException should the key or value type be null
     */
    public void setTypes(Class clzKey, Class clzValue);

    /**
     * Add a configuration for a {@link javax.cache.event.CacheEntryListener}.
     *
     * @param cfgListener  the {@link javax.cache.configuration.CacheEntryListenerConfiguration}
     *
     * @throws IllegalArgumentException if the same CacheEntryListenerConfiguration
     *                                  is used more than once
     */
    public void addCacheEntryListenerConfiguration(CacheEntryListenerConfiguration cfgListener);

    /**
     * Set the {@link javax.cache.integration.CacheLoader} factory.
     *
     * @param factory  the {@link javax.cache.integration.CacheLoader} {@link javax.cache.configuration.Factory}
     */
    public void setCacheLoaderFactory(Factory> factory);

    /**
     * Set the {@link javax.cache.integration.CacheWriter} factory.
     *
     * @param factory  the {@link javax.cache.integration.CacheWriter} {@link javax.cache.configuration.Factory}
     */
    public void setCacheWriterFactory(Factory> factory);

    /**
     * Set the {@link javax.cache.configuration.Factory} for the {@link javax.cache.expiry.ExpiryPolicy}.
     * 

     * If 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}
     */
    public void setExpiryPolicyFactory(Factory factory);

    /**
     * Set if read-through caching should be used.
     * 

     * It is an invalid configuration to set this to true without specifying a
     * {@link javax.cache.integration.CacheLoader} {@link javax.cache.configuration.Factory}.
     *
     * @param fReadThrough  true if read-through is required
     */
    public void setReadThrough(boolean fReadThrough);

    /**
     * Set if write-through caching should be used.
     * 

     * It is an invalid configuration to set this to true without specifying a
     * {@link javax.cache.integration.CacheWriter} {@link javax.cache.configuration.Factory}.
     *
     * @param fWriteThrough  true if write-through is required
     */
    public void setWriteThrough(boolean fWriteThrough);

    /**
     * Set if a configured cache should use store-by-value or store-by-reference
     * semantics.
     *
     * @param fStoreByValue  true for store-by-value semantics,
     *                       false for store-by-reference semantics
     */
    public void setStoreByValue(boolean fStoreByValue);

    /**
     * Set if statistics gathering is enabled for a configuration.
     * 

     * Statistics may be enabled or disabled at runtime via
     * {@link javax.cache.CacheManager#enableStatistics(String, boolean)}.
     *
     * @param fStatisticsEnabled  true to enable statistics gathering,
     *                            false to disable
     */
    public void setStatisticsEnabled(boolean fStatisticsEnabled);

    /**
     * Set if JMX management is enabled for a configuration.
     * 
     * Management may be enabled or disabled at runtime via
     * {@link javax.cache.CacheManager#enableManagement(String, boolean)}.
     *
     * @param fManagementEnabled  true to enable statistics,
     *                            false to disable
     */
    public void setManagementEnabled(boolean fManagementEnabled);
    }