Package org.infinispan.context.impl

Class ImmutableContext

java.lang.Object

org.infinispan.context.impl.ImmutableContext

All Implemented Interfaces:

Cloneable, EntryLookup, InvocationContext

public final class ImmutableContext
extends Object
implements InvocationContext

This context is a non-context for operations such as eviction which are not related to the method invocation which caused them.

Author:

Sanne Grinovero <sanne@infinispan.org> (C) 2011 Red Hat Inc.

Field Summary

Fields

Modifier and Type	Field	Description
static ImmutableContext	INSTANCE

Method Summary

Modifier and Type	Method	Description
void	addLockedKey(Object key)	Tracks the given key as locked by this invocation context.
void	clearLockedKeys()
InvocationContext	clone()	Clones the invocation context.
void	forEachEntry(BiConsumer<Object,CacheEntry> action)	Execute an action for each entry in the context.
void	forEachValue(BiConsumer<Object,CacheEntry> action)	Execute an action for each value in the context.
Set<Object>	getLockedKeys()	Returns the set of keys that are locked for writing.
Object	getLockOwner()	Returns the in behalf of which locks will be acquired.
Map<Object,CacheEntry>	getLookedUpEntries()	Retrieves a map of entries looked up within the current scope.
Address	getOrigin()
boolean	hasLockedKey(Object key)	Returns true if the lock being tested is already held in the current scope, false otherwise.
boolean	isEntryRemovedInContext(Object key)
boolean	isInTxScope()	Returns true if this call is performed in the context of an transaction, false otherwise.
boolean	isOriginLocal()	Returns true if the call was originated locally, false if it is the result of a remote rpc.
CacheEntry	lookupEntry(Object key)	Retrieves an entry from the collection of looked up entries in the current scope.
<K,V> org.reactivestreams.Publisher<CacheEntry<K,V>>	publisher()	Returns a Publisher that when subscribed to provide all values that have a value in the given context.
void	putLookedUpEntry(Object key, CacheEntry e)	Puts an entry in the registry of looked up entries in the current scope.
void	removeLookedUpEntry(Object key)
void	setLockOwner(Object lockOwner)	Sets the object to be used by lock owner.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.infinispan.context.EntryLookup

lookedUpEntriesCount, removeLookedUpEntries

Methods inherited from interface org.infinispan.context.InvocationContext

addLockedKeys

Field Detail

INSTANCE

public static final ImmutableContext INSTANCE

Method Detail

lookupEntry

public CacheEntry lookupEntry(Object key)

Description copied from interface: EntryLookup

Retrieves an entry from the collection of looked up entries in the current scope.

Specified by:

lookupEntry in interface EntryLookup

Parameters:

key - key to look up

Returns:

an entry, or null if it cannot be found.

getLookedUpEntries

public Map<Object,CacheEntry> getLookedUpEntries()

Description copied from interface: EntryLookup

Retrieves a map of entries looked up within the current scope.

Note: The key inside the CacheEntry may be null if the key does not exist in the cache.

Specified by:

getLookedUpEntries in interface EntryLookup

Returns:

a map of looked up entries.

putLookedUpEntry

public void putLookedUpEntry(Object key,
                             CacheEntry e)

Description copied from interface: EntryLookup

Puts an entry in the registry of looked up entries in the current scope.

Specified by:

putLookedUpEntry in interface EntryLookup

Parameters:

key - key to store

e - entry to store

removeLookedUpEntry

public void removeLookedUpEntry(Object key)

Specified by:

removeLookedUpEntry in interface EntryLookup

hasLockedKey

public boolean hasLockedKey(Object key)

Description copied from interface: InvocationContext

Returns true if the lock being tested is already held in the current scope, false otherwise.

Specified by:

hasLockedKey in interface InvocationContext

Parameters:

key - lock to test

isOriginLocal

public boolean isOriginLocal()

Description copied from interface: InvocationContext

Returns true if the call was originated locally, false if it is the result of a remote rpc.

Specified by:

isOriginLocal in interface InvocationContext

getOrigin

public Address getOrigin()

Specified by:

getOrigin in interface InvocationContext

Returns:

the origin of the command, or null if the command originated locally

isInTxScope

public boolean isInTxScope()

Description copied from interface: InvocationContext

Returns true if this call is performed in the context of an transaction, false otherwise.

Specified by:

isInTxScope in interface InvocationContext

getLockOwner

public Object getLockOwner()

Description copied from interface: InvocationContext

Returns the in behalf of which locks will be acquired.

Specified by:

getLockOwner in interface InvocationContext

setLockOwner

public void setLockOwner(Object lockOwner)

Description copied from interface: InvocationContext

Sets the object to be used by lock owner.

Specified by:

setLockOwner in interface InvocationContext

getLockedKeys

public Set<Object> getLockedKeys()

Description copied from interface: InvocationContext

Returns the set of keys that are locked for writing.

Specified by:

getLockedKeys in interface InvocationContext

clone

public InvocationContext clone()

Description copied from interface: InvocationContext

Clones the invocation context.

Specified by:

clone in interface InvocationContext

Overrides:

clone in class Object

Returns:

A cloned instance of this invocation context instance

addLockedKey

public void addLockedKey(Object key)

Description copied from interface: InvocationContext

Tracks the given key as locked by this invocation context.

Specified by:

addLockedKey in interface InvocationContext

clearLockedKeys

public void clearLockedKeys()

Specified by:

clearLockedKeys in interface InvocationContext

isEntryRemovedInContext

public boolean isEntryRemovedInContext(Object key)

Specified by:

isEntryRemovedInContext in interface InvocationContext

forEachEntry

public void forEachEntry(BiConsumer<Object,CacheEntry> action)

Description copied from interface: EntryLookup

Execute an action for each entry in the context. Includes invalid entries, which have a null value and may also report a null key.

Specified by:

forEachEntry in interface EntryLookup

forEachValue

public void forEachValue(BiConsumer<Object,CacheEntry> action)

Description copied from interface: EntryLookup

Execute an action for each value in the context.

Entries that do not have a value (because the key was removed, or it doesn't exist in the cache).

Specified by:

forEachValue in interface EntryLookup

publisher

public <K,V> org.reactivestreams.Publisher<CacheEntry<K,V>> publisher()

Description copied from interface: EntryLookup

Returns a Publisher that when subscribed to provide all values that have a value in the given context.

Specified by:

publisher in interface EntryLookup

Type Parameters:

K - key type provided from user

V - value type provided from user

Returns: