com.hazelcast.internal.nearcache

Interface NearCache<K,V>

Type Parameters:

K - the type of the key

V - the type of the value

All Superinterfaces:

InitializingObject

All Known Implementing Classes:

DefaultNearCache

public interface NearCache<K,V>
extends InitializingObject

NearCache is the contract point to store keys and values in underlying NearCacheRecordStore.

Field Summary

Fields

Modifier and Type	Field and Description
static Object	CACHED_AS_NULL NULL Object
static int	DEFAULT_EXPIRATION_TASK_INITIAL_DELAY_SECONDS Default expiration task initial delay time as seconds
static int	DEFAULT_EXPIRATION_TASK_PERIOD_SECONDS Default expiration task delay time as seconds
static Object	NOT_CACHED NOT_CACHED Object
static String	PROP_EXPIRATION_TASK_INITIAL_DELAY_SECONDS
static String	PROP_EXPIRATION_TASK_PERIOD_SECONDS
static HazelcastProperty	TASK_INITIAL_DELAY_SECONDS
static HazelcastProperty	TASK_PERIOD_SECONDS

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all stored values.
void	destroy() Clears the record store and destroys it.
V	get(K key) Gets the value associated with the given key.
InMemoryFormat	getInMemoryFormat() Gets the InMemoryFormat of the storage for internal records.
String	getName() Gets the name of this NearCache instance.
NearCacheStats	getNearCacheStats() Get the NearCacheStats instance to monitor this store.
NearCachePreloaderConfig	getPreloaderConfig() Gets the NearCachePreloaderConfig of this Near Cache.
void	invalidate(K key) Removes the value associated with the given key and increases the invalidation statistics.
boolean	isAvailable()
boolean	isPreloadDone() Checks if the pre-loading of the Near Cache is done.
boolean	isSerializeKeys() Checks if the Near Cache key is stored in serialized format or by-reference.
void	preload(DataStructureAdapter<Object,?> adapter) Executes the Near Cache pre-loader on the given DataStructureAdapter.
void	put(K key, Data keyData, V value) Puts (associates) a value with the given key.
Object	selectToSave(Object... candidates) Selects the best candidate object to store from the given candidates.
int	size() Gets the count of stored records.
void	storeKeys() Stores the keys of the Near Cache.
V	tryPublishReserved(K key, V value, long reservationId, boolean deserialize) Tries to update reserved key with supplied value.
long	tryReserveForUpdate(K key, Data keyData) Tries to reserve supplied key for update.
<T> T	unwrap(Class<T> clazz) Used to access non-standard methods of an implementation.

Methods inherited from interface com.hazelcast.spi.InitializingObject

initialize

Field Detail

DEFAULT_EXPIRATION_TASK_INITIAL_DELAY_SECONDS

static final int DEFAULT_EXPIRATION_TASK_INITIAL_DELAY_SECONDS

Default expiration task initial delay time as seconds

See Also:

Constant Field Values

DEFAULT_EXPIRATION_TASK_PERIOD_SECONDS

static final int DEFAULT_EXPIRATION_TASK_PERIOD_SECONDS

Default expiration task delay time as seconds

See Also:

Constant Field Values

PROP_EXPIRATION_TASK_INITIAL_DELAY_SECONDS

static final String PROP_EXPIRATION_TASK_INITIAL_DELAY_SECONDS

See Also:

Constant Field Values

PROP_EXPIRATION_TASK_PERIOD_SECONDS

static final String PROP_EXPIRATION_TASK_PERIOD_SECONDS

See Also:

Constant Field Values

TASK_INITIAL_DELAY_SECONDS

static final HazelcastProperty TASK_INITIAL_DELAY_SECONDS

TASK_PERIOD_SECONDS

static final HazelcastProperty TASK_PERIOD_SECONDS

CACHED_AS_NULL

static final Object CACHED_AS_NULL

NULL Object

NOT_CACHED

static final Object NOT_CACHED

NOT_CACHED Object

Method Detail

getName

String getName()

Gets the name of this NearCache instance.

Returns:

the name of this NearCache instance

get

V get(K key)

Gets the value associated with the given key.

Parameters:

key - the key of the requested value

Returns:

the value associated with the given key

put

void put(K key,
         Data keyData,
         V value)

Puts (associates) a value with the given key.

Parameters:

key - the key of the value will be stored

keyData - the key as Data of the value will be stored

value - the value will be stored

invalidate

void invalidate(K key)

Removes the value associated with the given key and increases the invalidation statistics.

Parameters:

key - the key of the value will be invalidated

clear

void clear()

Removes all stored values.

destroy

void destroy()

Clears the record store and destroys it.

size

int size()

Gets the count of stored records.

Returns:

the count of stored records

isAvailable

boolean isAvailable()

getInMemoryFormat

InMemoryFormat getInMemoryFormat()

Gets the InMemoryFormat of the storage for internal records.

Returns:

the InMemoryFormat of the storage for internal records

getPreloaderConfig

NearCachePreloaderConfig getPreloaderConfig()

Gets the NearCachePreloaderConfig of this Near Cache.

Returns:

the NearCachePreloaderConfig of this Near Cache

getNearCacheStats

NearCacheStats getNearCacheStats()

Get the NearCacheStats instance to monitor this store.

Returns:

the NearCacheStats instance to monitor this store

isSerializeKeys

boolean isSerializeKeys()

Checks if the Near Cache key is stored in serialized format or by-reference.

Returns:

true if the key is stored in serialized format, false if stored by-reference.

selectToSave

Object selectToSave(Object... candidates)

Selects the best candidate object to store from the given candidates.

Parameters:

candidates - the candidates from which the best candidate object will be selected.

Returns:

the best candidate object to store, selected from the given candidates.

preload

void preload(DataStructureAdapter<Object,?> adapter)

Executes the Near Cache pre-loader on the given DataStructureAdapter.

storeKeys

void storeKeys()

Stores the keys of the Near Cache.

isPreloadDone

boolean isPreloadDone()

Checks if the pre-loading of the Near Cache is done.

Returns:

true if the pre-loading is done, false otherwise.

unwrap

<T> T unwrap(Class<T> clazz)

Used to access non-standard methods of an implementation.

If this method is called on a wrapper object, result is wrapped object.

Type Parameters:

T - the type of the class modeled by this Class object

Parameters:

clazz - the type of returning object.

Returns:

an instance of the supplied clazz type.

Throws:

IllegalArgumentException - if no implementation found for the supplied clazz type.

tryReserveForUpdate

long tryReserveForUpdate(K key,
                         Data keyData)

Tries to reserve supplied key for update.

If one thread takes reservation, only that thread can update the key.

Parameters:

key - key to be reserved for update

keyData - key to be reserved for update as Data

Returns:

reservation ID if reservation succeeds, else returns NearCacheRecord.NOT_RESERVED

tryPublishReserved

V tryPublishReserved(K key,
                     V value,
                     long reservationId,
                     boolean deserialize)

Tries to update reserved key with supplied value. If update happens, value is published. Publishing means making the value readable to all threads. If update fails, record is not updated.

Parameters:

key - reserved key for update

value - value to be associated with reserved key

reservationId - ID for this reservation

deserialize - eagerly deserialize returning value

Returns:

associated value if deserialize is true and update succeeds, otherwise returns null