Package org.infinispan.container.impl

Class InternalEntryFactoryImpl

java.lang.Object

org.infinispan.container.impl.InternalEntryFactoryImpl

All Implemented Interfaces:

InternalEntryFactory

public class InternalEntryFactoryImpl
extends Object
implements InternalEntryFactory

An implementation that generates non-versioned entries

Since:

5.1

Author:

Manik Surtani

Constructor Summary

Constructors

Constructor	Description
InternalEntryFactoryImpl()

Method Summary

Modifier and Type	Method	Description
CacheEntry	copy(CacheEntry cacheEntry)	Creates a copy of this cache entry and synchronizes serializes the copy process with the InternalEntryFactory.update(org.infinispan.container.entries.InternalCacheEntry, org.infinispan.metadata.Metadata).
InternalCacheEntry	create(Object key, Object value, InternalCacheEntry cacheEntry)	Creates a new InternalCacheEntry instance based on the version and timestamp/lifespan information reflected in the CacheEntry instance passed in.
InternalCacheEntry	create(Object key, Object value, EntryVersion version, long created, long lifespan, long lastUsed, long maxIdle)	Creates a new InternalCacheEntry instance
InternalCacheEntry	create(Object key, Object value, Metadata metadata)	Creates a new InternalCacheEntry instance
InternalCacheEntry	create(Object key, Object value, Metadata metadata, long lifespan, long maxIdle)	Creates a new InternalCacheEntry instance
InternalCacheEntry	create(Object key, Object value, Metadata metadata, long created, long lifespan, long lastUsed, long maxIdle)	Creates a new InternalCacheEntry instance
InternalCacheEntry	create(CacheEntry cacheEntry)	Creates a new InternalCacheEntry instance based on the key, value, version and timestamp/lifespan information reflected in the CacheEntry instance passed in.
<K,V> InternalCacheEntry	createL1(K key, V value, Metadata metadata)	Creates a L1 entry.
InternalCacheValue	createValue(CacheEntry cacheEntry)	Creates an InternalCacheValue based on the InternalCacheEntry passed in.
<K,V> InternalCacheValue<V>	getValueFromCtx(K key, InvocationContext ctx)	Retrieve an InternalCacheValue from the provided InvocationContext if an InternalCacheEntry exists, otherwise create InternalCacheEntry from the context's CacheEntry and return its value.
static boolean	isStoreMetadata(Metadata metadata, InternalCacheEntry ice)	Indicates whether the entire metadata object needs to be stored or not.
InternalCacheEntry	update(InternalCacheEntry cacheEntry, Object value, Metadata metadata)	Similar to InternalEntryFactory.update(org.infinispan.container.entries.InternalCacheEntry, org.infinispan.metadata.Metadata) but it also updates the InternalCacheEntry value.
InternalCacheEntry	update(InternalCacheEntry ice, Metadata metadata)	TODO: Adjust javadoc Updates an existing InternalCacheEntry with new metadata.

Methods inherited from class java.lang.Object

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

Constructor Detail

InternalEntryFactoryImpl

public InternalEntryFactoryImpl()

Method Detail

create

public InternalCacheEntry create(Object key,
                                 Object value,
                                 Metadata metadata)

Description copied from interface: InternalEntryFactory

Creates a new InternalCacheEntry instance

Specified by:

create in interface InternalEntryFactory

Parameters:

key - key to use

value - value to use

metadata - metadata for entry

Returns:

a new InternalCacheEntry

create

public InternalCacheEntry create(CacheEntry cacheEntry)

Description copied from interface: InternalEntryFactory

Creates a new InternalCacheEntry instance based on the key, value, version and timestamp/lifespan information reflected in the CacheEntry instance passed in.

Specified by:

create in interface InternalEntryFactory

Parameters:

cacheEntry - cache entry to copy

Returns:

a new InternalCacheEntry

create

public InternalCacheEntry create(Object key,
                                 Object value,
                                 InternalCacheEntry cacheEntry)

Description copied from interface: InternalEntryFactory

Creates a new InternalCacheEntry instance based on the version and timestamp/lifespan information reflected in the CacheEntry instance passed in. Key and value are both passed in explicitly.

Specified by:

create in interface InternalEntryFactory

Parameters:

key - key to use

value - value to use

cacheEntry - cache entry to retrieve version and timestamp/lifespan information from

Returns:

a new InternalCacheEntry

create

public InternalCacheEntry create(Object key,
                                 Object value,
                                 EntryVersion version,
                                 long created,
                                 long lifespan,
                                 long lastUsed,
                                 long maxIdle)

Description copied from interface: InternalEntryFactory

Creates a new InternalCacheEntry instance

Specified by:

create in interface InternalEntryFactory

Parameters:

key - key to use

value - value to use

version - version to use

created - creation timestamp to use

lifespan - lifespan to use

lastUsed - lastUsed timestamp to use

maxIdle - maxIdle to use

Returns:

a new InternalCacheEntry

create

public InternalCacheEntry create(Object key,
                                 Object value,
                                 Metadata metadata,
                                 long created,
                                 long lifespan,
                                 long lastUsed,
                                 long maxIdle)

Description copied from interface: InternalEntryFactory

Creates a new InternalCacheEntry instance

Specified by:

create in interface InternalEntryFactory

Parameters:

key - key to use

value - value to use

metadata - metadata for entry

created - creation timestamp to use

lifespan - lifespan to use

lastUsed - lastUsed timestamp to use

maxIdle - maxIdle to use

Returns:

a new InternalCacheEntry

createValue

public InternalCacheValue createValue(CacheEntry cacheEntry)

Description copied from interface: InternalEntryFactory

Creates an InternalCacheValue based on the InternalCacheEntry passed in.

Specified by:

createValue in interface InternalEntryFactory

Parameters:

cacheEntry - to use to generate a InternalCacheValue

Returns:

an InternalCacheValue

create

public InternalCacheEntry create(Object key,
                                 Object value,
                                 Metadata metadata,
                                 long lifespan,
                                 long maxIdle)

Description copied from interface: InternalEntryFactory

Creates a new InternalCacheEntry instance

Specified by:

create in interface InternalEntryFactory

Parameters:

key - key to use

value - value to use

metadata - metadata for entry

lifespan - lifespan to use

maxIdle - maxIdle to use

Returns:

a new InternalCacheEntry

update

public InternalCacheEntry update(InternalCacheEntry ice,
                                 Metadata metadata)

Description copied from interface: InternalEntryFactory

TODO: Adjust javadoc Updates an existing InternalCacheEntry with new metadata. This may result in a new InternalCacheEntry instance being created, as a different InternalCacheEntry implementation may be more appropriate to suit the new metadata values. As such, one should consider the InternalCacheEntry passed in as a parameter as passed by value and not by reference.

Specified by:

update in interface InternalEntryFactory

Parameters:

ice - original internal cache entry

metadata - new metadata

Returns:

a new InternalCacheEntry instance

update

public InternalCacheEntry update(InternalCacheEntry cacheEntry,
                                 Object value,
                                 Metadata metadata)

Description copied from interface: InternalEntryFactory

Similar to InternalEntryFactory.update(org.infinispan.container.entries.InternalCacheEntry, org.infinispan.metadata.Metadata) but it also updates the InternalCacheEntry value.

If the same internal cache entry is returned and if it is a mortal cache entry, the returned instance needs to be reincarnated.

Specified by:

update in interface InternalEntryFactory

Parameters:

cacheEntry - original internal cache entry

value - new value

metadata - new metadata

Returns:

a new InternalCacheEntry instance or the existing original

copy

public CacheEntry copy(CacheEntry cacheEntry)

Description copied from interface: InternalEntryFactory

Creates a copy of this cache entry and synchronizes serializes the copy process with the InternalEntryFactory.update(org.infinispan.container.entries.InternalCacheEntry, org.infinispan.metadata.Metadata). This is requires so that readers of the entry will get an consistent snapshot of the value red.

Specified by:

copy in interface InternalEntryFactory

createL1

public <K,V> InternalCacheEntry createL1(K key,
                                               V value,
                                               Metadata metadata)

Description copied from interface: InternalEntryFactory

Creates a L1 entry.

Specified by:

createL1 in interface InternalEntryFactory

Type Parameters:

K - The key type for the entry

V - The value type for the entry

Returns:

a new InternalCacheEntry

getValueFromCtx

public <K,V> InternalCacheValue<V> getValueFromCtx(K key,
                                                         InvocationContext ctx)

Description copied from interface: InternalEntryFactory

Retrieve an InternalCacheValue from the provided InvocationContext if an InternalCacheEntry exists, otherwise create InternalCacheEntry from the context's CacheEntry and return its value.

If the entry is not in the context a null value is returned

Specified by:

getValueFromCtx in interface InternalEntryFactory

Type Parameters:

K - The key type for the entry

V - The value type for the entry

Parameters:

key - the key of the entry to be retrieved

ctx - the invocation context from which the value should be retrieved

Returns:

an InternalCacheValue

isStoreMetadata

public static boolean isStoreMetadata(Metadata metadata,
                                      InternalCacheEntry ice)

Indicates whether the entire metadata object needs to be stored or not. This check is done to avoid keeping the entire metadata object around when only lifespan or maxIdle time is stored. If more information needs to be stored (i.e. version), or the metadata object is not the embedded one, keep the entire metadata object around.

Returns:

true if the entire metadata object needs to be stored, otherwise simply store lifespan and/or maxIdle in existing cache entries