Skip navigation links

Oracle® Coherence Java API Reference
Release 3.6.1.0

E18814-01


com.tangosol.util
Class NullImplementation.NullBackingMapManagerContext

java.lang.Object
  extended by com.tangosol.util.NullImplementation.NullBackingMapManagerContext

All Implemented Interfaces:
BackingMapManagerContext, XmlConfigurable
Enclosing class:
NullImplementation

public static class NullImplementation.NullBackingMapManagerContext
extends java.lang.Object
implements BackingMapManagerContext

An implementation of BackingMapManagerContext that does nothing.


Field Summary
static NullImplementation.NullBackingMapManagerContext INSTANCE
          Singleton instance.

 

Fields inherited from interface com.tangosol.net.BackingMapManagerContext
DECO_CUSTOM, DECO_EXPIRY, DECO_STORE

 

Method Summary
 java.lang.Object addInternalValueDecoration(java.lang.Object oValue, int nDecorId, java.lang.Object oDecor)
          Decorate a specified value in the internal form with a specified decoration in the "normal" Object form.
 java.util.Map getBackingMap(java.lang.String sCacheName)
          Obtain a reference to the backing map that corresponds to the specified cache name.
 CacheService getCacheService()
          Return the CacheService assosiated with this context.
 java.lang.ClassLoader getClassLoader()
          Return the ClassLoader assosiated with this context.
 XmlElement getConfig()
          Determine the current configuration of the assosiated BackingMapManager.
 java.lang.Object getInternalValueDecoration(java.lang.Object oValue, int nDecorId)
          Obtain a decoration from the specified value in the internal form.
 Converter getKeyFromInternalConverter()
          Return a converter that allows the manager (or a backing map managed thereby) to convert a key object from its internal form (as managed by the CacheService) into its "normal" (Object) form.
 int getKeyPartition(java.lang.Object oKey)
          Determine the partition to which the specified key belongs.
 Converter getKeyToInternalConverter()
          Return a converter that allows the manager (or a backing map managed thereby) to convert a key object into its internal form as managed by the CacheService.
 BackingMapManager getManager()
          Return the BackingMapManager this object is a context for.
 java.util.Set getPartitionKeys(java.lang.String sCacheName, int nPartition)
          Obtain a collection of keys in the internal format that belong to the specified partition for the specified backing map.
 Converter getValueFromInternalConverter()
          Return a converter that allows the manager (or a backing map managed thereby) to convert a value object from its internal form (as managed by the CacheService) into its "normal" (Object) form.
 Converter getValueToInternalConverter()
          Return a converter that allows the manager (or a backing map managed thereby) to convert a value object into its internal form as managed by the CacheService.
 boolean isInternalValueDecorated(java.lang.Object oValue, int nDecorId)
          Check whether or not the specified value in the internal form is decorated.
 boolean isKeyOwned(java.lang.Object oKey)
          Determines whether or not the specified key (in the internal format) is managed (i.e. controlled) by this service member.
 java.lang.Object removeInternalValueDecoration(java.lang.Object oValue, int nDecorId)
          Remove a decoration from the specified value in the internal form.
 void setClassLoader(java.lang.ClassLoader loader)
          Assign the ClassLoader this context is assosiated with.
 void setConfig(XmlElement xml)
          Specify the configuration for the assosiated BackingMapManager.

 

Field Detail

INSTANCE

public static final NullImplementation.NullBackingMapManagerContext INSTANCE
Singleton instance.

Method Detail

getManager

public BackingMapManager getManager()
Return the BackingMapManager this object is a context for.
Specified by:
getManager in interface BackingMapManagerContext
Returns:
the BackingMapManager this object is a context for

getCacheService

public CacheService getCacheService()
Return the CacheService assosiated with this context.
Specified by:
getCacheService in interface BackingMapManagerContext
Returns:
the CacheService assosiated with this context

getClassLoader

public java.lang.ClassLoader getClassLoader()
Return the ClassLoader assosiated with this context.
Specified by:
getClassLoader in interface BackingMapManagerContext
Returns:
the ClassLoader assosiated with this context

setClassLoader

public void setClassLoader(java.lang.ClassLoader loader)
Assign the ClassLoader this context is assosiated with.
Specified by:
setClassLoader in interface BackingMapManagerContext
Parameters:
loader - the ClassLoader assosiated with this context

getKeyToInternalConverter

public Converter getKeyToInternalConverter()
Return a converter that allows the manager (or a backing map managed thereby) to convert a key object into its internal form as managed by the CacheService.
Specified by:
getKeyToInternalConverter in interface BackingMapManagerContext
Returns:
the object-to-internal converter

getKeyFromInternalConverter

public Converter getKeyFromInternalConverter()
Return a converter that allows the manager (or a backing map managed thereby) to convert a key object from its internal form (as managed by the CacheService) into its "normal" (Object) form. If a ClassLoader is available, it will be used if deserialization is involved in the conversion.
Specified by:
getKeyFromInternalConverter in interface BackingMapManagerContext
Returns:
the internal-to-object converter

getValueToInternalConverter

public Converter getValueToInternalConverter()
Return a converter that allows the manager (or a backing map managed thereby) to convert a value object into its internal form as managed by the CacheService.
Specified by:
getValueToInternalConverter in interface BackingMapManagerContext
Returns:
the object-to-internal converter

