Package com.tangosol.coherence.config.xml.preprocessor

Class CacheDefaultsPreprocessor

java.lang.Object

com.tangosol.coherence.config.xml.preprocessor.CacheDefaultsPreprocessor

All Implemented Interfaces:

DocumentElementPreprocessor.ElementPreprocessor

public class CacheDefaultsPreprocessor
extends Object
implements DocumentElementPreprocessor.ElementPreprocessor

A CacheDefaultsPreprocessor is an DocumentElementPreprocessor.ElementPreprocessor that introduces (via cloning) default xml content for xml elements where the said content is missing.

Ultimately this DocumentElementPreprocessor.ElementPreprocessor is designed to perform pre-processing of Coherence Cache <defaults> declarations, inserting them into the appropriate places in cache-config.xml documents.

Since:

Coherence 12.1.2

Author:

bo 2011.12.16

See Also:

OperationalDefaultsPreprocessor

Constructor Summary

Constructors

Constructor	Description
CacheDefaultsPreprocessor(String sDefaultsParentPath)	Constructs a CacheDefaultsPreprocessor with a specific path to where default element content can be located.

Method Summary

Modifier and Type	Method	Description
void	addDefaultDefinition(String sRequiredElementParentPath, String sRequiredElementName)	Adds a requirement that the specified "default" element must be added to (if not already defined) in the element specified by the defined parent path.
boolean	preprocess(ProcessingContext context, XmlElement element)	Process an XmlElement, optionally mutating it (or it's children) if required.

Methods inherited from class java.lang.Object

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

Constructor Detail

CacheDefaultsPreprocessor

public CacheDefaultsPreprocessor(String sDefaultsParentPath)

Constructs a CacheDefaultsPreprocessor with a specific path to where default element content can be located.

Example: new DefaultPreprocessor("/defaults");

Parameters:

sDefaultsParentPath - the absolute path to the XmlElement that contains (is the parent of) the default elements

Method Detail

preprocess

public boolean preprocess(ProcessingContext context,
                          XmlElement element)
                   throws ConfigurationException

Process an XmlElement, optionally mutating it (or it's children) if required.

Note: An implementation of this interface should avoid attempting to traverse child XmlElements. If you wish to manually traverse or change the entire document, you should instead use a DocumentPreprocessor.

Specified by:

preprocess in interface DocumentElementPreprocessor.ElementPreprocessor

Parameters:

context - the ProcessingContext in which the pre-processing is occurring

element - the XmlElement to preprocess

Returns:

true if the specified XmlElement should be re-preprocessed by this and other DocumentElementPreprocessor.ElementPreprocessors due to the XmlElement being modified, false otherwise.

Throws:

ConfigurationException - if during pre-processing of the XmlElement a configuration issue was discovered (or if pre-processing fails for some reason)

addDefaultDefinition

public void addDefaultDefinition(String sRequiredElementParentPath,
                                 String sRequiredElementName)

Adds a requirement that the specified "default" element must be added to (if not already defined) in the element specified by the defined parent path.

Paths used by this method are based those defined by the XmlHelper.findElement(XmlElement, String) method, with the exception that ".." is not supported.

For example 1: The following call specifies that the "serializer" should be cloned from the defined default path if it doesn't exist in the "/caching-schemes/distributed-scheme" element.

addDefaultDefinition("/caching-schemes/distributed-scheme", "serializer");

For example 2: The following call specifies that the "serializer" should be cloned from the defined default path if it doesn't exist in any "distributed-scheme" elements

addDefaultDefinition("distributed-scheme", "serializer");

Parameters:

sRequiredElementParentPath - the path of the parent for the required element

sRequiredElementName - the name of the element that should be cloned (if it doesn't exist in the specified parent path) from the defined default element path