Field Summary |
static java.lang.String |
KEY_MATCHER_PREFIX
jcs.auxiliary.NAME.keymatcher=CLASSNAME |
Method Summary |
void |
doConfigure(java.util.Properties properties)
Configure cache for properties object. |
protected 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 ICompositeCacheAttributes for the listed region. |
protected ICompositeCacheAttributes |
parseCompositeCacheAttributes(java.util.Properties props,
java.lang.String regName,
java.lang.String regionPrefix)
Get the main attributes for a region. |
protected IElementAttributes |
parseElementAttributes(java.util.Properties props,
java.lang.String regName,
java.lang.String regionPrefix)
Create the element attributes from the properties object for a cache region. |
static IKeyMatcher |
parseKeyMatcher(java.util.Properties props,
java.lang.String auxPrefix)
Creates a custom key matcher if one is defined. |
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)
Get all the properties for a region and configure its cache. |
protected CompositeCache |
parseRegion(java.util.Properties props,
java.lang.String regName,
java.lang.String value,
ICompositeCacheAttributes cca,
java.lang.String regionPrefix)
Get all the properties for a region and configure its cache. |
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 |
KEY_MATCHER_PREFIX
public static final java.lang.String KEY_MATCHER_PREFIX
- jcs.auxiliary.NAME.keymatcher=CLASSNAME
jcs.auxiliary.NAME.keymatcher.attributes.CUSTOMPROPERTY=VALUE
- See Also:
- Constant Field Values
CompositeCacheConfigurator
public CompositeCacheConfigurator(CompositeCacheManager ccMgr)
- Constructor for the CompositeCacheConfigurator object
- Parameters:
ccMgr
-
doConfigure
protected void doConfigure(java.lang.String configFileName)
- Configure cached for file name.
This is only used for testing. The manager handles the translation of a file into a
properties object.
- Parameters:
configFileName
-
doConfigure
public void doConfigure(java.util.Properties properties)
- Configure cache for properties object.
This method proceeds in several steps:
- Store props for use by non configured caches.
- Set default value list
- Set default cache attr
- Set default element attr
- Setup system caches to be used
- Setup preconfigured caches
- Parameters:
properties
-
setDefaultAuxValues
protected void setDefaultAuxValues(java.util.Properties props)
- Set the default aux list for new caches.
- Parameters:
props
-
setDefaultCompositeCacheAttributes
protected void setDefaultCompositeCacheAttributes(java.util.Properties props)
- Set the default CompositeCacheAttributes for new caches.
- Parameters:
props
-
setDefaultElementAttributes
protected void setDefaultElementAttributes(java.util.Properties props)
- Set the default ElementAttributes for new caches.
- Parameters:
props
-
parseSystemRegions
protected void parseSystemRegions(java.util.Properties props)
- Create caches used internally. System status gives them creation priority.
- Parameters:
props
-
parseRegions
protected void parseRegions(java.util.Properties props)
- Parse region elements.
- Parameters:
props
-
parseRegion
protected CompositeCache parseRegion(java.util.Properties props,
java.lang.String regName,
java.lang.String value)
- Create cache region.
- Parameters:
props
- regName
- value
-
- Returns:
- CompositeCache
parseRegion
protected CompositeCache parseRegion(java.util.Properties props,
java.lang.String regName,
java.lang.String value,
ICompositeCacheAttributes cca)
- Get all the properties for a region and configure its cache.
This method tells the other parse method the name of the region prefix.
- Parameters:
props
- regName
- value
- cca
-
- Returns:
- CompositeCache
parseRegion
protected CompositeCache parseRegion(java.util.Properties props,
java.lang.String regName,
java.lang.String value,
ICompositeCacheAttributes cca,
java.lang.String regionPrefix)
- Get all the properties for a region and configure its cache.
- Parameters:
props
- regName
- value
- cca
- regionPrefix
-
- Returns:
- CompositeCache
parseCompositeCacheAttributes
protected ICompositeCacheAttributes parseCompositeCacheAttributes(java.util.Properties props,
java.lang.String regName)
- Get an ICompositeCacheAttributes for the listed region.
- Parameters:
props
- regName
-
- Returns:
- ICompositeCacheAttributes
parseCompositeCacheAttributes
protected ICompositeCacheAttributes parseCompositeCacheAttributes(java.util.Properties props,
java.lang.String regName,
java.lang.String regionPrefix)
- Get the main attributes for a region.
- Parameters:
props
- regName
- regionPrefix
-
- Returns:
- ICompositeCacheAttributes
parseElementAttributes
protected IElementAttributes parseElementAttributes(java.util.Properties props,
java.lang.String regName,
java.lang.String regionPrefix)
- Create the element attributes from the properties object for a cache region.
- Parameters:
props
- regName
- regionPrefix
-
- Returns:
- IElementAttributes
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.
- Parameters:
cache
- the cache managerprops
- the configuration propertiesauxName
- the name of the auxiliary cacheregName
- the name of the region.
- Returns:
- AuxiliaryCache
parseKeyMatcher
public static IKeyMatcher parseKeyMatcher(java.util.Properties props,
java.lang.String auxPrefix)
- Creates a custom key matcher if one is defined. Else, it uses the default.
- Parameters:
props
- auxPrefix
- - ex. AUXILIARY_PREFIX + auxName
- Returns:
- IKeyMatcher
Copyright © 2002-2010 Apache Software Foundation. All Rights Reserved.