http://git-wip-us.apache.org/repos/asf/incubator-ignite/blob/f27a989c/modules/core/src/main/java/org/apache/ignite/internal/processors/cache/CacheProjection.java ---------------------------------------------------------------------- diff --git a/modules/core/src/main/java/org/apache/ignite/internal/processors/cache/CacheProjection.java b/modules/core/src/main/java/org/apache/ignite/internal/processors/cache/CacheProjection.java new file mode 100644 index 0000000..9a57d8e --- /dev/null +++ b/modules/core/src/main/java/org/apache/ignite/internal/processors/cache/CacheProjection.java @@ -0,0 +1,1925 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 org.apache.ignite.internal.processors.cache; + +import org.apache.ignite.*; +import org.apache.ignite.cache.*; +import org.apache.ignite.cache.store.*; +import org.apache.ignite.cluster.*; +import org.apache.ignite.internal.*; +import org.apache.ignite.internal.processors.cache.query.*; +import org.apache.ignite.internal.processors.cache.transactions.*; +import org.apache.ignite.lang.*; +import org.apache.ignite.transactions.*; +import org.jetbrains.annotations.*; + +import javax.cache.*; +import java.sql.*; +import java.util.*; +import java.util.Date; +import java.util.concurrent.*; + +/** + * This interface provides a rich API for working with distributed caches. It includes the following + * main functionality: + * <ul> + * <li> + * Various {@code 'get(..)'} methods to synchronously or asynchronously get values from cache. + * All {@code 'get(..)'} methods are transactional and will participate in an ongoing transaction + * if there is one. + * </li> + * <li> + * Various {@code 'put(..)'}, {@code 'putIfAbsent(..)'}, and {@code 'replace(..)'} methods to + * synchronously or asynchronously put single or multiple entries into cache. + * All these methods are transactional and will participate in an ongoing transaction + * if there is one. + * </li> + * <li> + * Various {@code 'remove(..)'} methods to synchronously or asynchronously remove single or multiple keys + * from cache. All {@code 'remove(..)'} methods are transactional and will participate in an ongoing transaction + * if there is one. + * </li> + * <li> + * Various {@code 'contains(..)'} method to check if cache contains certain keys or values locally. + * </li> + * <li> + * Various {@code 'forEach(..)'}, {@code 'forAny(..)'}, and {@code 'reduce(..)'} methods to visit + * every local cache entry within this projection. + * </li> + * <li> + * Various {@code flagsOn(..)'}, {@code 'flagsOff(..)'}, and {@code 'projection(..)'} methods to + * set specific flags and filters on a cache projection. + * </li> + * <li> + * Methods like {@code 'keySet(..)'}, {@code 'values(..)'}, and {@code 'entrySet(..)'} to provide + * views on cache keys, values, and entries. + * </li> + * <li> + * Various {@code 'peek(..)'} methods to peek at values in global or transactional memory, swap + * storage, or persistent storage. + * </li> + * <li> + * Various {@code 'reload(..)'} methods to reload latest values from persistent storage. + * </li> + * <li> + * Various {@code 'promote(..)'} methods to load specified keys from swap storage into + * global cache memory. + * </li> + * <li> + * Various {@code 'lock(..)'}, {@code 'unlock(..)'}, and {@code 'isLocked(..)'} methods to acquire, release, + * and check on distributed locks on a single or multiple keys in cache. All locking methods + * are not transactional and will not enlist keys into ongoing transaction, if any. + * </li> + * <li> + * Various {@code 'clear(..)'} methods to clear elements from cache, and optionally from + * swap storage. All {@code 'clear(..)'} methods are not transactional and will not enlist cleared + * keys into ongoing transaction, if any. + * </li> + * <li> + * Various {@code 'evict(..)'} methods to evict elements from cache, and optionally store + * them in underlying swap storage for later access. All {@code 'evict(..)'} methods are not + * transactional and will not enlist evicted keys into ongoing transaction, if any. + * </li> + * <li> + * Various {@code 'txStart(..)'} methods to perform various cache + * operations within a transaction (see {@link Transaction} for more information). + * </li> + * <li> + * {@link #queries()} method to get an instance of {@link CacheQueries} service for working + * with distributed cache queries. + * </li> + * <li> + * Various {@code 'gridProjection(..)'} methods which provide {@link org.apache.ignite.cluster.ClusterGroup} only + * for nodes on which given keys reside. All {@code 'gridProjection(..)'} methods are not + * transactional and will not enlist keys into ongoing transaction. + * </li> + * <li>Method {@link GridCache#toMap()} to convert this interface into standard Java {@link ConcurrentMap} interface. + * </ul> + * <h1 class="header">Extended Put And Remove Methods</h1> + * All methods that end with {@code 'x'} provide the same functionality as their sibling + * methods that don't end with {@code 'x'}, however instead of returning a previous value they + * return a {@code boolean} flag indicating whether operation succeeded or not. Returning + * a previous value may involve a network trip or a persistent store lookup and should be + * avoided whenever not needed. + * <h1 class="header">Predicate Filters</h1> + * All filters passed into methods on this API are checked <b>atomically</b>. In other words the + * value returned by the methods is guaranteed to be consistent with the filters passed in. Note + * that filters are optional, and if not passed in, then methods will still work as is without + * filter validation. + * <h1 class="header">Transactions</h1> + * Cache API supports distributed transactions. All {@code 'get(..)'}, {@code 'put(..)'}, {@code 'replace(..)'}, + * and {@code 'remove(..)'} operations are transactional and will participate in an ongoing transaction, + * if any. Other methods like {@code 'peek(..)'} or various {@code 'contains(..)'} methods may + * be transaction-aware, i.e. check in-transaction entries first, but will not affect the current + * state of transaction. See {@link Transaction} documentation for more information + * about transactions. + * <h1 class="header">Group Locking</h1> + * <i>Group Locking</i> is a feature where instead of acquiring individual locks, Ignite will lock + * multiple keys with one lock to save on locking overhead. There are 2 types of <i>Group Locking</i>: + * <i>affinity-based</i>, and <i>partitioned-based</i>. + * <p> + * With {@code affinity-based-group-locking} the keys are grouped by <i>affinity-key</i>. This means that + * only keys with identical affinity-key (see {@link org.apache.ignite.cache.affinity.CacheAffinityKeyMapped}) can participate in the + * transaction, and only one lock on the <i>affinity-key</i> will be acquired for the whole transaction. + * {@code Affinity-group-locked} transactions are started via + * {@link #txStartAffinity(Object, TransactionConcurrency, TransactionIsolation, long, int)} method. + * <p> + * With {@code partition-based-group-locking} the keys are grouped by partition ID. This means that + * only keys belonging to identical partition (see {@link org.apache.ignite.cache.affinity.CacheAffinity#partition(Object)}) can participate in the + * transaction, and only one lock on the whole partition will be acquired for the whole transaction. + * {@code Partition-group-locked} transactions are started via + * {@link #txStartPartition(int, TransactionConcurrency, TransactionIsolation, long, int)} method. + * <p> + * <i>Group locking</i> should always be used for transactions whenever possible. If your requirements fit either + * <i>affinity-based</i> or <i>partition-based</i> scenarios outlined above then <i>group-locking</i> + * can significantly improve performance of your application, often by an order of magnitude. + * <h1 class="header">Null Keys or Values</h1> + * Neither {@code null} keys or values are allowed to be stored in cache. If a {@code null} value + * happens to be in cache (e.g. after invalidation or remove), then cache will treat this case + * as there is no value at all. + * <h1 class="header">Peer Class Loading</h1> + * If peer-class-loading is enabled, all classes passed into cache API will be automatically deployed + * to any participating grid nodes. However, in case of redeployment, caches will be cleared and + * all entries will be removed. This behavior is useful during development, but should not be + * used in production. + * <h1 class="header">Portable Objects</h1> + * If an object is defined as portable Ignite cache will automatically store it in portable (i.e. binary) + * format. User can choose to work either with the portable format or with the deserialized form (assuming + * that class definitions are present in the classpath). By default, cache works with deserialized form + * (example shows the case when {@link Integer} is used as a key for a portable object): + * <pre> + * CacheProjection<Integer, Value> prj = Ignition.grid().cache(null); + * + * // Value will be serialized and stored in cache in portable format. + * prj.put(1, new Value()); + * + * // Value will be deserialized since it's stored in portable format. + * Value val = prj.get(1); + * </pre> + * You won't be able to work with deserialized form if class definition for the {@code Value} is not on + * classpath. Even if you have the class definition, you should always avoid full deserialization if it's not + * needed for performance reasons. To work with portable format directly you should create special projection + * using {@link #keepPortable()} method: + * <pre> + * CacheProjection<Integer, GridPortableObject> prj = Ignition.grid().cache(null).keepPortable(); + * + * // Value is not deserialized and returned in portable format. + * GridPortableObject po = prj.get(1); + * </pre> + * See {@link #keepPortable()} method JavaDoc for more details. + */ +public interface CacheProjection<K, V> extends Iterable<Cache.Entry<K, V>> { + /** + * Gets name of this cache ({@code null} for default cache). + * + * @return Cache name. + */ + public String name(); + + /** + * Gets grid projection for this cache. This projection includes all nodes which have this cache configured. + * + * @return Projection instance. + */ + public ClusterGroup gridProjection(); + + /** + * Gets base cache for this projection. + * + * @param <K1> Cache key type. + * @param <V1> Cache value type. + * @return Base cache for this projection. + */ + @SuppressWarnings({"ClassReferencesSubclass"}) + public <K1, V1> GridCache<K1, V1> cache(); + + /** + * Gets cache flags enabled on this projection. + * + * @return Flags for this projection (empty set if no flags have been set). + */ + public Set<CacheFlag> flags(); + + /** + * Returns queries facade responsible for creating various SQL, TEXT, or SCAN queries. + + * @return Queries facade responsible for creating various SQL, TEXT, or SCAN queries. + */ + public CacheQueries<K, V> queries(); + + /** + * Gets cache projection only for given key and value type. Only {@code non-null} key-value + * pairs that have matching key and value pairs will be used in this projection. + * + * @param keyType Key type. + * @param valType Value type. + * @param <K1> Key type. + * @param <V1> Value type. + * @return Cache projection for given key and value types. + */ + public <K1, V1> CacheProjection<K1, V1> projection(Class<? super K1> keyType, Class<? super V1> valType); + + /** + * Gets cache projection based on given key-value predicate. Whenever makes sense, + * this predicate will be used to pre-filter cache operations. If + * operation passed pre-filtering, this filter will be passed through + * to cache operations as well. + * <p> + * For example, for {@link #putAll(Map, org.apache.ignite.lang.IgnitePredicate[])} method only + * elements that pass the filter will be given to {@code Cache.putAll(m, filter)} + * where it will be checked once again prior to put. + * + * @param p Key-value predicate for this projection. If {@code null}, then the + * same projection is returned. + * @return Projection for given key-value predicate. + */ + public CacheProjection<K, V> projection(@Nullable IgniteBiPredicate<K, V> p); + + /** + * Gets cache projection based on given entry filter. This filter will be simply passed through + * to all cache operations on this projection. Unlike {@link #projection(org.apache.ignite.lang.IgniteBiPredicate)} + * method, this filter will <b>not</b> be used for pre-filtering. + * + * @param filter Filter to be passed through to all cache operations. If {@code null}, then the + * same projection is returned. If cache operation receives its own filter, then filters + * will be {@code 'anded'}. + * @return Projection based on given filter. + */ + public CacheProjection<K, V> projection(@Nullable IgnitePredicate<Cache.Entry<K, V>> filter); + + /** + * Gets cache projection base on this one, but with the specified flags turned on. + * <h1 class="header">Cache Flags</h1> + * The resulting projection will inherit all the flags from this projection. + * + * @param flags Flags to turn on (if empty, then no-op). + * @return New projection based on this one, but with the specified flags turned on. + */ + public CacheProjection<K, V> flagsOn(@Nullable CacheFlag... flags); + + /** + * Gets cache projection base on this but with the specified flags turned off. + * <h1 class="header">Cache Flags</h1> + * The resulting projection will inherit all the flags from this projection except for + * the ones that were turned off. + * + * @param flags Flags to turn off (if empty, then all flags will be turned off). + * @return New projection based on this one, but with the specified flags turned off. + */ + public CacheProjection<K, V> flagsOff(@Nullable CacheFlag... flags); + + /** + * Creates projection that will operate with portable objects. + * <p> + * Projection returned by this method will force cache not to deserialize portable objects, + * so keys and values will be returned from cache API methods without changes. Therefore, + * signature of the projection can contain only following types: + * <ul> + * <li>{@link org.gridgain.grid.portables.PortableObject} for portable classes</li> + * <li>All primitives (byte, int, ...) and there boxed versions (Byte, Integer, ...)</li> + * <li>Arrays of primitives (byte[], int[], ...)</li> + * <li>{@link String} and array of {@link String}s</li> + * <li>{@link UUID} and array of {@link UUID}s</li> + * <li>{@link Date} and array of {@link Date}s</li> + * <li>{@link Timestamp} and array of {@link Timestamp}s</li> + * <li>Enums and array of enums</li> + * <li> + * Maps, collections and array of objects (but objects inside + * them will still be converted if they are portable) + * </li> + * </ul> + * <p> + * For example, if you use {@link Integer} as a key and {@code Value} class as a value + * (which will be stored in portable format), you should acquire following projection + * to avoid deserialization: + * <pre> + * CacheProjection<Integer, GridPortableObject> prj = cache.keepPortable(); + * + * // Value is not deserialized and returned in portable format. + * GridPortableObject po = prj.get(1); + * </pre> + * <p> + * Note that this method makes sense only if cache is working in portable mode + * ({@link org.apache.ignite.configuration.CacheConfiguration#isPortableEnabled()} returns {@code true}. If not, + * this method is no-op and will return current projection. + * + * @return Projection for portable objects. + */ + public <K1, V1> CacheProjection<K1, V1> keepPortable(); + + /** + * Returns {@code true} if this map contains no key-value mappings. + * + * @return {@code true} if this map contains no key-value mappings. + */ + public boolean isEmpty(); + + /** + * Converts this API into standard Java {@link ConcurrentMap} interface. + * + * @return {@link ConcurrentMap} representation of given cache projection. + */ + public ConcurrentMap<K, V> toMap(); + + /** + * @param key Key. + * @return {@code True} if cache contains mapping for a given key. + */ + public boolean containsKey(K key); + + /** + * @param key Key. + * @return Future. + */ + public IgniteInternalFuture<Boolean> containsKeyAsync(K key); + + /** + * @param keys Keys, + * @return {@code True} if cache contains all keys. + */ + public boolean containsKeys(Collection<? extends K> keys); + + /** + * @param keys Keys to check. + * @return Future. + */ + public IgniteInternalFuture<Boolean> containsKeysAsync(Collection<? extends K> keys); + + /** + * Returns {@code true} if this cache contains given value. + * + * @param val Value to check. + * @return {@code True} if given value is present in cache. + * @throws NullPointerException if the value is {@code null}. + */ + public boolean containsValue(V val); + + /** + * Executes visitor closure on each cache element. + * <h2 class="header">Transactions</h2> + * This method is not transactional and will not enlist keys into transaction simply + * because they were visited. However, if you perform transactional operations on the + * visited entries, those operations will enlist the entry into transaction. + * + * @param vis Closure which will be invoked for each cache entry. + */ + public void forEach(IgniteInClosure<Cache.Entry<K, V>> vis); + + /** + * Tests whether the predicate holds for all entries. If cache is empty, + * then {@code true} is returned. + * <h2 class="header">Transactions</h2> + * This method is not transactional and will not enlist keys into transaction simply + * because they were visited. However, if you perform transactional operations on the + * visited entries, those operations will enlist the entry into transaction. + * + * @param vis Predicate to test for each cache entry. + * @return {@code True} if the given predicate holds for all visited entries, {@code false} otherwise. + */ + public boolean forAll(IgnitePredicate<Cache.Entry<K, V>> vis); + + /** + * Reloads a single key from persistent storage. This method + * delegates to {@link CacheStore#load(Transaction, Object)} + * method. + * <h2 class="header">Transactions</h2> + * This method does not participate in transactions, however it does not violate + * cache integrity and can be used safely with or without transactions. + * + * @param key Key to reload. + * @return Reloaded value or current value if entry was updated while reloading. + * @throws IgniteCheckedException If reloading failed. + */ + @Nullable public V reload(K key) throws IgniteCheckedException; + + /** + * Asynchronously reloads a single key from persistent storage. This method + * delegates to {@link CacheStore#load(Transaction, Object)} + * method. + * <h2 class="header">Transactions</h2> + * This method does not participate in transactions, however it does not violate + * cache integrity and can be used safely with or without transactions. + * + * @param key Key to reload. + * @return Future to be completed whenever the entry is reloaded. + */ + public IgniteInternalFuture<V> reloadAsync(K key); + + /** + * Reloads all currently cached keys form persistent storage. + * <h2 class="header">Transactions</h2> + * This method does not participate in transactions, however it does not violate + * cache integrity and can be used safely with or without transactions. + * + * @throws IgniteCheckedException If reloading failed. + */ + public void reloadAll() throws IgniteCheckedException; + + /** + * Asynchronously reloads all specified entries from underlying + * persistent storage. + * <h2 class="header">Transactions</h2> + * This method does not participate in transactions, however it does not violate + * cache integrity and can be used safely with or without transactions. + * + * @return Future which will complete whenever {@code reload} completes. + */ + public IgniteInternalFuture<?> reloadAllAsync(); + + /** + * Reloads specified entries from underlying persistent storage. + * <h2 class="header">Transactions</h2> + * This method does not participate in transactions, however it does not violate + * cache integrity and can be used safely with or without transactions. + * + * @param keys Keys to reload. + * @throws IgniteCheckedException if reloading failed. + */ + public void reloadAll(@Nullable Collection<? extends K> keys) throws IgniteCheckedException; + + /** + * Asynchronously reloads all specified entries from underlying + * persistent storage. + * <h2 class="header">Transactions</h2> + * This method does not participate in transactions, however it does not violate + * cache integrity and can be used safely with or without transactions. + * + * @param keys Keys to reload. + * @return Future which will complete whenever {@code reload} completes. + */ + public IgniteInternalFuture<?> reloadAllAsync(@Nullable Collection<? extends K> keys); + + /** + * Peeks at in-memory cached value using default {@link GridCachePeekMode#SMART} + * peek mode. + * <p> + * This method will not load value from any persistent store or from a remote node. + * <h2 class="header">Transactions</h2> + * This method does not participate in any transactions, however, it will + * peek at transactional value according to the {@link GridCachePeekMode#SMART} mode + * semantics. If you need to look at global cached value even from within transaction, + * you can use {@link GridCache#peek(Object, Collection)} method. + * + * @param key Entry key. + * @return Peeked value. + * @throws NullPointerException If key is {@code null}. + */ + @Nullable public V peek(K key); + + /** + * @param key Key. + * @param peekModes Peek modes. + * @param plc Expiry policy if TTL should be updated. + * @return Value. + * @throws IgniteCheckedException If failed. + */ + @Nullable public V localPeek(K key, CachePeekMode[] peekModes, @Nullable IgniteCacheExpiryPolicy plc) + throws IgniteCheckedException; + + /** + * @param peekModes Peek modes. + * @return Entries iterable. + * @throws IgniteCheckedException If failed. + */ + public Iterable<Cache.Entry<K, V>> localEntries(CachePeekMode[] peekModes) throws IgniteCheckedException; + + /** + * Peeks at cached value using optional set of peek modes. This method will sequentially + * iterate over given peek modes in the order passed in, and try to peek at value using + * each peek mode. Once a {@code non-null} value is found, it will be immediately returned. + * <p> + * Note that if modes are not provided this method works exactly the same way as + * {@link #peek(Object)}, implicitly using {@link GridCachePeekMode#SMART} mode. + * <h2 class="header">Transactions</h2> + * This method does not participate in any transactions, however, it may + * peek at transactional value depending on the peek modes used. + * + * @param key Entry key. + * @param modes Optional set of peek modes. + * @return Peeked value. + * @throws IgniteCheckedException If peek operation failed. + * @throws NullPointerException If key is {@code null}. + */ + @Nullable public V peek(K key, @Nullable Collection<GridCachePeekMode> modes) throws IgniteCheckedException; + + /** + * Retrieves value mapped to the specified key from cache. Value will only be returned if + * its entry passed the optional filter provided. Filter check is atomic, and therefore the + * returned value is guaranteed to be consistent with the filter. The return value of {@code null} + * means entry did not pass the provided filter or cache has no mapping for the + * key. + * <p> + * If the value is not present in cache, then it will be looked up from swap storage. If + * it's not present in swap, or if swap is disable, and if read-through is allowed, value + * will be loaded from {@link CacheStore} persistent storage via + * {@link CacheStore#load(Transaction, Object)} method. + * <h2 class="header">Transactions</h2> + * This method is transactional and will enlist the entry into ongoing transaction + * if there is one. + * <h2 class="header">Cache Flags</h2> + * This method is not available if {@link CacheFlag#LOCAL} flag is set on projection. + * + * @param key Key to retrieve the value for. + * @return Value for the given key. + * @throws IgniteCheckedException If get operation failed. + * @throws CacheFlagException If failed projection flags validation. + * @throws NullPointerException if the key is {@code null}. + */ + @Nullable public V get(K key) throws IgniteCheckedException; + + /** + * Asynchronously retrieves value mapped to the specified key from cache. Value will only be returned if + * its entry passed the optional filter provided. Filter check is atomic, and therefore the + * returned value is guaranteed to be consistent with the filter. The return value of {@code null} + * means entry did not pass the provided filter or cache has no mapping for the + * key. + * <p> + * If the value is not present in cache, then it will be looked up from swap storage. If + * it's not present in swap, or if swap is disabled, and if read-through is allowed, value + * will be loaded from {@link CacheStore} persistent storage via + * {@link CacheStore#load(Transaction, Object)} method. + * <h2 class="header">Transactions</h2> + * This method is transactional and will enlist the entry into ongoing transaction + * if there is one. + * <h2 class="header">Cache Flags</h2> + * This method is not available if {@link CacheFlag#LOCAL} flag is set on projection. + * + * @param key Key for the value to get. + * @return Future for the get operation. + * @throws NullPointerException if the key is {@code null}. + * @throws CacheFlagException If projection flags validation failed. + */ + public IgniteInternalFuture<V> getAsync(K key); + + /** + * Retrieves values mapped to the specified keys from cache. Value will only be returned if + * its entry passed the optional filter provided. Filter check is atomic, and therefore the + * returned value is guaranteed to be consistent with the filter. If requested key-value pair + * is not present in the returned map, then it means that its entry did not pass the provided + * filter or cache has no mapping for the key. + * <p> + * If some value is not present in cache, then it will be looked up from swap storage. If + * it's not present in swap, or if swap is disabled, and if read-through is allowed, value + * will be loaded from {@link CacheStore} persistent storage via + * {@link CacheStore#loadAll(Transaction, Collection, org.apache.ignite.lang.IgniteBiInClosure)} method. + * <h2 class="header">Transactions</h2> + * This method is transactional and will enlist the entry into ongoing transaction + * if there is one. + * <h2 class="header">Cache Flags</h2> + * This method is not available if {@link CacheFlag#LOCAL} flag is set on projection. + * + * @param keys Keys to get. + * @return Map of key-value pairs. + * @throws IgniteCheckedException If get operation failed. + * @throws CacheFlagException If failed projection flags validation. + */ + public Map<K, V> getAll(@Nullable Collection<? extends K> keys) throws IgniteCheckedException; + + /** + * Asynchronously retrieves values mapped to the specified keys from cache. Value will only be returned if + * its entry passed the optional filter provided. Filter check is atomic, and therefore the + * returned value is guaranteed to be consistent with the filter. If requested key-value pair + * is not present in the returned map, then it means that its entry did not pass the provided + * filter or cache has no mapping for the key. + * <p> + * If some value is not present in cache, then it will be looked up from swap storage. If + * it's not present in swap, or if swap is disabled, and if read-through is allowed, value + * will be loaded from {@link CacheStore} persistent storage via + * {@link CacheStore#loadAll(Transaction, Collection, org.apache.ignite.lang.IgniteBiInClosure)} method. + * <h2 class="header">Transactions</h2> + * This method is transactional and will enlist the entry into ongoing transaction + * if there is one. + * <h2 class="header">Cache Flags</h2> + * This method is not available if {@link CacheFlag#LOCAL} flag is set on projection. + * + * @param keys Key for the value to get. + * @return Future for the get operation. + * @throws CacheFlagException If projection flags validation failed. + */ + public IgniteInternalFuture<Map<K, V>> getAllAsync(@Nullable Collection<? extends K> keys); + + /** + * Stores given key-value pair in cache. If filters are provided, then entries will + * be stored in cache only if they pass the filter. Note that filter check is atomic, + * so value stored in cache is guaranteed to be consistent with the filters. If cache + * previously contained value for the given key, then this value is returned. + * In case of {@link CacheMode#PARTITIONED} or {@link CacheMode#REPLICATED} caches, + * the value will be loaded from the primary node, which in its turn may load the value + * from the swap storage, and consecutively, if it's not in swap, + * from the underlying persistent storage. If value has to be loaded from persistent + * storage, {@link CacheStore#load(Transaction, Object)} method will be used. + * <p> + * If the returned value is not needed, method {@link #putx(Object, Object, org.apache.ignite.lang.IgnitePredicate[])} should + * always be used instead of this one to avoid the overhead associated with returning of the previous value. + * <p> + * If write-through is enabled, the stored value will be persisted to {@link CacheStore} + * via {@link CacheStore#put(Transaction, Object, Object)} method. + * <h2 class="header">Transactions</h2> + * This method is transactional and will enlist the entry into ongoing transaction + * if there is one. + * <h2 class="header">Cache Flags</h2> + * This method is not available if any of the following flags are set on projection: + * {@link CacheFlag#LOCAL}, {@link CacheFlag#READ}. + * + * @param key Key to store in cache. + * @param val Value to be associated with the given key. + * @param filter Optional filter to check prior to putting value in cache. Note + * that filter check is atomic with put operation. + * @return Previous value associated with specified key, or {@code null} + * if entry did not pass the filter, or if there was no mapping for the key in swap + * or in persistent storage. + * @throws NullPointerException If either key or value are {@code null}. + * @throws IgniteCheckedException If put operation failed. + * @throws CacheFlagException If projection flags validation failed. + */ + @Nullable public V put(K key, V val, @Nullable IgnitePredicate<Cache.Entry<K, V>>... filter) + throws IgniteCheckedException; + + /** + * Asynchronously stores given key-value pair in cache. If filters are provided, then entries will + * be stored in cache only if they pass the filter. Note that filter check is atomic, + * so value stored in cache is guaranteed to be consistent with the filters. If cache + * previously contained value for the given key, then this value is returned. Otherwise, + * in case of {@link CacheMode#REPLICATED} caches, the value will be loaded from swap + * and, if it's not there, and read-through is allowed, from the underlying + * {@link CacheStore} storage. In case of {@link CacheMode#PARTITIONED} caches, + * the value will be loaded from the primary node, which in its turn may load the value + * from the swap storage, and consecutively, if it's not in swap and read-through is allowed, + * from the underlying persistent storage. If value has to be loaded from persistent + * storage, {@link CacheStore#load(Transaction, Object)} method will be used. + * <p> + * If the returned value is not needed, method {@link #putx(Object, Object, org.apache.ignite.lang.IgnitePredicate[])} should + * always be used instead of this one to avoid the overhead associated with returning of the previous value. + * <p> + * If write-through is enabled, the stored value will be persisted to {@link CacheStore} + * via {@link CacheStore#put(Transaction, Object, Object)} method. + * <h2 class="header">Transactions</h2> + * This method is transactional and will enlist the entry into ongoing transaction + * if there is one. + * <h2 class="header">Cache Flags</h2> + * This method is not available if any of the following flags are set on projection: + * {@link CacheFlag#LOCAL}, {@link CacheFlag#READ}. + * + * @param key Key to store in cache. + * @param val Value to be associated with the given key. + * @param filter Optional filter to check prior to putting value in cache. Note + * that filter check is atomic with put operation. + * @return Future for the put operation. + * @throws NullPointerException If either key or value are {@code null}. + * @throws CacheFlagException If projection flags validation failed. + */ + public IgniteInternalFuture<V> putAsync(K key, V val, @Nullable IgnitePredicate<Cache.Entry<K, V>>... filter); + + /** + * Stores given key-value pair in cache. If filters are provided, then entries will + * be stored in cache only if they pass the filter. Note that filter check is atomic, + * so value stored in cache is guaranteed to be consistent with the filters. + * <p> + * This method will return {@code true} if value is stored in cache and {@code false} otherwise. + * Unlike {@link #put(Object, Object, org.apache.ignite.lang.IgnitePredicate[])} method, it does not return previous + * value and, therefore, does not have any overhead associated with returning a value. It + * should be used whenever return value is not required. + * <p> + * If write-through is enabled, the stored value will be persisted to {@link CacheStore} + * via {@link CacheStore#put(Transaction, Object, Object)} method. + * <h2 class="header">Transactions</h2> + * This method is transactional and will enlist the entry into ongoing transaction + * if there is one. + * <h2 class="header">Cache Flags</h2> + * This method is not available if any of the following flags are set on projection: + * {@link CacheFlag#LOCAL}, {@link CacheFlag#READ}. + * + * @param key Key to store in cache. + * @param val Value to be associated with the given key. + * @param filter Optional filter to check prior to putting value in cache. Note + * that filter check is atomic with put operation. + * @return {@code True} if optional filter passed and value was stored in cache, + * {@code false} otherwise. Note that this method will return {@code true} if filter is not + * specified. + * @throws NullPointerException If either key or value are {@code null}. + * @throws IgniteCheckedException If put operation failed. + * @throws CacheFlagException If projection flags validation failed. + */ + public boolean putx(K key, V val, @Nullable IgnitePredicate<Cache.Entry<K, V>>... filter) + throws IgniteCheckedException; + + /** + * Stores given key-value pair in cache. If filters are provided, then entries will + * be stored in cache only if they pass the filter. Note that filter check is atomic, + * so value stored in cache is guaranteed to be consistent with the filters. + * <p> + * This method will return {@code true} if value is stored in cache and {@code false} otherwise. + * Unlike {@link #put(Object, Object, org.apache.ignite.lang.IgnitePredicate[])} method, it does not return previous + * value and, therefore, does not have any overhead associated with returning of a value. It + * should always be used whenever return value is not required. + * <p> + * If write-through is enabled, the stored value will be persisted to {@link CacheStore} + * via {@link CacheStore#put(Transaction, Object, Object)} method. + * <h2 class="header">Transactions</h2> + * This method is transactional and will enlist the entry into ongoing transaction + * if there is one. + * <h2 class="header">Cache Flags</h2> + * This method is not available if any of the following flags are set on projection: + * {@link CacheFlag#LOCAL}, {@link CacheFlag#READ}. + * + * @param key Key to store in cache. + * @param val Value to be associated with the given key. + * @param filter Optional filter to check prior to putting value in cache. Note + * that filter check is atomic with put operation. + * @return Future for the put operation. Future will return {@code true} if optional filter + * passed and value was stored in cache, {@code false} otherwise. Note that future will + * return {@code true} if filter is not specified. + * @throws NullPointerException If either key or value are {@code null}. + * @throws CacheFlagException If projection flags validation failed. + */ + public IgniteInternalFuture<Boolean> putxAsync(K key, V val, @Nullable IgnitePredicate<Cache.Entry<K, V>>... filter); + + /** + * Stores given key-value pair in cache only if cache had no previous mapping for it. If cache + * previously contained value for the given key, then this value is returned. + * In case of {@link CacheMode#PARTITIONED} or {@link CacheMode#REPLICATED} caches, + * the value will be loaded from the primary node, which in its turn may load the value + * from the swap storage, and consecutively, if it's not in swap, + * from the underlying persistent storage. If value has to be loaded from persistent + * storage, {@link CacheStore#load(Transaction, Object)} method will be used. + * <p> + * If the returned value is not needed, method {@link #putxIfAbsent(Object, Object)} should + * always be used instead of this one to avoid the overhead associated with returning of the + * previous value. + * <p> + * If write-through is enabled, the stored value will be persisted to {@link CacheStore} + * via {@link CacheStore#put(Transaction, Object, Object)} method. + * <h2 class="header">Transactions</h2> + * This method is transactional and will enlist the entry into ongoing transaction + * if there is one. + * <h2 class="header">Cache Flags</h2> + * This method is not available if any of the following flags are set on projection: + * {@link CacheFlag#LOCAL}, {@link CacheFlag#READ}. + * + * @param key Key to store in cache. + * @param val Value to be associated with the given key. + * @return Previously contained value regardless of whether put happened or not. + * @throws NullPointerException If either key or value are {@code null}. + * @throws IgniteCheckedException If put operation failed. + * @throws CacheFlagException If projection flags validation failed. + */ + @Nullable public V putIfAbsent(K key, V val) throws IgniteCheckedException; + + /** + * Asynchronously stores given key-value pair in cache only if cache had no previous mapping for it. If cache + * previously contained value for the given key, then this value is returned. In case of + * {@link CacheMode#PARTITIONED} or {@link CacheMode#REPLICATED} caches, + * the value will be loaded from the primary node, which in its turn may load the value + * from the swap storage, and consecutively, if it's not in swap, + * from the underlying persistent storage. If value has to be loaded from persistent + * storage, {@link CacheStore#load(Transaction, Object)} method will be used. + * <p> + * If the returned value is not needed, method {@link #putxIfAbsentAsync(Object, Object)} should + * always be used instead of this one to avoid the overhead associated with returning of the + * previous value. + * <p> + * If write-through is enabled, the stored value will be persisted to {@link CacheStore} + * via {@link CacheStore#put(Transaction, Object, Object)} method. + * <h2 class="header">Transactions</h2> + * This method is transactional and will enlist the entry into ongoing transaction + * if there is one. + * <h2 class="header">Cache Flags</h2> + * This method is not available if any of the following flags are set on projection: + * {@link CacheFlag#LOCAL}, {@link CacheFlag#READ}. + * + * @param key Key to store in cache. + * @param val Value to be associated with the given key. + * @return Future of put operation which will provide previously contained value + * regardless of whether put happened or not. + * @throws NullPointerException If either key or value are {@code null}. + * @throws CacheFlagException If projection flags validation failed. + */ + public IgniteInternalFuture<V> putIfAbsentAsync(K key, V val); + + /** + * Stores given key-value pair in cache only if cache had no previous mapping for it. + * <p> + * This method will return {@code true} if value is stored in cache and {@code false} otherwise. + * Unlike {@link #putIfAbsent(Object, Object)} method, it does not return previous + * value and, therefore, does not have any overhead associated with returning of a value. It + * should always be used whenever return value is not required. + * <p> + * If write-through is enabled, the stored value will be persisted to {@link CacheStore} + * via {@link CacheStore#put(Transaction, Object, Object)} method. + * <h2 class="header">Transactions</h2> + * This method is transactional and will enlist the entry into ongoing transaction + * if there is one. + * <h2 class="header">Cache Flags</h2> + * This method is not available if any of the following flags are set on projection: + * {@link CacheFlag#LOCAL}, {@link CacheFlag#READ}. + * + * @param key Key to store in cache. + * @param val Value to be associated with the given key. + * @return {@code true} if value is stored in cache and {@code false} otherwise. + * @throws NullPointerException If either key or value are {@code null}. + * @throws IgniteCheckedException If put operation failed. + * @throws CacheFlagException If projection flags validation failed. + */ + public boolean putxIfAbsent(K key, V val) throws IgniteCheckedException; + + /** + * Asynchronously stores given key-value pair in cache only if cache had no previous mapping for it. + * <p> + * This method will return {@code true} if value is stored in cache and {@code false} otherwise. + * Unlike {@link #putIfAbsent(Object, Object)} method, it does not return previous + * value and, therefore, does not have any overhead associated with returning of a value. It + * should always be used whenever return value is not required. + * <p> + * If write-through is enabled, the stored value will be persisted to {@link CacheStore} + * via {@link CacheStore#put(Transaction, Object, Object)} method. + * <h2 class="header">Transactions</h2> + * This method is transactional and will enlist the entry into ongoing transaction + * if there is one. + * <h2 class="header">Cache Flags</h2> + * This method is not available if any of the following flags are set on projection: + * {@link CacheFlag#LOCAL}, {@link CacheFlag#READ}. + * + * @param key Key to store in cache. + * @param val Value to be associated with the given key. + * @return Future for this put operation. + * @throws NullPointerException If either key or value are {@code null}. + * @throws CacheFlagException If projection flags validation failed. + */ + public IgniteInternalFuture<Boolean> putxIfAbsentAsync(K key, V val); + + /** + * Stores given key-value pair in cache only if there is a previous mapping for it. + * In case of {@link CacheMode#PARTITIONED} or {@link CacheMode#REPLICATED} caches, + * the value will be loaded from the primary node, which in its turn may load the value + * from the swap storage, and consecutively, if it's not in swap, + * from the underlying persistent storage. If value has to be loaded from persistent + * storage, {@link CacheStore#load(Transaction, Object)} method will be used. + * <p> + * If the returned value is not needed, method {@link #replacex(Object, Object)} should + * always be used instead of this one to avoid the overhead associated with returning of the + * previous value. + * <p> + * If write-through is enabled, the stored value will be persisted to {@link CacheStore} + * via {@link CacheStore#put(Transaction, Object, Object)} method. + * <h2 class="header">Transactions</h2> + * This method is transactional and will enlist the entry into ongoing transaction + * if there is one. + * <h2 class="header">Cache Flags</h2> + * This method is not available if any of the following flags are set on projection: + * {@link CacheFlag#LOCAL}, {@link CacheFlag#READ}. + * + * @param key Key to store in cache. + * @param val Value to be associated with the given key. + * @return Previously contained value regardless of whether replace happened or not. + * @throws NullPointerException If either key or value are {@code null}. + * @throws IgniteCheckedException If replace operation failed. + * @throws CacheFlagException If projection flags validation failed. + */ + @Nullable public V replace(K key, V val) throws IgniteCheckedException; + + /** + * Asynchronously stores given key-value pair in cache only if there is a previous mapping for it. If cache + * previously contained value for the given key, then this value is returned.In case of + * {@link CacheMode#PARTITIONED} caches, the value will be loaded from the primary node, + * which in its turn may load the value from the swap storage, and consecutively, if it's not in swap, + * from the underlying persistent storage. If value has to be loaded from persistent + * storage, {@link CacheStore#load(Transaction, Object)} method will be used. + * <p> + * If the returned value is not needed, method {@link #replacex(Object, Object)} should + * always be used instead of this one to avoid the overhead associated with returning of the + * previous value. + * <p> + * If write-through is enabled, the stored value will be persisted to {@link CacheStore} + * via {@link CacheStore#put(Transaction, Object, Object)} method. + * <h2 class="header">Transactions</h2> + * This method is transactional and will enlist the entry into ongoing transaction + * if there is one. + * <h2 class="header">Cache Flags</h2> + * This method is not available if any of the following flags are set on projection: + * {@link CacheFlag#LOCAL}, {@link CacheFlag#READ}. + * + * @param key Key to store in cache. + * @param val Value to be associated with the given key. + * @return Future for replace operation. + * @throws NullPointerException If either key or value are {@code null}. + * @throws CacheFlagException If projection flags validation failed. + */ + public IgniteInternalFuture<V> replaceAsync(K key, V val); + + /** + * Stores given key-value pair in cache only if only if there is a previous mapping for it. + * <p> + * This method will return {@code true} if value is stored in cache and {@code false} otherwise. + * Unlike {@link #replace(Object, Object)} method, it does not return previous + * value and, therefore, does not have any overhead associated with returning of a value. It + * should always be used whenever return value is not required. + * <p> + * If write-through is enabled, the stored value will be persisted to {@link CacheStore} + * via {@link CacheStore#put(Transaction, Object, Object)} method. + * <h2 class="header">Transactions</h2> + * This method is transactional and will enlist the entry into ongoing transaction + * if there is one. + * <h2 class="header">Cache Flags</h2> + * This method is not available if any of the following flags are set on projection: + * {@link CacheFlag#LOCAL}, {@link CacheFlag#READ}. + * + * @param key Key to store in cache. + * @param val Value to be associated with the given key. + * @return {@code True} if replace happened, {@code false} otherwise. + * @throws NullPointerException If either key or value are {@code null}. + * @throws IgniteCheckedException If replace operation failed. + * @throws CacheFlagException If projection flags validation failed. + */ + public boolean replacex(K key, V val) throws IgniteCheckedException; + + /** + * Asynchronously stores given key-value pair in cache only if only if there is a previous mapping for it. + * <p> + * This method will return {@code true} if value is stored in cache and {@code false} otherwise. + * Unlike {@link #replaceAsync(Object, Object)} method, it does not return previous + * value and, therefore, does not have any overhead associated with returning of a value. It + * should always be used whenever return value is not required. + * <p> + * If write-through is enabled, the stored value will be persisted to {@link CacheStore} + * via {@link CacheStore#put(Transaction, Object, Object)} method. + * <h2 class="header">Transactions</h2> + * This method is transactional and will enlist the entry into ongoing transaction + * if there is one. + * <h2 class="header">Cache Flags</h2> + * This method is not available if any of the following flags are set on projection: + * {@link CacheFlag#LOCAL}, {@link CacheFlag#READ}. + * + * @param key Key to store in cache. + * @param val Value to be associated with the given key. + * @return Future for the replace operation. + * @throws NullPointerException If either key or value are {@code null}. + * @throws CacheFlagException If projection flags validation failed. + */ + public IgniteInternalFuture<Boolean> replacexAsync(K key, V val); + + /** + * Stores given key-value pair in cache only if only if the previous value is equal to the + * {@code 'oldVal'} passed in. + * <p> + * This method will return {@code true} if value is stored in cache and {@code false} otherwise. + * <p> + * If write-through is enabled, the stored value will be persisted to {@link CacheStore} + * via {@link CacheStore#put(Transaction, Object, Object)} method. + * <h2 class="header">Transactions</h2> + * This method is transactional and will enlist the entry into ongoing transaction + * if there is one. + * <h2 class="header">Cache Flags</h2> + * This method is not available if any of the following flags are set on projection: + * {@link CacheFlag#LOCAL}, {@link CacheFlag#READ}. + * + * @param key Key to store in cache. + * @param oldVal Old value to match. + * @param newVal Value to be associated with the given key. + * @return {@code True} if replace happened, {@code false} otherwise. + * @throws NullPointerException If either key or value are {@code null}. + * @throws IgniteCheckedException If replace operation failed. + * @throws CacheFlagException If projection flags validation failed. + */ + public boolean replace(K key, V oldVal, V newVal) throws IgniteCheckedException; + + /** + * Asynchronously stores given key-value pair in cache only if only if the previous value is equal to the + * {@code 'oldVal'} passed in. + * <p> + * This method will return {@code true} if value is stored in cache and {@code false} otherwise. + * <p> + * If write-through is enabled, the stored value will be persisted to {@link CacheStore} + * via {@link CacheStore#put(Transaction, Object, Object)} method. + * <h2 class="header">Transactions</h2> + * This method is transactional and will enlist the entry into ongoing transaction + * if there is one. + * <h2 class="header">Cache Flags</h2> + * This method is not available if any of the following flags are set on projection: + * {@link CacheFlag#LOCAL}, {@link CacheFlag#READ}. + * + * @param key Key to store in cache. + * @param oldVal Old value to match. + * @param newVal Value to be associated with the given key. + * @return Future for the replace operation. + * @throws NullPointerException If either key or value are {@code null}. + * @throws CacheFlagException If projection flags validation failed. + */ + public IgniteInternalFuture<Boolean> replaceAsync(K key, V oldVal, V newVal); + + /** + * Stores given key-value pairs in cache. If filters are provided, then entries will + * be stored in cache only if they pass the filter. Note that filter check is atomic, + * so value stored in cache is guaranteed to be consistent with the filters. + * <p> + * If write-through is enabled, the stored values will be persisted to {@link CacheStore} + * via {@link CacheStore#putAll(Transaction, Map)} method. + * <h2 class="header">Transactions</h2> + * This method is transactional and will enlist the entry into ongoing transaction + * if there is one. + * <h2 class="header">Cache Flags</h2> + * This method is not available if any of the following flags are set on projection: + * {@link CacheFlag#LOCAL}, {@link CacheFlag#READ}. + * + * @param m Key-value pairs to store in cache. + * @param filter Optional entry filter. If provided, then entry will + * be stored only if the filter returned {@code true}. + * @throws IgniteCheckedException If put operation failed. + * @throws CacheFlagException If projection flags validation failed. + */ + public void putAll(@Nullable Map<? extends K, ? extends V> m, + @Nullable IgnitePredicate<Cache.Entry<K, V>>... filter) throws IgniteCheckedException; + + /** + * Asynchronously stores given key-value pairs in cache. If filters are provided, then entries will + * be stored in cache only if they pass the filter. Note that filter check is atomic, + * so value stored in cache is guaranteed to be consistent with the filters. + * <p> + * If write-through is enabled, the stored values will be persisted to {@link CacheStore} + * via {@link CacheStore#putAll(Transaction, Map)} method. + * <h2 class="header">Transactions</h2> + * This method is transactional and will enlist the entry into ongoing transaction + * if there is one. + * <h2 class="header">Cache Flags</h2> + * This method is not available if any of the following flags are set on projection: + * {@link CacheFlag#LOCAL}, {@link CacheFlag#READ}. + * + * @param m Key-value pairs to store in cache. + * @param filter Optional entry filter. If provided, then entry will + * be stored only if the filter returned {@code true}. + * @return Future for putAll operation. + * @throws CacheFlagException If projection flags validation failed. + */ + public IgniteInternalFuture<?> putAllAsync(@Nullable Map<? extends K, ? extends V> m, + @Nullable IgnitePredicate<Cache.Entry<K, V>>... filter); + + /** + * Set of keys cached on this node. You can remove elements from this set, but you cannot add elements + * to this set. All removal operation will be reflected on the cache itself. + * <p> + * Iterator over this set will not fail if set was concurrently updated + * by another thread. This means that iterator may or may not return latest + * keys depending on whether they were added before or after current + * iterator position. + * <p> + * NOTE: this operation is not distributed and returns only the keys cached on this node. + * + * @return Key set for this cache projection. + */ + public Set<K> keySet(); + + /** + * Set of keys cached on this node. You can remove elements from this set, but you cannot add elements + * to this set. All removal operation will be reflected on the cache itself. + * <p> + * Iterator over this set will not fail if set was concurrently updated + * by another thread. This means that iterator may or may not return latest + * keys depending on whether they were added before or after current + * iterator position. + * <p> + * NOTE: this operation is not distributed and returns only the keys cached on this node. + * + * @param filter Optional filter to check prior to getting key form cache. Note + * that filter is checked atomically together with get operation. + * @return Key set for this cache projection. + */ + public Set<K> keySet(@Nullable IgnitePredicate<Cache.Entry<K, V>>... filter); + + /** + * Set of keys for which this node is primary. + * This set is dynamic and may change with grid topology changes. + * Note that this set will contain mappings for all keys, even if their values are + * {@code null} because they were invalidated. You can remove elements from + * this set, but you cannot add elements to this set. All removal operation will be + * reflected on the cache itself. + * <p> + * Iterator over this set will not fail if set was concurrently updated + * by another thread. This means that iterator may or may not return latest + * keys depending on whether they were added before or after current + * iterator position. + * <p> + * NOTE: this operation is not distributed and returns only the keys cached on this node. + * + * @return Primary key set for the current node. + */ + public Set<K> primaryKeySet(); + + /** + * Collection of values cached on this node. You can remove + * elements from this collection, but you cannot add elements to this collection. + * All removal operation will be reflected on the cache itself. + * <p> + * Iterator over this collection will not fail if collection was + * concurrently updated by another thread. This means that iterator may or + * may not return latest values depending on whether they were added before + * or after current iterator position. + * <p> + * NOTE: this operation is not distributed and returns only the values cached on this node. + * + * @return Collection of cached values. + */ + public Collection<V> values(); + + /** + * Collection of cached values for which this node is primary. + * This collection is dynamic and may change with grid topology changes. + * Note that this collection will not contain values that are {@code null} + * because they were invalided. You can remove elements from this collection, + * but you cannot add elements to this collection. All removal operation will be + * reflected on the cache itself. + * <p> + * Iterator over this collection will not fail if collection was + * concurrently updated by another thread. This means that iterator may or + * may not return latest values depending on whether they were added before + * or after current iterator position. + * <p> + * NOTE: this operation is not distributed and returns only the values cached on this node. + * + * @return Collection of primary cached values for the current node. + */ + public Collection<V> primaryValues(); + + /** + * Gets set of all entries cached on this node. You can remove + * elements from this set, but you cannot add elements to this set. + * All removal operation will be reflected on the cache itself. + * <p> + * NOTE: this operation is not distributed and returns only the entries cached on this node. + * + * @return Entries that pass through key filter. + */ + public Set<Cache.Entry<K, V>> entrySet(); + + /** + * Gets set containing cache entries that belong to provided partition or {@code null} + * if partition is not found locally. + * <p> + * NOTE: this operation is not distributed and returns only the entries cached on this node. + * + * @param part Partition. + * @return Set containing partition's entries or {@code null} if partition is + * not found locally. + */ + @Nullable public Set<Cache.Entry<K, V>> entrySet(int part); + + /** + * Gets set of cache entries for which this node is primary. + * This set is dynamic and may change with grid topology changes. You can remove + * elements from this set, but you cannot add elements to this set. + * All removal operation will be reflected on the cache itself. + * <p> + * NOTE: this operation is not distributed and returns only the entries cached on this node. + * + * @return Primary cache entries that pass through key filter. + */ + public Set<Cache.Entry<K, V>> primaryEntrySet(); + + /** + * Starts transaction with default isolation, concurrency, timeout, and invalidation policy. + * All defaults are set in {@link org.apache.ignite.configuration.CacheConfiguration} at startup. + * + * @return New transaction + * @throws IllegalStateException If transaction is already started by this thread. + * @throws UnsupportedOperationException If cache is {@link CacheAtomicityMode#ATOMIC}. + */ + public Transaction txStart() throws IllegalStateException; + + /** + * Starts new transaction with the specified concurrency and isolation. + * + * @param concurrency Concurrency. + * @param isolation Isolation. + * @return New transaction. + * @throws IllegalStateException If transaction is already started by this thread. + * @throws UnsupportedOperationException If cache is {@link CacheAtomicityMode#ATOMIC}. + */ + public Transaction txStart(TransactionConcurrency concurrency, TransactionIsolation isolation); + + /** + * @param concurrency Concurrency. + * @param isolation Isolation. + * @return New transaction. + */ + public IgniteInternalTx txStartEx(TransactionConcurrency concurrency, TransactionIsolation isolation); + + /** + * Starts transaction with specified isolation, concurrency, timeout, invalidation flag, + * and number of participating entries. + * + * @param concurrency Concurrency. + * @param isolation Isolation. + * @param timeout Timeout. + * @param txSize Number of entries participating in transaction (may be approximate). + * @return New transaction. + * @throws IllegalStateException If transaction is already started by this thread. + * @throws UnsupportedOperationException If cache is {@link CacheAtomicityMode#ATOMIC}. + */ + public Transaction txStart(TransactionConcurrency concurrency, TransactionIsolation isolation, long timeout, + int txSize); + + /** + * Gets transaction started by this thread or {@code null} if this thread does + * not have a transaction. + * + * @return Transaction started by this thread or {@code null} if this thread + * does not have a transaction. + */ + @Nullable public Transaction tx(); + + /** + * Gets entry from cache with the specified key. The returned entry can + * be used even after entry key has been removed from cache. In that + * case, every operation on returned entry will result in creation of a + * new entry. + * <p> + * Note that this method can return {@code null} if projection is configured as + * pre-filtered and entry key and value don't pass key-value filter of the projection. + * + * @param key Entry key. + * @return Cache entry or {@code null} if projection pre-filtering was not passed. + */ + @Nullable public Cache.Entry<K, V> entry(K key); + + /** + * Evicts entry associated with given key from cache. Note, that entry will be evicted + * only if it's not used (not participating in any locks or transactions). + * <p> + * If {@link org.apache.ignite.configuration.CacheConfiguration#isSwapEnabled()} is set to {@code true} and + * {@link CacheFlag#SKIP_SWAP} is not enabled, the evicted entry will + * be swapped to offheap, and then to disk. + * <h2 class="header">Cache Flags</h2> + * This method is not available if any of the following flags are set on projection: + * {@link CacheFlag#READ}. + * + * @param key Key to evict from cache. + * @return {@code True} if entry could be evicted, {@code false} otherwise. + */ + public boolean evict(K key); + + /** + * Attempts to evict all cache entries. Note, that entry will be + * evicted only if it's not used (not participating in any locks or + * transactions). + * <p> + * If {@link org.apache.ignite.configuration.CacheConfiguration#isSwapEnabled()} is set to {@code true} and + * {@link CacheFlag#SKIP_SWAP} is not enabled, the evicted entry will + * be swapped to offheap, and then to disk. + * <h2 class="header">Cache Flags</h2> + * This method is not available if any of the following flags are set on projection: + * {@link CacheFlag#READ}. + */ + public void evictAll(); + + /** + * Attempts to evict all entries associated with keys. Note, + * that entry will be evicted only if it's not used (not + * participating in any locks or transactions). + * <p> + * If {@link org.apache.ignite.configuration.CacheConfiguration#isSwapEnabled()} is set to {@code true} and + * {@link CacheFlag#SKIP_SWAP} is not enabled, the evicted entry will + * be swapped to offheap, and then to disk. + * <h2 class="header">Cache Flags</h2> + * This method is not available if any of the following flags are set on projection: + * {@link CacheFlag#READ}. + * + * @param keys Keys to evict. + */ + public void evictAll(@Nullable Collection<? extends K> keys); + + /** + * Clears all entries from this cache only if the entry is not + * currently locked or participating in a transaction. + * <p> + * If {@link org.apache.ignite.configuration.CacheConfiguration#isSwapEnabled()} is set to {@code true} and + * {@link CacheFlag#SKIP_SWAP} is not enabled, the evicted entries will + * also be cleared from swap. + * <p> + * Note that this operation is local as it merely clears + * entries from local cache. It does not remove entries from + * remote caches or from underlying persistent storage. + * <h2 class="header">Cache Flags</h2> + * This method is not available if any of the following flags are set on projection: + * {@link CacheFlag#READ}. + */ + public void clearLocally(); + + /** + * Clears an entry from this cache and swap storage only if the entry + * is not currently locked, and is not participating in a transaction. + * <p> + * If {@link org.apache.ignite.configuration.CacheConfiguration#isSwapEnabled()} is set to {@code true} and + * {@link CacheFlag#SKIP_SWAP} is not enabled, the evicted entries will + * also be cleared from swap. + * <p> + * Note that this operation is local as it merely clears + * an entry from local cache. It does not remove entries from + * remote caches or from underlying persistent storage. + * <h2 class="header">Cache Flags</h2> + * This method is not available if any of the following flags are set on projection: + * {@link CacheFlag#READ}. + * + * @param key Key to clearLocally. + * @return {@code True} if entry was successfully cleared from cache, {@code false} + * if entry was in use at the time of this method invocation and could not be + * cleared. + */ + public boolean clearLocally(K key); + + /** + * Clears cache on all nodes that store it's data. That is, caches are cleared on remote + * nodes and local node, as opposed to {@link CacheProjection#clearLocally()} method which only + * clears local node's cache. + * <p> + * Ignite will make the best attempt to clear caches on all nodes. If some caches + * could not be cleared, then exception will be thrown. + * <p> + * This method is identical to calling {@link #clear(long) clear(0)}. + * + * @throws IgniteCheckedException In case of cache could not be cleared on any of the nodes. + * @deprecated Deprecated in favor of {@link #clear(long)} method. + */ + public void clear() throws IgniteCheckedException; + + /** + * @return Clear future. + */ + public IgniteInternalFuture<?> clearAsync(); + + /** + * Clears cache on all nodes that store it's data. That is, caches are cleared on remote + * nodes and local node, as opposed to {@link CacheProjection#clearLocally()} method which only + * clears local node's cache. + * <p> + * Ignite will make the best attempt to clearLocally caches on all nodes. If some caches + * could not be cleared, then exception will be thrown. + * + * @param timeout Timeout for clearLocally all task in milliseconds (0 for never). + * Set it to larger value for large caches. + * @throws IgniteCheckedException In case of cache could not be cleared on any of the nodes. + */ + public void clear(long timeout) throws IgniteCheckedException; + + /** + * Clears serialized value bytes from entry (if any) leaving only object representation. + * + * @param key Key to compact. + * @throws IgniteCheckedException If failed to compact. + * @return {@code true} if entry was deleted from cache (i.e. was expired). + */ + public boolean compact(K key) throws IgniteCheckedException; + + /** + * Clears serialized value bytes from cache entries (if any) leaving only object representation. + * @throws IgniteCheckedException If failed to compact. + */ + public void compactAll() throws IgniteCheckedException; + + /** + * Removes given key mapping from cache. If cache previously contained value for the given key, + * then this value is returned. In case of {@link CacheMode#PARTITIONED} or {@link CacheMode#REPLICATED} + * caches, the value will be loaded from the primary node, which in its turn may load the value + * from the disk-based swap storage, and consecutively, if it's not in swap, + * from the underlying persistent storage. If value has to be loaded from persistent + * storage, {@link CacheStore#load(Transaction, Object)} method will be used. + * <p> + * If the returned value is not needed, method {@link #removex(Object, org.apache.ignite.lang.IgnitePredicate[])} should + * always be used instead of this one to avoid the overhead associated with returning of the + * previous value. + * <p> + * If write-through is enabled, the value will be removed from {@link CacheStore} + * via {@link CacheStore#remove(Transaction, Object)} method. + * <h2 class="header">Transactions</h2> + * This method is transactional and will enlist the entry into ongoing transaction + * if there is one. + * <h2 class="header">Cache Flags</h2> + * This method is not available if any of the following flags are set on projection: + * {@link CacheFlag#LOCAL}, {@link CacheFlag#READ}. + * + * @param key Key whose mapping is to be removed from cache. + * @param filter Optional filter to check prior to removing value form cache. Note + * that filter is checked atomically together with remove operation. + * @return Previous value associated with specified key, or {@code null} + * if there was no value for this key. + * @throws NullPointerException If key is {@code null}. + * @throws IgniteCheckedException If remove operation failed. + * @throws CacheFlagException If projection flags validation failed. + */ + @Nullable public V remove(K key, @Nullable IgnitePredicate<Cache.Entry<K, V>>... filter) + throws IgniteCheckedException; + + /** + * Asynchronously removes given key mapping from cache. If cache previously contained value for the given key, + * then this value is returned. In case of {@link CacheMode#PARTITIONED} or {@link CacheMode#REPLICATED} + * caches, the value will be loaded from the primary node, which in its turn may load the value + * from the swap storage, and consecutively, if it's not in swap, + * from the underlying persistent storage. If value has to be loaded from persistent + * storage, {@link CacheStore#load(Transaction, Object)} method will be used. + * <p> + * If the returned value is not needed, method {@link #removex(Object, org.apache.ignite.lang.IgnitePredicate[])} should + * always be used instead of this one to avoid the overhead associated with returning of the + * previous value. + * <p> + * If write-through is enabled, the value will be removed from {@link CacheStore} + * via {@link CacheStore#remove(Transaction, Object)} method. + * <h2 class="header">Transactions</h2> + * This method is transactional and will enlist the entry into ongoing transaction + * if there is one. + * <h2 class="header">Cache Flags</h2> + * This method is not available if any of the following flags are set on projection: + * {@link CacheFlag#LOCAL}, {@link CacheFlag#READ}. + * + * @param key Key whose mapping is to be removed from cache. + * @param filter Optional filter to check prior to removing value form cache. Note + * that filter is checked atomically together with remove operation. + * @return Future for the remove operation. + * @throws NullPointerException if the key is {@code null}. + * @throws CacheFlagException If projection flags validation failed. + */ + public IgniteInternalFuture<V> removeAsync(K key, IgnitePredicate<Cache.Entry<K, V>>... filter); + + /** + * Removes given key mapping from cache. + * <p> + * This method will return {@code true} if remove did occur, which means that all optionally + * provided filters have passed and there was something to remove, {@code false} otherwise. + * <p> + * If write-through is enabled, the value will be removed from {@link CacheStore} + * via {@link CacheStore#remove(Transaction, Object)} method. + * <h2 class="header">Transactions</h2> + * This method is transactional and will enlist the entry into ongoing transaction + * if there is one. + * <h2 class="header">Cache Flags</h2> + * This method is not available if any of the following flags are set on projection: + * {@link CacheFlag#LOCAL}, {@link CacheFlag#READ}. + * + * @param key Key whose mapping is to be removed from cache. + * @param filter Optional filter to check prior to removing value form cache. Note + * that filter is checked atomically together with remove operation. + * @return {@code True} if filter passed validation and entry was removed, {@code false} otherwise. + * Note that if filter is not specified, this method will return {@code true}. + * @throws NullPointerException if the key is {@code null}. + * @throws IgniteCheckedException If remove failed. + * @throws CacheFlagException If projection flags validation failed. + */ + public boolean removex(K key, @Nullable IgnitePredicate<Cache.Entry<K, V>>... filter) + throws IgniteCheckedException; + + /** + * Asynchronously removes given key mapping from cache. + * <p> + * This method will return {@code true} if remove did occur, which means that all optionally + * provided filters have passed and there was something to remove, {@code false} otherwise. + * <p> + * If write-through is enabled, the value will be removed from {@link CacheStore} + * via {@link CacheStore#remove(Transaction, Object)} method. + * <h2 class="header">Transactions</h2> + * This method is transactional and will enlist the entry into ongoing transaction + * if there is one. + * <h2 class="header">Cache Flags</h2> + * This method is not available if any of the following flags are set on projection: + * {@link CacheFlag#LOCAL}, {@link CacheFlag#READ}. + * + * @param key Key whose mapping is to be removed from cache. + * @param filter Optional filter to check prior to removing value form cache. Note + * that filter is checked atomically together with remove operation. + * @return Future for the remove operation. The future will return {@code true} + * if optional filters passed validation and remove did occur, {@code false} otherwise. + * Note that if filter is not specified, this method will return {@code true}. + * @throws NullPointerException if the key is {@code null}. + * @throws CacheFlagException If projection flags validation failed. + */ + public IgniteInternalFuture<Boolean> removexAsync(K key, + @Nullable IgnitePredicate<Cache.Entry<K, V>>... filter); + + /** + * Removes given key mapping from cache if one exists and value is equal to the passed in value. + * <p> + * If write-through is enabled, the value will be removed from {@link CacheStore} + * via {@link CacheStore#remove(Transaction, Object)} method. + * <h2 class="header">Transactions</h2> + * This method is transactional and will enlist the entry into ongoing transaction + * if there is one. + * <h2 class="header">Cache Flags</h2> + * This method is not available if any of the following flags are set on projection: + * {@link CacheFlag#LOCAL}, {@link CacheFlag#READ}. + * + * @param key Key whose mapping is to be removed from cache. + * @param val Value to match against currently cached value. + * @return {@code True} if entry was removed and passed in value matched the cached one, + * {@code false} otherwise. + * @throws NullPointerException if the key or value is {@code null}. + * @throws IgniteCheckedException If remove failed. + * @throws CacheFlagException If projection flags validation failed. + */ + public boolean remove(K key, V val) throws IgniteCheckedException; + + /** + * Asynchronously removes given key mapping from cache if one exists and value is equal to the passed in value. + * <p> + * This method will return {@code true} if remove did occur, which means that all optionally + * provided filters have passed and there was something to remove, {@code false} otherwise. + * <p> + * If write-through is enabled, the value will be removed from {@link CacheStore} + * via {@link CacheStore#remove(Transaction, Object)} method. + * <h2 class="header">Transactions</h2> + * This method is transactional and will enlist the entry into ongoing transaction + * if there is one. + * <h2 class="header">Cache Flags</h2> + * This method is not available if any of the following flags are set on projection: + * {@link CacheFlag#LOCAL}, {@link CacheFlag#READ}. + * + * @param key Key whose mapping is to be removed from cache. + * @param val Value to match against currently cached value. + * @return Future for the remove operation. The future will return {@code true} + * if currently cached value will match the passed in one. + * @throws NullPointerException if the key or value is {@code null}. + * @throws CacheFlagException If projection flags validation failed. + */ + public IgniteInternalFuture<Boolean> removeAsync(K key, V val); + + /** + * Removes given key mappings from cache for entries for which the optionally passed in filters do + * pass. + * <p> + * If write-through is enabled, the values will be removed from {@link CacheStore} + * via {@link CacheStore#removeAll(Transaction, Collection)} method. + * <h2 class="header">Transactions</h2> + * This method is transactional and will enlist the entry into ongoing transaction + * if there is one. + * <h2 class="header">Cache Flags</h2> + * This method is not available if any of the following flags are set on projection: + * {@link CacheFlag#LOCAL}, {@link CacheFlag#READ}. + * + * @param keys Keys whose mappings are to be removed from cache. + * @param filter Optional filter to check prior to removing value form cache. Note + * that filter is checked atomically together with remove operation. + * @throws IgniteCheckedException If remove failed. + * @throws CacheFlagException If flags validation failed. + */ + public void removeAll(@Nullable Collection<? extends K> keys, + @Nullable IgnitePredicate<Cache.Entry<K, V>>... filter) throws IgniteCheckedException; + + /** + * Asynchronously removes given key mappings from cache for entries for which the optionally + * passed in filters do pass. + * <p> + * If write-through is enabled, the values will be removed from {@link CacheStore} + * via {@link CacheStore#removeAll(Transaction, Collection)} method. + * <h2 class="header">Transactions</h2> + * This method is transactional and will enlist the entry into ongoing transaction + * if there is one. + * <h2 class="header">Cache Flags</h2> + * This method is not available if any of the following flags are set on projection: + * {@link CacheFlag#LOCAL}, {@link CacheFlag#READ}. + * + * @param keys Keys whose mappings are to be removed from cache. + * @param filter Optional filter to check prior to removing value form cache. Note + * that filter is checked atomically together with remove operation. + * @return Future for the remove operation. The future will complete whenever + * remove operation completes. + * @throws CacheFlagException If flags validation failed. + */ + public IgniteInternalFuture<?> removeAllAsync(@Nullable Collection<? extends K> keys, + @Nullable IgnitePredicate<Cache.Entry<K, V>>... filter); + + /** + * Removes mappings from cache for entries for which the optionally passed in filters do + * pass. If passed in filters are {@code null}, then all entries in cache will be enrolled + * into transaction. + * <p> + * <b>USE WITH CARE</b> - if your cache has many entries that pass through the filter or if filter + * is empty, then transaction will quickly become very heavy and slow. Also, locks + * are acquired in undefined order, so it may cause a deadlock when used with + * other concurrent transactional updates. + * <p> + * If write-through is enabled, the values will be removed from {@link CacheStore} + * via {@link CacheStore#removeAll(Transaction, Collection)} method. + * <h2 class="header">Transactions</h2> + * This method is transactional and will enlist the entry into ongoing transaction + * if there is one. + * <h2 class="header">Cache Flags</h2> + * This method is not available if any of the following flags are set on projection: + * {@link CacheFlag#LOCAL}, {@link CacheFlag#READ}. + * + * @throws IgniteCheckedException If remove failed. + * @throws CacheFlagException If flags validation failed. + */ + public void removeAll() throws IgniteCheckedException; + + /** + * @return Remove future. + */ + public IgniteInternalFuture<?> removeAllAsync(); + + /** + * Asynchronously removes mappings from cache for entries for which the optionally passed in filters do + * pass. If passed in filters are {@code null}, then all entries in cache will be enrolled + * into transaction. + * <p> + * <b>USE WITH CARE</b> - if your cache has many entries that pass through the filter or if filter + * is empty, then transaction will quickly become very heavy and slow. + * <p> + * If write-through is enabled, the values will be removed from {@link CacheStore} + * via {@link CacheStore#removeAll(Transaction, Collection)} method. + * <h2 class="header">Transactions</h2> + * This method is transactional and will enlist the entry into ongoing transaction + * if there is one. + * <h2 class="header">Cache Flags</h2> + * This method is not available if any of the following flags are set on projection: + * {@link CacheFlag#LOCAL}, {@link CacheFlag#READ}. + * + * @param filter Filter used to supply keys for remove operation (if {@code null}, + * then nothing will be removed). + * @return Future for the remove operation. The future will complete whenever + * remove operation completes. + * @throws CacheFlagException If flags validation failed. + */ + public IgniteInternalFuture<?> removeAllAsync(@Nullable IgnitePredicate<Cache.Entry<K, V>>... filter); + + /** + * Synchronously acquires lock on a cached object with given + * key only if the passed in filter (if any) passes. This method + * together with filter check will be executed as one atomic operation. + * <h2 class="header">Transactions</h2> + * Locks are not transactional and should not be used from within transactions. If you do + * need explicit locking within transaction, then you should use + * {@link TransactionConcurrency#PESSIMISTIC} concurrency control for transaction + * which will acquire explicit locks for relevant cache operations. + * <h2 class="header">Cache Flags</h2> + * This method is not available if any of the following flags are set on projection: + * {@link CacheFlag#LOCAL}, {@link CacheFlag#READ}. + * + * @param key Key to lock. + * @param timeout Timeout in milliseconds to wait for lock to be acquired + * ({@code '0'} for no expiration), {@code -1} for immediate failure if + * lock cannot be acquired immediately). + * @param filter Optional filter to validate prior to acquiring the lock. + * @return {@code True} if all filters passed and lock was acquired, + * {@code false} otherwise. + * @throws IgniteCheckedException If lock acquisition resulted in error. + * @throws CacheFlagException If flags validation failed. + */ + public boolean lock(K key, long timeout, @Nullable IgnitePredicate<Cache.Entry<K, V>>... filter) + throws IgniteCheckedException; + + /** + * Asynchronously acquires lock on a cached object with given + * key only if the passed in filter (if any) passes. This method + * together with filter check will be executed as one atomic operation. + * <h2 class="header">Transactions</h2> + * Locks are not transactional and should not be used from within transactions. If you do + * need explicit locking within transaction, then you should use + * {@link TransactionConcurrency#PESSIMISTIC} concurrency control for transaction + * which will acquire explicit locks for
<TRUNCATED>
