All Downloads are FREE. Search and download functionalities are using the official Maven repository.

javax.cache.integration.CacheWriter Maven / Gradle / Ivy

Go to download

Easy Redis Java client and Real-Time Data Platform. Valkey compatible. Sync/Async/RxJava3/Reactive API. Client side caching. Over 50 Redis based Java objects and services: JCache API, Apache Tomcat, Hibernate, Spring, Set, Multimap, SortedSet, Map, List, Queue, Deque, Semaphore, Lock, AtomicLong, Map Reduce, Bloom filter, Scheduler, RPC

There is a newer version: 3.40.2
Show newest version
/**
 * Copyright 2011-2016 Terracotta, Inc.
 * Copyright 2011-2016 Oracle America Incorporated
 *
 * 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 javax.cache.integration;


import javax.cache.Cache;
import java.util.Collection;

/**
 * A CacheWriter is used for write-through to an external resource.
 * 

* Under Default Consistency, the non-batch writer methods are atomic with respect * to the corresponding cache operation. *

* For batch methods under Default Consistency, the entire cache operation * is not required to be atomic in {@link Cache} and is therefore not required to * be atomic in the writer. As individual writer operations can fail, cache * operations are not required to occur until after the writer batch method has * returned or, in the case of partial success, thrown an exception. In the case * of partial success, the collection of entries return must only contain * those entries that failed. *

* The entry passed into {@link #write(Cache.Entry)} is independent * of the cache mapping for that key, meaning that if the value changes in the * cache or is removed it does not change the entry. * * @param the type of keys maintained by this map * @param the type of mapped values * @author Greg Luck * @author Brian Oliver * @see CacheLoader * @since 1.0 */ public interface CacheWriter { /** * Write the specified value under the specified key to the external resource. *

* This method is intended to support both key/value creation and value update * for a specific key. * * @param entry the entry to be written * @throws CacheWriterException if the write fails. If thrown the * cache mutation will not occur. */ void write(Cache.Entry entry) throws CacheWriterException; /** * Write the specified entries to the external resource. This method is intended * to support both insert and update. *

* The order that individual writes occur is undefined, as * {@link Cache#putAll(java.util.Map)} also has undefined ordering. *

* If this operation fails (by throwing an exception) after a partial success, * the writer must remove any successfully written entries from the entries * collection so that the caching implementation knows what succeeded and can * mutate the cache. * * @param entries a mutable collection to write. Upon invocation, it contains * the entries to write for write-through. Upon return the * collection must only contain entries that were not * successfully written. (see partial success above) * @throws CacheWriterException if one or more of the writes fail. If * thrown cache mutations will occur for * entries that succeeded. */ void writeAll(Collection> entries) throws CacheWriterException; /** * Delete the cache entry from the external resource. *

* Expiry of a cache entry is not a delete hence will not cause this method to * be invoked. *

* This method is invoked even if no mapping for the key exists. * * @param key the key that is used for the delete operation * @throws CacheWriterException if delete fails. If thrown the cache delete will * not occur. */ void delete(Object key) throws CacheWriterException; /** * Remove data and keys from the external resource for the given collection of * keys, if present. *

* The order that individual deletes occur is undefined, as * {@link Cache#removeAll(java.util.Set)} also has undefined ordering. *

* If this operation fails (by throwing an exception) after a partial success, * the writer must remove any successfully written entries from the entries * collection so that the caching implementation knows what succeeded and can * mutate the cache. *

* Expiry of a cache entry is not a delete hence will not cause this method to * be invoked. *

* This method may include keys even if there is no mapping for that key, * in which case the data represented by that key should be removed from the * underlying resource. * * @param keys a mutable collection of keys for entries to delete. Upon * invocation, it contains the keys to delete for write-through. * Upon return the collection must only contain the keys that were * not successfully deleted. (see partial success above) * @throws CacheWriterException if one or more deletes fail. If thrown * cache deletes will occur for entries that * succeeded. */ void deleteAll(Collection keys) throws CacheWriterException; }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy