Package org.infinispan.container.entries.metadata

Class MetadataTransientCacheEntry

java.lang.Object

org.infinispan.container.entries.AbstractInternalCacheEntry

org.infinispan.container.entries.metadata.MetadataTransientCacheEntry

All Implemented Interfaces:

Cloneable, Map.Entry, CacheEntry, InternalCacheEntry, MetadataAware

public class MetadataTransientCacheEntry
extends AbstractInternalCacheEntry
implements MetadataAware

A cache entry that is transient, i.e., it can be considered expired after a period of not being used, and MetadataAware

Since:

5.3

Author:

Galder Zamarreño

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MetadataTransientCacheEntry.Externalizer

Field Summary

Fields

Modifier and Type	Field	Description
protected long	lastUsed
protected Metadata	metadata

Fields inherited from class org.infinispan.container.entries.AbstractInternalCacheEntry

internalMetadata, key, value

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MetadataTransientCacheEntry(Object key, Object value, PrivateMetadata internalMetadata, Metadata metadata, long lastUsed)
	MetadataTransientCacheEntry(Object key, Object value, Metadata metadata, long lastUsed)

Method Summary

Modifier and Type	Method	Description
protected void	appendFieldsToString(StringBuilder builder)
boolean	canExpire()
boolean	canExpireMaxIdle()
long	getCreated()
long	getExpiryTime()	Only used with entries that have a lifespan, this determines when an entry is due to expire.
long	getLastUsed()
long	getLifespan()
long	getMaxIdle()
Metadata	getMetadata()	Get metadata of this cache entry.
boolean	isExpired(long now)
void	reincarnate(long now)	"Reincarnates" an entry.
void	setMetadata(Metadata metadata)	Set the metadata in the cache entry.
InternalCacheValue<?>	toInternalCacheValue()	Creates a representation of this entry as an InternalCacheValue.
void	touch(long currentTimeMillis)	Updates access timestamps on this instance to a specified time

Methods inherited from class org.infinispan.container.entries.AbstractInternalCacheEntry

clone, commit, equals, getInternalMetadata, getKey, getValue, hashCode, isChanged, isCreated, isEvicted, isL1Entry, isNull, isRemoved, setChanged, setCreated, setEvicted, setInternalMetadata, setRemoved, setSkipLookup, setValue, skipLookup, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.infinispan.container.entries.CacheEntry

setCreated, setLastUsed

Field Detail

metadata

protected Metadata metadata

lastUsed

protected long lastUsed

Constructor Detail

MetadataTransientCacheEntry

public MetadataTransientCacheEntry(Object key,
                                   Object value,
                                   Metadata metadata,
                                   long lastUsed)

MetadataTransientCacheEntry

protected MetadataTransientCacheEntry(Object key,
                                      Object value,
                                      PrivateMetadata internalMetadata,
                                      Metadata metadata,
                                      long lastUsed)

Method Detail

touch

public final void touch(long currentTimeMillis)

Description copied from interface: InternalCacheEntry

Updates access timestamps on this instance to a specified time

Specified by:

touch in interface InternalCacheEntry

Parameters:

currentTimeMillis - the current time as defined by System.currentTimeMillis() or TimeService.wallClockTime()

reincarnate

public void reincarnate(long now)

Description copied from interface: InternalCacheEntry

"Reincarnates" an entry. Essentially, resets the 'created' timestamp of the entry to the current time.

Specified by:

reincarnate in interface InternalCacheEntry

Parameters:

now - the current time as defined by System.currentTimeMillis() or TimeService.wallClockTime()

canExpire

public final boolean canExpire()

Specified by:

canExpire in interface InternalCacheEntry

Returns:

true if the entry can expire, false otherwise

canExpireMaxIdle

public boolean canExpireMaxIdle()

Specified by:

canExpireMaxIdle in interface InternalCacheEntry

Returns:

true if this entry can expire via max idle, false otherwise

isExpired

public boolean isExpired(long now)

Specified by:

isExpired in interface InternalCacheEntry

Parameters:

now - the current time as defined by System.currentTimeMillis() or TimeService.wallClockTime()

Returns:

true if the entry has expired; false otherwise

getCreated

public long getCreated()

Specified by:

getCreated in interface CacheEntry

Returns:

timestamp when the entry was created

getLastUsed

public final long getLastUsed()

Specified by:

getLastUsed in interface CacheEntry

Returns:

timestamp when the entry was last used

getLifespan

public long getLifespan()

Specified by:

getLifespan in interface CacheEntry

Returns:

retrieves the lifespan of this entry. -1 means an unlimited lifespan.

getExpiryTime

public long getExpiryTime()

Description copied from interface: InternalCacheEntry

Only used with entries that have a lifespan, this determines when an entry is due to expire.

Specified by:

getExpiryTime in interface InternalCacheEntry

Returns:

timestamp when the entry is due to expire, or -1 if it doesn't have a lifespan

getMaxIdle

public final long getMaxIdle()

Specified by:

getMaxIdle in interface CacheEntry

Returns:

the maximum allowed time for which this entry can be idle, after which it is considered expired.

toInternalCacheValue

public InternalCacheValue<?> toInternalCacheValue()

Description copied from interface: InternalCacheEntry

Creates a representation of this entry as an InternalCacheValue. The main purpose of this is to provide a representation that does not have a reference to the key. This is useful in situations where the key is already known or stored elsewhere, making serialization and deserialization more efficient.

Note that this should not be used to optimize memory overhead, since the saving of an additional reference to a key (a single object reference) does not warrant the cost of constructing an InternalCacheValue. This only makes sense when marshalling is involved, since the cost of marshalling the key again can be sidestepped using an InternalCacheValue if the key is already known/marshalled.

Specified by:

toInternalCacheValue in interface InternalCacheEntry

Returns:

a new InternalCacheValue encapsulating this InternalCacheEntry's value and expiration information.

getMetadata

public Metadata getMetadata()

Description copied from interface: MetadataAware

Get metadata of this cache entry.

Specified by:

getMetadata in interface MetadataAware

Overrides:

getMetadata in class AbstractInternalCacheEntry

Returns:

a Metadata instance

setMetadata

public void setMetadata(Metadata metadata)

Description copied from interface: MetadataAware

Set the metadata in the cache entry.

Specified by:

setMetadata in interface MetadataAware

Overrides:

setMetadata in class AbstractInternalCacheEntry

Parameters:

metadata - to apply to the cache entry

appendFieldsToString

protected void appendFieldsToString(StringBuilder builder)

Overrides:

appendFieldsToString in class AbstractInternalCacheEntry