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

Class SystemPropertyPreprocessor

java.lang.Object

com.tangosol.coherence.config.xml.preprocessor.SystemPropertyPreprocessor

All Implemented Interfaces:

DocumentElementPreprocessor.ElementPreprocessor

public class SystemPropertyPreprocessor
extends Object
implements DocumentElementPreprocessor.ElementPreprocessor

A SystemPropertyPreprocessor is an DocumentElementPreprocessor.ElementPreprocessor that will replace XmlElement content annotated with "system-property" attributes with appropriate System.getProperties().

The element's value is processed for macro expansion. The macro syntax is ${system-property default-value}. Thus, a value of near-${coherence.client direct} can be macro expanded by default to near-direct. If system property coherence.client is set to remote, then the value would be expanded to near-remote.

Since:

Coherence 12.1.2

Author:

bo 2011.08.03

Field Summary

Fields

Modifier and Type	Field	Description
static SystemPropertyPreprocessor	INSTANCE	This singleton instance of the SystemPropertyPreprocessor.

Constructor Summary

Constructors

Constructor	Description
SystemPropertyPreprocessor()

Method Summary

Modifier and Type	Method	Description
boolean	preprocess(ProcessingContext context, XmlElement element)	Process an XmlElement, optionally mutating it (or it's children) if required.
static boolean	processValueMacro(XmlElement element)	Process macros embedded in element's value
static boolean	processValueMacro(XmlElement element, ParameterResolver resolver)	Process macros embedded in element's value

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final SystemPropertyPreprocessor INSTANCE

This singleton instance of the SystemPropertyPreprocessor.

Constructor Detail

SystemPropertyPreprocessor

public SystemPropertyPreprocessor()

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)

processValueMacro

public static boolean processValueMacro(XmlElement element)

Process macros embedded in element's value

Parameters:

element - the XmlElement to preprocess

Returns:

true iff the String value of element was macro expanded

processValueMacro

public static boolean processValueMacro(XmlElement element,
                                        ParameterResolver resolver)

Process macros embedded in element's value

Parameters:

element - the XmlElement to preprocess

resolver - the ParameterResolver to use to resolve macro values

Returns:

true iff the String value of element was macro expanded