com.hazelcast.internal.nearcache.impl

Class DefaultNearCache<K,V>

java.lang.Object

com.hazelcast.internal.nearcache.impl.DefaultNearCache<K,V>

All Implemented Interfaces:

NearCache<K,V>, InitializingObject

public class DefaultNearCache<K,V>
extends Object
implements NearCache<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
protected ClassLoader	classLoader
protected ScheduledFuture	expirationTaskFuture
protected String	name
protected NearCacheConfig	nearCacheConfig
protected NearCacheRecordStore<K,V>	nearCacheRecordStore
protected TaskScheduler	scheduler
protected SerializationService	serializationService

Fields inherited from interface com.hazelcast.internal.nearcache.NearCache

CACHED_AS_NULL, DEFAULT_EXPIRATION_TASK_DELAY_IN_SECONDS, DEFAULT_EXPIRATION_TASK_INITIAL_DELAY_IN_SECONDS, NOT_CACHED

Constructor Summary

Constructors

Constructor and Description
DefaultNearCache(String name, NearCacheConfig nearCacheConfig, NearCacheRecordStore<K,V> nearCacheRecordStore, SerializationService serializationService, TaskScheduler scheduler, ClassLoader classLoader)
DefaultNearCache(String name, NearCacheConfig nearCacheConfig, SerializationService serializationService, TaskScheduler scheduler, ClassLoader classLoader)

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all stored values.
protected NearCacheRecordStore<K,V>	createNearCacheRecordStore(String name, NearCacheConfig nearCacheConfig)
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.
NearCacheRecordStore<K,V>	getNearCacheRecordStore()
NearCacheStats	getNearCacheStats() Get the NearCacheStats instance to monitor this store.
NearCachePreloaderConfig	getPreloaderConfig() Gets the NearCachePreloaderConfig of this Near Cache.
void	initialize()
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.
boolean	remove(K key) Removes the value associated 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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

name

protected final String name

nearCacheConfig

protected final NearCacheConfig nearCacheConfig

serializationService

protected final SerializationService serializationService

scheduler

protected final TaskScheduler scheduler

classLoader

protected final ClassLoader classLoader

nearCacheRecordStore

protected NearCacheRecordStore<K,V> nearCacheRecordStore

expirationTaskFuture

protected ScheduledFuture expirationTaskFuture

Constructor Detail

DefaultNearCache

public DefaultNearCache(String name,
                        NearCacheConfig nearCacheConfig,
                        SerializationService serializationService,
                        TaskScheduler scheduler,
                        ClassLoader classLoader)

DefaultNearCache

public DefaultNearCache(String name,
                        NearCacheConfig nearCacheConfig,
                        NearCacheRecordStore<K,V> nearCacheRecordStore,
                        SerializationService serializationService,
                        TaskScheduler scheduler,
                        ClassLoader classLoader)

Method Detail

initialize

public void initialize()

Specified by:

initialize in interface InitializingObject

createNearCacheRecordStore

protected NearCacheRecordStore<K,V> createNearCacheRecordStore(String name,
                                                               NearCacheConfig nearCacheConfig)

getName

public String getName()

Description copied from interface: NearCache

Gets the name of this NearCache instance.

Specified by:

getName in interface NearCache<K,V>

Returns:

the name of this NearCache instance

get

public V get(K key)

Description copied from interface: NearCache

Gets the value associated with the given key.

Specified by:

get in interface NearCache<K,V>

Parameters:

key - the key of the requested value

Returns:

the value associated with the given key

put

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

Description copied from interface: NearCache

Puts (associates) a value with the given key.

Specified by:

put in interface NearCache<K,V>

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

remove

public boolean remove(K key)

Description copied from interface: NearCache

Removes the value associated with the given key.

Specified by:

remove in interface NearCache<K,V>

Parameters:

key - the key of the value will be removed

clear

public void clear()

Description copied from interface: NearCache

Removes all stored values.

Specified by:

clear in interface NearCache<K,V>

destroy

public void destroy()

Description copied from interface: NearCache

Clears the record store and destroys it.

Specified by:

destroy in interface NearCache<K,V>

getInMemoryFormat

public InMemoryFormat getInMemoryFormat()

Description copied from interface: NearCache

Gets the InMemoryFormat of the storage for internal records.

Specified by:

getInMemoryFormat in interface NearCache<K,V>

Returns:

the InMemoryFormat of the storage for internal records

getPreloaderConfig

public NearCachePreloaderConfig getPreloaderConfig()

Description copied from interface: NearCache

Gets the NearCachePreloaderConfig of this Near Cache.

Specified by:

getPreloaderConfig in interface NearCache<K,V>

Returns:

the NearCachePreloaderConfig of this Near Cache

getNearCacheStats

public NearCacheStats getNearCacheStats()

Description copied from interface: NearCache

Get the NearCacheStats instance to monitor this store.

Specified by:

getNearCacheStats in interface NearCache<K,V>

Returns:

the NearCacheStats instance to monitor this store

isSerializeKeys

public boolean isSerializeKeys()

Description copied from interface: NearCache

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

Specified by:

isSerializeKeys in interface NearCache<K,V>

Returns:

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

selectToSave

public Object selectToSave(Object... candidates)

Description copied from interface: NearCache

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

Specified by:

selectToSave in interface NearCache<K,V>

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.

size

public int size()

Description copied from interface: NearCache

Gets the count of stored records.

Specified by:

size in interface NearCache<K,V>

Returns:

the count of stored records

preload

public void preload(DataStructureAdapter<Object,?> adapter)

Description copied from interface: NearCache

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

Specified by:

preload in interface NearCache<K,V>

storeKeys

public void storeKeys()

Description copied from interface: NearCache

Stores the keys of the Near Cache.

Specified by:

storeKeys in interface NearCache<K,V>

isPreloadDone

public boolean isPreloadDone()

Description copied from interface: NearCache

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

Specified by:

isPreloadDone in interface NearCache<K,V>

Returns:

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

unwrap

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

Description copied from interface: NearCache

Used to access non-standard methods of an implementation.

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

Specified by:

unwrap in interface NearCache<K,V>

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.

tryReserveForUpdate

public long tryReserveForUpdate(K key,
                                Data keyData)

Description copied from interface: NearCache

Tries to reserve supplied key for update.

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

Specified by:

tryReserveForUpdate in interface NearCache<K,V>

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

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

Description copied from interface: NearCache

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.

Specified by:

tryPublishReserved in interface NearCache<K,V>

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

getNearCacheRecordStore

public NearCacheRecordStore<K,V> getNearCacheRecordStore()