org.apache.jcs.engine.control
Class CompositeCacheConfigurator

java.lang.Object
  extended byorg.apache.jcs.engine.control.CompositeCacheConfigurator

public class CompositeCacheConfigurator
extends java.lang.Object

This class is based on the log4j class org.apache.log4j.PropertyConfigurator which was made by: "Luke Blanshard" "Mark DONSZELMANN" "Anders Kristensen"

Author:
asmuts

Field Summary
(package private) static java.lang.String ATTRIBUTE_PREFIX
           
(package private) static java.lang.String AUXILIARY_PREFIX
           
(package private) static java.lang.String CACHE_ATTRIBUTE_PREFIX
           
private  CompositeCacheManager ccMgr
           
(package private) static java.lang.String DEFAULT_REGION
           
(package private) static java.lang.String ELEMENT_ATTRIBUTE_PREFIX
           
private static org.apache.commons.logging.Log log
           
(package private) static java.lang.String REGION_PREFIX
           
(package private) static java.lang.String SYSTEM_REGION_PREFIX
           
 
Constructor Summary
CompositeCacheConfigurator(CompositeCacheManager ccMgr)
          Constructor for the CompositeCacheConfigurator object
 
Method Summary
 void doConfigure(java.util.Properties properties)
          Configure cache for properties object
 void doConfigure(java.lang.String configFileName)
          Configure cached for file name.
protected  AuxiliaryCache parseAuxiliary(CompositeCache cache, java.util.Properties props, java.lang.String auxName, java.lang.String regName)
          Get an aux cache for the listed aux for a region.
protected  ICompositeCacheAttributes parseCompositeCacheAttributes(java.util.Properties props, java.lang.String regName)
          Get an compositecacheattributes for the listed region.
protected  ICompositeCacheAttributes parseCompositeCacheAttributes(java.util.Properties props, java.lang.String regName, java.lang.String regionPrefix)
           
protected  IElementAttributes parseElementAttributes(java.util.Properties props, java.lang.String regName, java.lang.String regionPrefix)
           
protected  CompositeCache parseRegion(java.util.Properties props, java.lang.String regName, java.lang.String value)
          Create cache region.
protected  CompositeCache parseRegion(java.util.Properties props, java.lang.String regName, java.lang.String value, ICompositeCacheAttributes cca)
           
protected  CompositeCache parseRegion(java.util.Properties props, java.lang.String regName, java.lang.String value, ICompositeCacheAttributes cca, java.lang.String regionPrefix)
           
protected  void parseRegions(java.util.Properties props)
          Parse region elements.
protected  void parseSystemRegions(java.util.Properties props)
          Create caches used internally.
protected  void setDefaultAuxValues(java.util.Properties props)
          Set the default aux list for new caches.
protected  void setDefaultCompositeCacheAttributes(java.util.Properties props)
          Set the default CompositeCacheAttributes for new caches.
protected  void setDefaultElementAttributes(java.util.Properties props)
          Set the default ElementAttributes for new caches.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

log

private static final org.apache.commons.logging.Log log

DEFAULT_REGION

static final java.lang.String DEFAULT_REGION
See Also:
Constant Field Values

REGION_PREFIX

static final java.lang.String REGION_PREFIX
See Also:
Constant Field Values

SYSTEM_REGION_PREFIX

static final java.lang.String SYSTEM_REGION_PREFIX
See Also:
Constant Field Values

AUXILIARY_PREFIX

static final java.lang.String AUXILIARY_PREFIX
See Also:
Constant Field Values

ATTRIBUTE_PREFIX

static final java.lang.String ATTRIBUTE_PREFIX
See Also:
Constant Field Values

CACHE_ATTRIBUTE_PREFIX

static final java.lang.String CACHE_ATTRIBUTE_PREFIX
See Also:
Constant Field Values

ELEMENT_ATTRIBUTE_PREFIX

static final java.lang.String ELEMENT_ATTRIBUTE_PREFIX
See Also:
Constant Field Values

ccMgr

private CompositeCacheManager ccMgr
Constructor Detail

CompositeCacheConfigurator

public CompositeCacheConfigurator(CompositeCacheManager ccMgr)
Constructor for the CompositeCacheConfigurator object

Parameters:
ccMgr -
Method Detail

doConfigure

public void doConfigure(java.lang.String configFileName)
Configure cached for file name.


doConfigure

public void doConfigure(java.util.Properties properties)
Configure cache for properties object


setDefaultAuxValues

protected void setDefaultAuxValues(java.util.Properties props)
Set the default aux list for new caches.


setDefaultCompositeCacheAttributes

protected void setDefaultCompositeCacheAttributes(java.util.Properties props)
Set the default CompositeCacheAttributes for new caches.


setDefaultElementAttributes

protected void setDefaultElementAttributes(java.util.Properties props)
Set the default ElementAttributes for new caches.


parseSystemRegions

protected void parseSystemRegions(java.util.Properties props)
Create caches used internally. System status gives them creation priority.


parseRegions

protected void parseRegions(java.util.Properties props)
Parse region elements.


parseRegion

protected CompositeCache parseRegion(java.util.Properties props,
                                     java.lang.String regName,
                                     java.lang.String value)
Create cache region.


parseRegion

protected CompositeCache parseRegion(java.util.Properties props,
                                     java.lang.String regName,
                                     java.lang.String value,
                                     ICompositeCacheAttributes cca)

parseRegion

protected CompositeCache parseRegion(java.util.Properties props,
                                     java.lang.String regName,
                                     java.lang.String value,
                                     ICompositeCacheAttributes cca,
                                     java.lang.String regionPrefix)

parseCompositeCacheAttributes

protected ICompositeCacheAttributes parseCompositeCacheAttributes(java.util.Properties props,
                                                                  java.lang.String regName)
Get an compositecacheattributes for the listed region.


parseCompositeCacheAttributes

protected ICompositeCacheAttributes parseCompositeCacheAttributes(java.util.Properties props,
                                                                  java.lang.String regName,
                                                                  java.lang.String regionPrefix)

parseElementAttributes

protected IElementAttributes parseElementAttributes(java.util.Properties props,
                                                    java.lang.String regName,
                                                    java.lang.String regionPrefix)

parseAuxiliary

protected AuxiliaryCache parseAuxiliary(CompositeCache cache,
                                        java.util.Properties props,
                                        java.lang.String auxName,
                                        java.lang.String regName)
Get an aux cache for the listed aux for a region.