org.jahia.utils

Class PlaceholderUtils

java.lang.Object

org.jahia.utils.PlaceholderUtils

public class PlaceholderUtils
extends Object

Helper class for resolving placeholders in texts with values of DX settings.

Author:

Sergiy Shyrkov

Field Summary

Fields

Modifier and Type	Field and Description
static org.springframework.util.PropertyPlaceholderHelper	PLACEHOLDER_HELPER_STRICT

Constructor Summary

Constructors

Constructor and Description
PlaceholderUtils()

Method Summary

Modifier and Type	Method and Description
static InputStream	resolvePlaceholders(InputStream configInputStream, SettingsBean settingsBean, boolean ignoreUnresolvablePlaceholders) Resolve ${...} placeholders in the given configuration resource stream, replacing them with corresponding values from DX settings (SettingsBean) with a fallback to Java system properties.
static String	resolvePlaceholders(String text, SettingsBean settingsBean, boolean ignoreUnresolvablePlaceholders) Resolve ${...} placeholders in the given text, replacing them with corresponding values from DX settings (SettingsBean) with a fallback to Java system properties.

Methods inherited from class java.lang.Object

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

Field Detail

PLACEHOLDER_HELPER_STRICT

public static final org.springframework.util.PropertyPlaceholderHelper PLACEHOLDER_HELPER_STRICT

Constructor Detail

PlaceholderUtils

public PlaceholderUtils()

Method Detail

resolvePlaceholders

public static InputStream resolvePlaceholders(InputStream configInputStream,
                                              SettingsBean settingsBean,
                                              boolean ignoreUnresolvablePlaceholders)
                                       throws IOException

Resolve ${...} placeholders in the given configuration resource stream, replacing them with corresponding values from DX settings (SettingsBean) with a fallback to Java system properties. Unresolvable placeholders with no default value are ignored and passed through unchanged if the flag is set to true.

Parameters:

configInputStream - the configuration resource input stream to relpace plpaceholders in

settingsBean - the DX settings bean instance

ignoreUnresolvablePlaceholders - whether unresolved placeholders are to be ignored

Returns:

a new input stream of the configuration resource with placeholders replaced

Throws:

IOException - in case of an I/O errors

IllegalArgumentException - if there is an unresolvable placeholder and the "ignoreUnresolvablePlaceholders" flag is false

resolvePlaceholders

public static String resolvePlaceholders(String text,
                                         SettingsBean settingsBean,
                                         boolean ignoreUnresolvablePlaceholders)

Resolve ${...} placeholders in the given text, replacing them with corresponding values from DX settings (SettingsBean) with a fallback to Java system properties. Unresolvable placeholders with no default value are ignored and passed through unchanged if the flag is set to true.

Parameters:

text - the String to resolve

settingsBean - the DX settings bean instance

ignoreUnresolvablePlaceholders - whether unresolved placeholders are to be ignored

Returns:

the resolved String

Throws:

IllegalArgumentException - if there is an unresolvable placeholder and the "ignoreUnresolvablePlaceholders" flag is false