|
Oracle® Fusion Middleware Java API Reference for Oracle Coherence 12c (12.1.3.0.0) E47890-01 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface BackingMapManagerContext
The BackingMapManager context is used by the CacheService to pass information to the BackingMapManager during the service initialization. This object also allows BackingMapManager instances running on different cluster participate in a common service distribution strategy.
Field Summary | |
---|---|
static int |
DECO_CUSTOM The decoration id for a client specific (opaque) value information. |
static int |
DECO_EXPIRY The decoration id for the value expiry information. |
static int |
DECO_STORE The decoration id for the persistent state of the decorated value. |
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) Deprecated. As of Coherence 3.7, use of this method is discouraged. Instead, use BackingMapContext.getBackingMapEntry(java.lang.Object) . |
BackingMapContext |
getBackingMapContext(java.lang.String sCacheName) Obtain a reference to the BackingMapContext that corresponds to the specified cache name. |
CacheService |
getCacheService() Return the CacheService associated with this context. |
java.lang.ClassLoader |
getClassLoader() Return the ClassLoader associated with this context. |
XmlElement |
getConfig() Determine the current configuration of the associated 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 associated with. |
void |
setConfig(XmlElement xml) Specify the configuration for the associated BackingMapManager. |
Field Detail |
---|
static final int DECO_EXPIRY
static final int DECO_STORE
static final int DECO_CUSTOM
Method Detail |
---|
BackingMapManager getManager()
CacheService getCacheService()
java.lang.ClassLoader getClassLoader()
void setClassLoader(java.lang.ClassLoader loader)
loader
- the ClassLoader associated with this contextConverter getKeyToInternalConverter()
Converter getKeyFromInternalConverter()
Converter getValueToInternalConverter()
Converter getValueFromInternalConverter()
boolean isKeyOwned(java.lang.Object oKey)
oKey
- the resource key in the internal formatjava.lang.ClassCastException
- if the passed key is not in the internal formatint getKeyPartition(java.lang.Object oKey)
oKey
- a key in its internal formatjava.util.Set getPartitionKeys(java.lang.String sCacheName, int nPartition)
sCacheName
- the cache name for the backing map to retrieve the set of keys fornPartition
- the partition IDjava.util.Map getBackingMap(java.lang.String sCacheName)
BackingMapContext.getBackingMapEntry(java.lang.Object)
.sCacheName
- the cache nameBackingMapContext getBackingMapContext(java.lang.String sCacheName)
BackingMapContext
that corresponds to the specified cache name.
Note: calling this method will not create a backing map for the specified cache name; it will return null if the cache has yet to be used (e.g. via ConfigurableCacheFactory.ensureCache
call) or has been destroyed
sCacheName
- the cache namejava.lang.Object addInternalValueDecoration(java.lang.Object oValue, int nDecorId, java.lang.Object oDecor)
internal converter
to either passed-in or returned internal values will produce identical values in Object form.oValue
- a value in the internal formnDecorId
- a decoration identifier; valid decoration identifiers are any of the DECO_* constant valuesoDecor
- a decoration value in Object formjava.lang.Object removeInternalValueDecoration(java.lang.Object oValue, int nDecorId)
internal converter
to either passed-in or returned internal values will produce identical values in Object form.oValue
- a decorated value in the internal formnDecorId
- a decoration identifier; valid decoration identifiers are any of the DECO_* constant valuesboolean isInternalValueDecorated(java.lang.Object oValue, int nDecorId)
oValue
- a decorated value in the internal formnDecorId
- a decoration identifier; valid decoration identifiers are any of the DECO_* constant valuesjava.lang.Object getInternalValueDecoration(java.lang.Object oValue, int nDecorId)
oValue
- a decorated value in the internal formnDecorId
- a decoration identifier; valid decoration identifiers are any of the DECO_* constant valuesXmlElement getConfig()
getConfig
in interface XmlConfigurable
void setConfig(XmlElement xml)
setConfig
in interface XmlConfigurable
xml
- the XML configurationjava.lang.IllegalStateException
- if the object is not in a state that allows the configuration to be set; for example, if the manager has already been configured and cannot be reconfigured
|
Oracle® Fusion Middleware Java API Reference for Oracle Coherence 12c (12.1.3.0.0) E47890-01 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |