org.springframework.data.gemfire.GemfireOperations Maven / Gradle / Ivy
/*
* Copyright 2002-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
*/
package org.springframework.data.gemfire;
import java.util.Collection;
import java.util.Map;
import org.apache.geode.cache.Region;
import org.apache.geode.cache.query.Query;
import org.apache.geode.cache.query.QueryService;
import org.apache.geode.cache.query.SelectResults;
import org.springframework.dao.DataAccessException;
import org.springframework.dao.InvalidDataAccessApiUsageException;
/**
* @author David Turanski
* @author John Blum
*/
public interface GemfireOperations {
boolean containsKey(Object key);
boolean containsKeyOnServer(Object key);
boolean containsValue(Object value);
boolean containsValueForKey(Object key);
void create(K key, V value);
V get(K key);
Map getAll(Collection keys);
V put(K key, V value);
void putAll(Map map);
V putIfAbsent(K key, V value);
V remove(K key);
V replace(K key, V value);
boolean replace(K key, V oldValue, V newValue);
/**
* Executes a Pivotal GemFire query with the given (optional) parameters and returns the result. Note this method expects the query to return multiple results; for queries that return only one
* element use {@link #findUnique(String, Object...)}.
*
* As oppose, to the {@link #query(String)} method, this method allows for more generic queries (against multiple regions even) to be executed.
*
* Note that the local query service is used if the region is configured as a client without any pool configuration or server connectivity - otherwise the query service on the default pool
* is being used.
*
* @param type parameter specifying the type of the select results.
* @param query the OQL query statement to execute.
* @param params an array of Object values used as arguments to bind to the OQL query parameters (such as $1).
* @return A {@link SelectResults} instance holding the objects matching the query
* @throws InvalidDataAccessApiUsageException in case the query returns a single result (not a {@link SelectResults}).
* @see QueryService#newQuery(String)
* @see Query#execute(Object[])
* @see SelectResults
*/
SelectResults find(String query, Object... params) throws InvalidDataAccessApiUsageException;
/**
* Executes a Pivotal GemFire query with the given (optional) parameters and returns the result. Note this method expects the query to return a single result; for queries that return multiple
* elements use {@link #find(String, Object...)}.
*
* As oppose, to the {@link #query(String)} method, this method allows for more generic queries (against multiple regions even) to be executed.
*
* Note that the local query service is used if the region is configured as a client without any pool configuration or server connectivity - otherwise the query service on the default pool
* is being used.
*
* @param type parameter specifying the returned result type.
* @param query the OQL query statement to execute.
* @param params an array of Object values used as arguments to bind to the OQL query parameters (such as $1).
* @return The (single) object that represents the result of the query.
* @throws InvalidDataAccessApiUsageException in case the query returns multiple objects (through {@link SelectResults}).
* @see QueryService#newQuery(String)
* @see Query#execute(Object[])
*/
T findUnique(String query, Object... params) throws InvalidDataAccessApiUsageException;
/**
* Shortcut for {@link Region#query(String)} method. Filters the values of this region using the predicate given as a string with the syntax of the WHERE clause of the query language.
* The predefined variable this may be used inside the predicate to denote the current element being filtered.
* This method evaluates the passed in where clause and returns results. It is supported on servers as well as clients.
* When executed on a client, this method always runs on the server and returns results.
* When invoking this method from the client, applications can pass in a where clause or a complete query.
*
* @param type parameter specifying the type of the select results.
* @param query an OQL Query language boolean query predicate.
* @return A SelectResults containing the values of this Region that match the predicate.
* @see Region#query(String)
*/
SelectResults query(String query);
/**
* Execute the action specified by the given action object within a Region.
*
* @param type parameter specifying the returned result type.
* @param action callback object that specifies the Gemfire action to execute.
* @return a result object returned by the action, or null.
* @throws org.springframework.dao.DataAccessException in case of Pivotal GemFire errors.
*/
T execute(GemfireCallback action) throws DataAccessException;
/**
* Execute the action specified by the given action object within a Region.
*
* @param type parameter specifying the returned result type.
* @param action callback object that specifies the Gemfire action to execute.
* @param exposeNativeRegion whether to expose the native Pivotal GemFire region to callback code.
* @return a result object returned by the action, or null.
* @throws org.springframework.dao.DataAccessException in case of Pivotal GemFire errors.
*/
T execute(GemfireCallback action, boolean exposeNativeRegion) throws DataAccessException;
}