org.apache.commons.jcs

Class JCS

java.lang.Object

org.apache.commons.jcs.JCS

public abstract class JCS
extends Object

Simple class for using JCS. To use JCS in your application, you can use the static methods of this class to get access objects (instances of this class) for your cache regions. One CacheAccess object should be created for each region you want to access. If you have several regions, then get instances for each. For best performance the getInstance call should be made in an initialization method.

Constructor Summary

Constructors

Constructor and Description
JCS()

Method Summary

Modifier and Type	Method and Description
static <K,V> CacheAccess<K,V>	defineRegion(String name) Deprecated. Duplicate of getInstance(String)
static <K,V> CacheAccess<K,V>	defineRegion(String name, ICompositeCacheAttributes cattr) Deprecated. Duplicate of getInstance(String, ICompositeCacheAttributes)
static <K,V> CacheAccess<K,V>	defineRegion(String name, ICompositeCacheAttributes cattr, IElementAttributes attr) Deprecated. Duplicate of getInstance(String, ICompositeCacheAttributes, IElementAttributes)
static <K,V> GroupCacheAccess<K,V>	getGroupCacheInstance(String region) Get a GroupCacheAccess which accesses the provided region.
static <K,V> GroupCacheAccess<K,V>	getGroupCacheInstance(String region, ICompositeCacheAttributes icca) Get a GroupCacheAccess which accesses the provided region.
static <K,V> GroupCacheAccess<K,V>	getGroupCacheInstance(String region, ICompositeCacheAttributes icca, IElementAttributes eattr) Get a GroupCacheAccess which accesses the provided region.
static <K,V> CacheAccess<K,V>	getInstance(String region) Get a CacheAccess which accesses the provided region.
static <K,V> CacheAccess<K,V>	getInstance(String region, ICompositeCacheAttributes icca) Get a CacheAccess which accesses the provided region.
static <K,V> CacheAccess<K,V>	getInstance(String region, ICompositeCacheAttributes icca, IElementAttributes eattr) Get a CacheAccess which accesses the provided region.
static void	setConfigFilename(String configFilename) Set the filename that the cache manager will be initialized with.
static void	setConfigProperties(Properties configProps) Set the properties that the cache manager will be initialized with.
static void	shutdown() Shut down the cache manager and set the instance to null

Methods inherited from class java.lang.Object

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

Constructor Detail

JCS

public JCS()

Method Detail

defineRegion

@Deprecated
public static <K,V> CacheAccess<K,V> defineRegion(String name)
                                                       throws CacheException

Deprecated. Duplicate of getInstance(String)

Define a new cache region with the given name. In the oracle specification, these attributes are global and not region specific, regional overrides is a value add each region should be able to house both cache and element attribute sets. It is more efficient to define a cache in the props file and then strictly use the get access method. Use of the define region outside of an initialization block should be avoided.

Parameters:

name - Name that will identify the region

Returns:

CacheAccess instance for the new region

Throws:

CacheException

defineRegion

@Deprecated
public static <K,V> CacheAccess<K,V> defineRegion(String name,
                                                              ICompositeCacheAttributes cattr)
                                                       throws CacheException

Deprecated. Duplicate of getInstance(String, ICompositeCacheAttributes)

Define a new cache region with the specified name and attributes.

Parameters:

name - Name that will identify the region

cattr - CompositeCacheAttributes for the region

Returns:

CacheAccess instance for the new region

Throws:

CacheException

defineRegion

@Deprecated
public static <K,V> CacheAccess<K,V> defineRegion(String name,
                                                              ICompositeCacheAttributes cattr,
                                                              IElementAttributes attr)
                                                       throws CacheException

Deprecated. Duplicate of getInstance(String, ICompositeCacheAttributes, IElementAttributes)

Define a new cache region with the specified name and attributes and return a CacheAccess to it.

Parameters:

name - Name that will identify the region

cattr - CompositeCacheAttributes for the region

attr - Attributes for the region

Returns:

CacheAccess instance for the new region

Throws:

CacheException

setConfigFilename

public static void setConfigFilename(String configFilename)

Set the filename that the cache manager will be initialized with. Only matters before the instance is initialized.

Parameters:

configFilename -

setConfigProperties

public static void setConfigProperties(Properties configProps)

Set the properties that the cache manager will be initialized with. Only matters before the instance is initialized.

Parameters:

configProps -

shutdown

public static void shutdown()

Shut down the cache manager and set the instance to null

getInstance

public static <K,V> CacheAccess<K,V> getInstance(String region)
                                          throws CacheException

Get a CacheAccess which accesses the provided region.

Parameters:

region - Region that return CacheAccess will provide access to

Returns:

A CacheAccess which provides access to a given region.

Throws:

CacheException

getInstance

public static <K,V> CacheAccess<K,V> getInstance(String region,
                                                 ICompositeCacheAttributes icca)
                                          throws CacheException

Get a CacheAccess which accesses the provided region.

Parameters:

region - Region that return CacheAccess will provide access to

icca - CacheAttributes for region

Returns:

A CacheAccess which provides access to a given region.

Throws:

CacheException

getInstance

public static <K,V> CacheAccess<K,V> getInstance(String region,
                                                 ICompositeCacheAttributes icca,
                                                 IElementAttributes eattr)
                                          throws CacheException

Get a CacheAccess which accesses the provided region.

Parameters:

region - Region that return CacheAccess will provide access to

icca - CacheAttributes for region

eattr - ElementAttributes for the region

Returns:

A CacheAccess which provides access to a given region.

Throws:

CacheException

getGroupCacheInstance

public static <K,V> GroupCacheAccess<K,V> getGroupCacheInstance(String region)
                                                         throws CacheException

Get a GroupCacheAccess which accesses the provided region.

Parameters:

region - Region that return GroupCacheAccess will provide access to

Returns:

A GroupCacheAccess which provides access to a given region.

Throws:

CacheException

getGroupCacheInstance

public static <K,V> GroupCacheAccess<K,V> getGroupCacheInstance(String region,
                                                                ICompositeCacheAttributes icca)
                                                         throws CacheException

Get a GroupCacheAccess which accesses the provided region.

Parameters:

region - Region that return GroupCacheAccess will provide access to

icca - CacheAttributes for region

Returns:

A GroupCacheAccess which provides access to a given region.

Throws:

CacheException

getGroupCacheInstance

public static <K,V> GroupCacheAccess<K,V> getGroupCacheInstance(String region,
                                                                ICompositeCacheAttributes icca,
                                                                IElementAttributes eattr)
                                                         throws CacheException

Get a GroupCacheAccess which accesses the provided region.

Parameters:

region - Region that return CacheAccess will provide access to

icca - CacheAttributes for region

eattr - ElementAttributes for the region

Returns:

A GroupCacheAccess which provides access to a given region.

Throws:

CacheException