getValueFromInternalConverter

public Converter getValueFromInternalConverter()
Return a converter that allows the manager (or a backing map managed thereby) to convert a value object from its internal form (as managed by the CacheService) into its "normal" (Object) form. If a ClassLoader is available, it will be used if deserialization is involved in the conversion.
Specified by:
getValueFromInternalConverter in interface BackingMapManagerContext
Returns:
the internal-to-object converter

isKeyOwned

public boolean isKeyOwned(java.lang.Object oKey)
Determines whether or not the specified key (in the internal format) is managed (i.e. controlled) by this service member. In other words, is the specified key under the management of the backing map whose manager this context represents. The key does not have to actually exist for this method to evaluate it; the answer is not backing map- specific.
Specified by:
isKeyOwned in interface BackingMapManagerContext
Parameters:
oKey - the resource key in the internal format
Returns:
true iff the key is managed by this service member

getKeyPartition

public int getKeyPartition(java.lang.Object oKey)
Determine the partition to which the specified key belongs.
Specified by:
getKeyPartition in interface BackingMapManagerContext
Parameters:
oKey - a key in its internal format
Returns:
the parition ID that the specified key is assigned to

getPartitionKeys

public java.util.Set getPartitionKeys(java.lang.String sCacheName,
                                      int nPartition)
Obtain a collection of keys in the internal format that belong to the specified partition for the specified backing map. The returned Set must be used in a read-only manner.
Specified by:
getPartitionKeys in interface BackingMapManagerContext
Parameters:
sCacheName - the cache name for the backing map to retrieve the set of keys for
nPartition - the partition ID
Returns:
the Set of keys in the internal format; could be null if the backing map does not exists or the specified partition is not owned by this node

getBackingMap

public java.util.Map getBackingMap(java.lang.String sCacheName)
Obtain a reference to the backing map that corresponds to the specified cache name. The returned Map must be used in a read-only manner.
Specified by:
getBackingMap in interface BackingMapManagerContext
Parameters:
sCacheName - the cache name
Returns:
the backing map reference; null if the backing map does not exist

addInternalValueDecoration

public java.lang.Object addInternalValueDecoration(java.lang.Object oValue,
                                                   int nDecorId,
                                                   java.lang.Object oDecor)
Decorate a specified value in the internal form with a specified decoration in the "normal" Object form. It's important to understand that applying the internal converter to either passed-in or returned internal values will produce identical values in Object form.
Specified by:
addInternalValueDecoration in interface BackingMapManagerContext
Parameters:
oValue - a value in the internal form
nDecorId - a decoration identifier; valid decoration identifiers are any of the DECO_* constant values
oDecor - a decoration value in Object form
Returns:
a decorated value in the internal form

removeInternalValueDecoration

public java.lang.Object removeInternalValueDecoration(java.lang.Object oValue,
                                                      int nDecorId)
Remove a decoration from the specified value in the internal form. If the specified value is not decorated, the call will have no effect. It's important to understand that applying the internal converter to either passed-in or returned internal values will produce identical values in Object form.
Specified by:
removeInternalValueDecoration in interface BackingMapManagerContext
Parameters:
oValue - a decorated value in the internal form
nDecorId - a decoration identifier; valid decoration identifiers are any of the DECO_* constant values
Returns:
an un-decorated value in the internal form

isInternalValueDecorated

public boolean isInternalValueDecorated(java.lang.Object oValue,
                                        int nDecorId)
Check whether or not the specified value in the internal form is decorated.
Specified by:
isInternalValueDecorated in interface BackingMapManagerContext
Parameters:
oValue - a decorated value in the internal form
nDecorId - a decoration identifier; valid decoration identifiers are any of the DECO_* constant values
Returns:
true if the value is decorated using the specified decoration id; false otherwise

getInternalValueDecoration

public java.lang.Object getInternalValueDecoration(java.lang.Object oValue,
                                                   int nDecorId)
Obtain a decoration from the specified value in the internal form. If the specified value is decorated with the specified decoration id, a value in a "normal" Object form is returned; otherwise null.
Specified by:
getInternalValueDecoration in interface BackingMapManagerContext
Parameters:
oValue - a decorated value in the internal form
nDecorId - a decoration identifier; valid decoration identifiers are any of the DECO_* constant values
Returns:
an un-decorated value in the internal form

getConfig

public XmlElement getConfig()
Determine the current configuration of the assosiated BackingMapManager.
Specified by:
getConfig in interface BackingMapManagerContext
Specified by:
getConfig in interface XmlConfigurable
Returns:
the XML configuration or null

setConfig

public void setConfig(XmlElement xml)
Specify the configuration for the assosiated BackingMapManager. The configuration content is shared between all instances of the corresponding CacheService running on different cluster nodes.
Specified by:
setConfig in interface BackingMapManagerContext
Specified by:
setConfig in interface XmlConfigurable
Parameters:
xml - the XML configuration

Skip navigation links

Oracle® Coherence Java API Reference
Release 3.6.1.0

E18814-01


Copyright © 2000, 2010, Oracle and/or its affiliates. All rights reserved.