Skip navigation links

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 java.lang.Object

implements DocumentElementPreprocessor.ElementPreprocessor

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

Since:

Coherence 12.1.2

Author:

bo 2011.08.03

Field Summary

static SystemPropertyPreprocessor

INSTANCE This singleton instance of the SystemPropertyPreprocessor.

Constructor Summary

SystemPropertyPreprocessor(java.util.Properties properties)
Constructs a SystemPropertyPreprocessor with the specified Properties.

Method Summary

boolean

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

Field Detail

INSTANCE

public static final SystemPropertyPreprocessor INSTANCE

This singleton instance of the SystemPropertyPreprocessor.

Constructor Detail

SystemPropertyPreprocessor

public SystemPropertyPreprocessor(java.util.Properties properties)

Constructs a SystemPropertyPreprocessor with the specified Properties.

Parameters:

properties - the Properties to use for replacing "system-property" attributes

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 occuring

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)

Skip navigation links