com.hazelcast.core.MapStore Maven / Gradle / Ivy
/*
* Copyright (c) 2008-2013, Hazelcast, Inc. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.hazelcast.core;
import java.util.Collection;
import java.util.Map;
/**
* Hazelcast distributed map implementation is an in-memory data store but
* it can be backed by any type of data store such as RDBMS, OODBMS, NOSQL or simply
* a file based data store.
*
* IMap.put(key, value) normally stores the entry into JVM's memory. If MapStore
* implementation is provided then Hazelcast will also call the MapStore
* implementation to store the entry into a user defined storage such as
* RDBMS or some other external storage system. It is completely up to the user
* how the key-value will be stored or deleted.
*
* Same goes for IMap.remove(key)
*
* Store implementation can be called synchronously (write-through)
* or asynchronously (write-behind) depending on the configuration.
*
* Note that in write-behind mode, there is a possibility that a map-store
* implementation can be used by multiple threads at the same time, calling methods like
* {@link IMap#flush()} or {@link IMap#evict(Object)} may trigger this behavior.
*/
public interface MapStore extends MapLoader {
/**
* Stores the key-value pair.
* If an exception is thrown then the put operation will fail.
*
* @param key key of the entry to store
* @param value value of the entry to store
*/
void store(K key, V value);
/**
* Stores multiple entries. Implementation of this method can optimize the
* store operation by storing all entries in one database connection for instance.
* storeAll used when writeDelaySeconds is positive (write-behind).
* If an exception is thrown the entries will be tried to be stored one by one using store() method.
*
* @param map map of entries to store
*/
void storeAll(Map map);
/**
* Deletes the entry with a given key from the store.
* If an exception is thrown the remove operation will fail.
*
* @param key key to delete from the store.
*/
void delete(K key);
/**
* Deletes multiple entries from the store.
* If an exception is thrown the entries will be tried to be deleted one by one using delete() method.
*
* @param keys keys of the entries to delete.
*/
void deleteAll(Collection keys);
}