Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Copyright (c) 2008-2015, 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.map.impl;
import com.hazelcast.core.EntryView;
import com.hazelcast.map.impl.mapstore.MapDataStore;
import com.hazelcast.map.impl.record.Record;
import com.hazelcast.map.merge.MapMergePolicy;
import com.hazelcast.nio.serialization.Data;
import com.hazelcast.spi.exception.RetryableHazelcastException;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;
/**
* Defines a record-store.
*/
public interface RecordStore {
String getName();
Object put(Data dataKey, Object dataValue, long ttl);
void put(Map.Entry entry);
Object putIfAbsent(Data dataKey, Object value, long ttl);
Record putBackup(Data key, Object value);
/**
* @param key the key to be processed.
* @param value the value to be processed.
* @param ttl milliseconds. Check out {@link com.hazelcast.map.impl.proxy.MapProxySupport#putInternal}
* @param putTransient {@code true} if putting transient entry, otherwise {@code false}
* @return previous record if exists otherwise null.
*/
Record putBackup(Data key, Object value, long ttl, boolean putTransient);
boolean tryPut(Data dataKey, Object value, long ttl);
boolean set(Data dataKey, Object value, long ttl);
Object remove(Data dataKey);
boolean delete(Data dataKey);
boolean remove(Data dataKey, Object testValue);
/**
* Similar to {@link RecordStore#remove(com.hazelcast.nio.serialization.Data)}
* except removeBackup doesn't touch mapstore since it does not return previous value.
*/
void removeBackup(Data dataKey);
/**
* Gets record from {@link com.hazelcast.map.impl.RecordStore}.
* Loads missing keys from map store.
*
* @param dataKey key.
* @param backup true if a backup partition, otherwise false.
* @return value of an entry in {@link com.hazelcast.map.impl.RecordStore}
*/
Object get(Data dataKey, boolean backup);
/**
* Called when {@link com.hazelcast.config.MapConfig#isReadBackupData} is true from
* {@link com.hazelcast.map.impl.proxy.MapProxySupport#getInternal}
*
* Returns corresponding value for key as {@link com.hazelcast.nio.serialization.Data}.
* This adds an extra serialization step. For the reason of this behaviour please see issue 1292 on github.
*
* @param key key to be accessed
* @return value as {@link com.hazelcast.nio.serialization.Data}
* independent of {@link com.hazelcast.config.InMemoryFormat}
*/
Data readBackupData(Data key);
MapEntrySet getAll(Set keySet);
boolean containsKey(Data dataKey);
Object replace(Data dataKey, Object update);
/**
* Sets the value to the given updated value
* if {@link com.hazelcast.map.impl.record.RecordFactory#isEquals} comparison
* of current value and expected value is {@code true}.
*
* @param dataKey key which's value is requested to be replaced.
* @param expect the expected value
* @param update the new value
* @return {@code true} if successful. False return indicates that
* the actual value was not equal to the expected value.
*/
boolean replace(Data dataKey, Object expect, Object update);
void putTransient(Data dataKey, Object value, long ttl);
/**
* Puts key-value pair to map which is the result of a load from map store operation.
*
* @param key key to put.
* @param value to put.
* @return the previous value associated with key, or
* null if there was no mapping for key.
* @see com.hazelcast.map.impl.operation.PutFromLoadAllOperation
*/
Object putFromLoad(Data key, Object value);
/**
* Puts key-value pair to map which is the result of a load from map store operation.
*
* @param key key to put.
* @param value to put.
* @param ttl time to live seconds.
* @return the previous value associated with key, or
* null if there was no mapping for key.
* @see com.hazelcast.map.impl.operation.PutAllOperation
*/
Object putFromLoad(Data key, Object value, long ttl);
boolean merge(Data dataKey, EntryView mergingEntryView, MapMergePolicy mergePolicy);
Record getRecord(Data key);
/**
* Puts a data key and a record value to record-store.
* Used in replication operations.
*
* @param key the data key to put record store.
* @param record the value for record store.
* @see com.hazelcast.map.impl.operation.MapReplicationOperation
*/
void putRecord(Data key, Record record);
/**
* Iterates over record store values.
*
* @return read only iterator for map values.
*/
Iterator iterator();
/**
* Iterates over record store values by respecting expiration.
*
* @return read only iterator for map values.
*/
Iterator iterator(long now, boolean backup);
/**
* Iterates over record store values but first waits map store to load.
* If an operation needs to wait a data source load like query operations
* {@link com.hazelcast.core.IMap#keySet(com.hazelcast.query.Predicate)},
* this method can be used to return a read-only iterator.
*
* @param now current time in millis
* @param backup true if a backup partition, otherwise false.
* @return read only iterator for map values.
*/
Iterator loadAwareIterator(long now, boolean backup);
/**
* Returns records map.
*
* @see RecordStoreLoader
*/
Map getRecordMap();
Set keySet();
int size();
boolean txnLock(Data key, String caller, long threadId, long ttl);
boolean extendLock(Data key, String caller, long threadId, long ttl);
boolean unlock(Data key, String caller, long threadId);
boolean isLocked(Data key);
boolean isTransactionallyLocked(Data key);
boolean canAcquireLock(Data key, String caller, long threadId);
String getLockOwnerInfo(Data key);
boolean containsValue(Object testValue);
Object evict(Data key, boolean backup);
/**
* Evicts all keys except locked ones.
*
* @param backup true if a backup partition, otherwise false.
* @return number of evicted entries.
*/
int evictAll(boolean backup);
Collection valuesData();
MapContainer getMapContainer();
Set> entrySetData();
Map.Entry getMapEntry(Data dataKey, long now);
void flush();
void clearPartition();
/**
* Resets the record store to it's initial state.
*/
void reset();
boolean forceUnlock(Data dataKey);
long getHeapCost();
boolean isLoaded();
void checkIfLoaded() throws RetryableHazelcastException;
int clear();
boolean isEmpty();
/**
* Do expiration operations.
*
* @param percentage of max expirables according to the record store size.
* @param backup true if a backup partition, otherwise false.
*/
void evictExpiredEntries(int percentage, boolean backup);
/**
* @return true if record store has at least one candidate entry
* for expiration else return false.
*/
boolean isExpirable();
/**
* Loads all given keys from defined map store.
*
* @param keys keys to be loaded.
* @param replaceExistingValues true if need to replace existing values otherwise false
* @param lastBatch when keys are sent is batches this indicates the last batch. Used to indicate loading is complete.
*/
void loadAllFromStore(List keys, boolean replaceExistingValues);
void updateLoadStatus(boolean lastBatch, Throwable exception);
MapDataStore getMapDataStore();
int getPartitionId();
/**
* Returns live record or null if record is already expired. Does not load missing keys from a map store.
*
* @param key key to be accessed
* @return live record or null
* @see #get
*/
Record getRecordOrNull(Data key);
void evictEntries(long now, boolean backup);
/**
* Loads all keys and values
*
* @param replaceExistingValues true if need to replace existing values otherwise false
**/
void loadAll(boolean replaceExistingValues);
/** Performs initial loading from a MapLoader if it has not been done before **/
void maybeDoInitialLoad();
}
