Package org.infinispan.context.impl

Class ClearInvocationContext

java.lang.Object

org.infinispan.context.impl.AbstractInvocationContext

org.infinispan.context.impl.ClearInvocationContext

All Implemented Interfaces:

Cloneable, EntryLookup, InvocationContext

public class ClearInvocationContext
extends AbstractInvocationContext
implements Cloneable

Implementation of InvocationContext used by the ClearCommand.

Since:

7.2

Author:

Pedro Ruivo

Constructor Summary

Constructors

Constructor	Description
ClearInvocationContext(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()
ClearInvocationContext	clone()	Clones the invocation 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.
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.
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	setLockOwner(Object lockOwner)	Sets the object to be used by lock owner.

Methods inherited from class org.infinispan.context.impl.AbstractInvocationContext

getOrigin, isOriginLocal, publisher

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

forEachEntry, forEachValue, lookedUpEntriesCount, removeLookedUpEntries

Methods inherited from interface org.infinispan.context.InvocationContext

addLockedKeys

Constructor Details

ClearInvocationContext

public ClearInvocationContext(Address origin)

Method Details

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 ClearInvocationContext clone()

Description copied from interface: InvocationContext

Clones the invocation context.

Specified by:

clone in interface InvocationContext

Overrides:

clone in class AbstractInvocationContext

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

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

Overrides:

hasLockedKey in class AbstractInvocationContext

Parameters:

key - lock to test

isEntryRemovedInContext

public boolean isEntryRemovedInContext(Object key)

Specified by:

isEntryRemovedInContext in interface InvocationContext

Overrides:

isEntryRemovedInContext in class AbstractInvocationContext

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