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 (C) 2011 Red Hat Inc.

Field Summary

static ImmutableContext

INSTANCE

Method Summary

void	addLockedKey(Object key) Tracks the given key as locked by this invocation context.
void	clearLockedKeys()
void	clearLookedUpEntries() Clears the collection of entries looked up
InvocationContext	clone() Clones the invocation context.
ClassLoader	getClassLoader() Returns the class loader associated with this invocation
Set<Object>	getLockedKeys() Returns the set of keys that are locked for writing.
Object	getLockOwner() Returns the in behalf of which locks will be aquired.
Map<Object,CacheEntry>	getLookedUpEntries() Retrieves a map of entries looked up within the current scope.
Address	getOrigin() Get the origin of the command, or null if the command originated locally
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.
boolean	isUseFutureReturnType() Indicates whether the call requires a Future as return type.
CacheEntry	lookupEntry(Object key) Retrieves an entry from the collection of looked up entries in the current scope.
void	putLookedUpEntries(Map<Object,CacheEntry> lookedUpEntries)
void	putLookedUpEntry(Object key, CacheEntry e) Puts an entry in the registry of looked up entries in the current scope.
void	removeLookedUpEntry(Object key)
boolean	replaceValue(Object key, InternalCacheEntry cacheEntry) Tries to replace the value of the wrapped entry associated with the given key in the context, if one exists.
void	setClassLoader(ClassLoader classLoader) Sets the class loader associated for this invocation
void	setUseFutureReturnType(boolean useFutureReturnType) Sets whether the call requires a Future as return type.

Methods inherited from class java.lang.Object

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

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.

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

putLookedUpEntries

public void putLookedUpEntries(Map<Object,CacheEntry> lookedUpEntries)

Specified by:

putLookedUpEntries in interface EntryLookup

removeLookedUpEntry

public void removeLookedUpEntry(Object key)

Specified by:

removeLookedUpEntry in interface EntryLookup

clearLookedUpEntries

public void clearLookedUpEntries()

Description copied from interface: EntryLookup

Clears the collection of entries looked up

Specified by:

clearLookedUpEntries 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()

Description copied from interface: InvocationContext

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

Specified by:

getOrigin in interface InvocationContext

Returns:

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 aquired.

Specified by:

getLockOwner in interface InvocationContext

isUseFutureReturnType

public boolean isUseFutureReturnType()

Description copied from interface: InvocationContext

Indicates whether the call requires a Future as return type.

Specified by:

isUseFutureReturnType in interface InvocationContext

Returns:

true if the call requires a Future as return type, false otherwise

setUseFutureReturnType

public void setUseFutureReturnType(boolean useFutureReturnType)

Description copied from interface: InvocationContext

Sets whether the call requires a Future as return type.

Specified by:

setUseFutureReturnType in interface InvocationContext

Parameters:

useFutureReturnType - boolean indicating whether a Future will be needed.

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

getClassLoader

public ClassLoader getClassLoader()

Description copied from interface: InvocationContext

Returns the class loader associated with this invocation

Specified by:

getClassLoader in interface InvocationContext

Returns:

a class loader instance or null if no class loader was specifically associated

setClassLoader

public void setClassLoader(ClassLoader classLoader)

Description copied from interface: InvocationContext

Sets the class loader associated for this invocation

Specified by:

setClassLoader 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

clearLockedKeys

public void clearLockedKeys()

Specified by:

clearLockedKeys in interface InvocationContext

replaceValue

public boolean replaceValue(Object key,
                            InternalCacheEntry cacheEntry)

Description copied from interface: InvocationContext

Tries to replace the value of the wrapped entry associated with the given key in the context, if one exists.

Specified by:

replaceValue in interface InvocationContext

Returns:

true if the context already contained a wrapped entry for which this value was changed, false otherwise.

isEntryRemovedInContext

public boolean isEntryRemovedInContext(Object key)

Specified by:

isEntryRemovedInContext in interface InvocationContext