Package org.infinispan.context.impl

Class SingleKeyNonTxInvocationContext

java.lang.Object

org.infinispan.context.impl.SingleKeyNonTxInvocationContext

All Implemented Interfaces:

Cloneable, EntryLookup, InvocationContext

public final class SingleKeyNonTxInvocationContext
extends Object
implements InvocationContext

Author:

Mircea Markus, Sanne Grinovero

Constructor Summary

Constructors

Constructor	Description
SingleKeyNonTxInvocationContext(Address origin)

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.
CacheEntry	getCacheEntry()
Object	getKey()
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	isKeyEquals(Object key)
boolean	isOriginLocal()	Returns true if the call was originated locally, false if it is the result of a remote rpc.
int	lookedUpEntriesCount()
CacheEntry	lookupEntry(Object key)	Retrieves an entry from the collection of looked up entries in the current scope.
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	resetState()
void	setLockOwner(Object lockOwner)	Sets the object to be used by lock owner.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.infinispan.context.EntryLookup

forEachValue, removeLookedUpEntries

Methods inherited from interface org.infinispan.context.InvocationContext

addLockedKeys

Constructor Detail

SingleKeyNonTxInvocationContext

public SingleKeyNonTxInvocationContext(Address origin)

Method Detail

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

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

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

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

clearLockedKeys

public void clearLockedKeys()

Specified by:

clearLockedKeys in interface InvocationContext

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

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.

isKeyEquals

public boolean isKeyEquals(Object key)

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.

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

lookedUpEntriesCount

public int lookedUpEntriesCount()

Specified by:

lookedUpEntriesCount in interface EntryLookup

Returns:

The number of entries wrapped in the context, including invalid 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

getKey

public Object getKey()

getCacheEntry

public CacheEntry getCacheEntry()

getOrigin

public Address getOrigin()

Specified by:

getOrigin in interface InvocationContext

Returns:

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

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

isEntryRemovedInContext

public boolean isEntryRemovedInContext(Object key)

Specified by:

isEntryRemovedInContext in interface InvocationContext

resetState

public void resetState()

toString

public String toString()

Overrides:

toString in class Object