Field Detail

• KEY_MATCHER_PREFIX

  public static final String KEY_MATCHER_PREFIX

  jcs.auxiliary.NAME.keymatcher=CLASSNAME

  jcs.auxiliary.NAME.keymatcher.attributes.CUSTOMPROPERTY=VALUE

  See Also:

  Constant Field Values

Constructor Detail

• CompositeCacheConfigurator

  public CompositeCacheConfigurator(CompositeCacheManager ccMgr)

  Constructor for the CompositeCacheConfigurator object

  Parameters:

  ccMgr -

Method Detail

• doConfigure

  protected void doConfigure(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(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(Properties props)

  Set the default aux list for new caches.

  Parameters:

  props -

• setDefaultCompositeCacheAttributes

  protected void setDefaultCompositeCacheAttributes(Properties props)

  Set the default CompositeCacheAttributes for new caches.

  Parameters:

  props -

• setDefaultElementAttributes

  protected void setDefaultElementAttributes(Properties props)

  Set the default ElementAttributes for new caches.

  Parameters:

  props -

• parseSystemRegions

  protected <K,V> void parseSystemRegions(Properties props)

  Create caches used internally. System status gives them creation priority.

  Parameters:

  props -

• parseRegions

  protected <K,V> void parseRegions(Properties props)

  Parse region elements.

  Parameters:

  props -

• parseRegion

  protected <K,V> CompositeCache<K,V> parseRegion(Properties props,
                                      String regName,
                                      String value)

  Create cache region.

  Parameters:

  props -

  regName -

  value -

  Returns:

  CompositeCache

• parseRegion

  protected <K,V> CompositeCache<K,V> parseRegion(Properties props,
                                      String regName,
                                      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 <K,V> CompositeCache<K,V> parseRegion(Properties props,
                                      String regName,
                                      String value,
                                      ICompositeCacheAttributes cca,
                                      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(Properties props,
                                                        String regName)

  Get an ICompositeCacheAttributes for the listed region.

  Parameters:

  props -

  regName -

  Returns:

  ICompositeCacheAttributes

• parseCompositeCacheAttributes

  protected ICompositeCacheAttributes parseCompositeCacheAttributes(Properties props,
                                                        String regName,
                                                        String regionPrefix)

  Get the main attributes for a region.

  Parameters:

  props -

  regName -

  regionPrefix -

  Returns:

  ICompositeCacheAttributes

• parseElementAttributes

  protected IElementAttributes parseElementAttributes(Properties props,
                                          String regName,
                                          String regionPrefix)

  Create the element attributes from the properties object for a cache region.

  Parameters:

  props -

  regName -

  regionPrefix -

  Returns:

  IElementAttributes

• parseAuxiliary

  protected <K,V> AuxiliaryCache<K,V> parseAuxiliary(Properties props,
                                         String auxName,
                                         String regName)

  Get an aux cache for the listed aux for a region.

  Parameters:

  props - the configuration properties

  auxName - the name of the auxiliary cache

  regName - the name of the region.

  Returns:

  AuxiliaryCache

• parseKeyMatcher

  public static <K> IKeyMatcher<K> parseKeyMatcher(Properties props,
                                   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