com.ibm.wsspi.cache
Class DistributedObjectCacheFactory

java.lang.Object
  extended bycom.ibm.wsspi.cache.DistributedObjectCacheFactory

public class DistributedObjectCacheFactory
extends java.lang.Object

This class provides components with factory methods to create/lookup instances of a DistributedObjectCache. Each DistributedObjectCache instance can be configured independently. Use the DistributedObjectCache.getMapType method to determine the map type.

See Also:
DistributedMap, DistributedNioMap

Field Summary
static java.lang.String KEY_CACHE_SIZE
          Property key to specify cache size.
static java.lang.String KEY_DISABLE_DEPENDENCY_ID
          Property key to disble dependency support.
static java.lang.String KEY_DISABLE_TEMPLATES_SUPPORT
          Property key to disble template support.
static java.lang.String KEY_DISK_OFFLOAD_LOCATION
          Property key to specify the disk offload location.
static java.lang.String KEY_ENABLE_CACHE_REPLICATION
          Property key to enable cache replication.
static java.lang.String KEY_ENABLE_DISK_OFFLOAD
          Property key to disble template support.
static java.lang.String KEY_ENABLE_NIO_SUPPORT
          Property key to enable nio support.
static java.lang.String KEY_FLUSH_TO_DISK_ON_STOP
          Property key to enable flushing cache contents to disk when the server is stopped.
static java.lang.String KEY_REPLICATION_DOMAIN
          Property key to specify the replication domain.
static java.lang.String KEY_USE_LISTENER_CONTEXT
          Property key to enable listener context on callbacks.
static java.lang.String VALUE_FALSE
          Property value for false.
static java.lang.String VALUE_TRUE
          Property value for true.
 
Method Summary
static DistributedObjectCache getMap(java.lang.String name)
          Returns the DistributedMap instance specified by the given id.
static DistributedObjectCache getMap(java.lang.String name, java.util.Properties properties)
          Returns the DistributedMap or DistributedNioMap instance specified by the given id, using the the parameters specified in properties.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

KEY_CACHE_SIZE

public static final java.lang.String KEY_CACHE_SIZE
Property key to specify cache size. Value is string int

Since:
v6.0
See Also:
Constant Field Values

KEY_DISABLE_DEPENDENCY_ID

public static final java.lang.String KEY_DISABLE_DEPENDENCY_ID
Property key to disble dependency support. Value is VALUE_TRUE or VALUE_FALSE

Since:
v6.0
See Also:
Constant Field Values

KEY_DISABLE_TEMPLATES_SUPPORT

public static final java.lang.String KEY_DISABLE_TEMPLATES_SUPPORT
Property key to disble template support. Value is VALUE_TRUE or VALUE_FALSE

Since:
v6.0
See Also:
Constant Field Values

KEY_ENABLE_DISK_OFFLOAD

public static final java.lang.String KEY_ENABLE_DISK_OFFLOAD
Property key to disble template support. Value is VALUE_TRUE or VALUE_FALSE

Since:
v6.0
See Also:
Constant Field Values

KEY_ENABLE_NIO_SUPPORT

public static final java.lang.String KEY_ENABLE_NIO_SUPPORT
Property key to enable nio support. Value is VALUE_TRUE or VALUE_FALSE

Since:
v6.0
See Also:
DistributedNioMap, Constant Field Values

KEY_DISK_OFFLOAD_LOCATION

public static final java.lang.String KEY_DISK_OFFLOAD_LOCATION
Property key to specify the disk offload location. Value is string path

Since:
v6.0
See Also:
Constant Field Values

KEY_USE_LISTENER_CONTEXT

public static final java.lang.String KEY_USE_LISTENER_CONTEXT
Property key to enable listener context on callbacks. Value is VALUE_TRUE or VALUE_FALSE

Since:
v6.0
See Also:
Constant Field Values

KEY_FLUSH_TO_DISK_ON_STOP

public static final java.lang.String KEY_FLUSH_TO_DISK_ON_STOP
Property key to enable flushing cache contents to disk when the server is stopped. This property is ignored if disk offload is disabled. Value is VALUE_TRUE or VALUE_FALSE

Since:
v6.0
See Also:
Constant Field Values

KEY_ENABLE_CACHE_REPLICATION

public static final java.lang.String KEY_ENABLE_CACHE_REPLICATION
Property key to enable cache replication. Value is VALUE_TRUE or VALUE_FALSE

Since:
v6.0
See Also:
Constant Field Values

KEY_REPLICATION_DOMAIN

public static final java.lang.String KEY_REPLICATION_DOMAIN
Property key to specify the replication domain. Value is string domain name.

Since:
v6.0
See Also:
Constant Field Values

VALUE_TRUE

public static final java.lang.String VALUE_TRUE
Property value for true.

Since:
v6.0
See Also:
Constant Field Values

VALUE_FALSE

public static final java.lang.String VALUE_FALSE
Property value for false.

Since:
v6.0
See Also:
Constant Field Values
Method Detail

getMap

public static DistributedObjectCache getMap(java.lang.String name)
Returns the DistributedMap instance specified by the given id. If the given instance has not yet been created, then a new instance is created using the default parameters.

Parameters:
name - instance name
Returns:
A DistributedMap instance
See Also:
getMap(String, Properties)

getMap

public static DistributedObjectCache getMap(java.lang.String name,
                                            java.util.Properties properties)
Returns the DistributedMap or DistributedNioMap instance specified by the given id, using the the parameters specified in properties. If the given instance has not yet been created, then a new instance is created using the parameters specified in the properties object. Use the various KEY_xxx and VALUE_xxx constants to populate the passed properties object.

Parameters:
name - instance name
properties -
Returns:
A DistributedObjectCache instance