Keycloak Common 24.0.0 · org.keycloak.common.util.StringPropertyReplacer

Modifier and Type	Class and Description
public static interface	StringPropertyReplacer.PropertyResolver

Field Summary

Modifier and Type	Field and Description
private static final String	FILE_SEPARATOR File separator value
private static final String	FILE_SEPARATOR_ALIAS File separator alias
private static final int	IN_BRACKET
public static final String	NEWLINE New line string constant
private static final int	NORMAL
private static final String	PATH_SEPARATOR Path separator value
private static final String	PATH_SEPARATOR_ALIAS Path separator alias
private static final int	SEEN_DOLLAR
private static final Properties	systemEnvProperties

Constructor Summary

Access	Constructor and Description
public	StringPropertyReplacer()

Method Summary

Modifier and Type	Method and Description
public static String	Returns: the input string with all property references replaced if any. If there are no valid references the input string will be returned. replaceProperties(final String - the string with possible ${} references string) Go through the input string and replace any occurance of ${p} with the System.getProperty(p) value.
public static String	Returns: the input string with all property references replaced if any. If there are no valid references the input string will be returned. replaceProperties(final String - the string with possible ${} references string, final Properties - the source for ${x} property ref values, null means use System.getProperty() props) Go through the input string and replace any occurance of ${p} with the props.getProperty(p) value.
public static String	replaceProperties(final String string, StringPropertyReplacer.PropertyResolver resolver)
private static String	Returns: the resolved key or null resolveCompositeKey(String the key to resolve key, final Properties the properties to use props) Try to resolve a "key" from the provided properties by checking if it is actually a "key1,key2", in which case try first "key1", then "key2".
private static String	resolveCompositeKey(String key, StringPropertyReplacer.PropertyResolver resolver)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

FILE_SEPARATOR	back to summary
private static final String FILE_SEPARATOR File separator value

FILE_SEPARATOR_ALIAS	back to summary
private static final String FILE_SEPARATOR_ALIAS File separator alias

IN_BRACKET	back to summary
private static final int IN_BRACKET

NEWLINE	back to summary
public static final String NEWLINE New line string constant

NORMAL	back to summary
private static final int NORMAL

PATH_SEPARATOR	back to summary
private static final String PATH_SEPARATOR Path separator value

PATH_SEPARATOR_ALIAS	back to summary
private static final String PATH_SEPARATOR_ALIAS Path separator alias

SEEN_DOLLAR	back to summary
private static final int SEEN_DOLLAR

systemEnvProperties	back to summary
private static final Properties systemEnvProperties

Constructor Detail

StringPropertyReplacer	back to summary
public StringPropertyReplacer()

Method Detail

replaceProperties	back to summary
public static String replaceProperties(final String string) Go through the input string and replace any occurance of ${p} with the System.getProperty(p) value. If there is no such property p defined, then the ${p} reference will remain unchanged. If the property reference is of the form ${p:v} and there is no such property p, then the default value v will be returned. If the property reference is of the form ${p1,p2} or ${p1,p2:v} then the primary and the secondary properties will be tried in turn, before returning either the unchanged input, or the default value. The property ${/} is replaced with System.getProperty("file.separator") value and the property ${:} is replaced with System.getProperty("path.separator"). Parameters string:String - the string with possible ${} references Returns:String the input string with all property references replaced if any. If there are no valid references the input string will be returned.

replaceProperties

back to summary

public static String replaceProperties(final String string)

Go through the input string and replace any occurance of ${p} with the System.getProperty(p) value. If there is no such property p defined, then the ${p} reference will remain unchanged. If the property reference is of the form ${p:v} and there is no such property p, then the default value v will be returned. If the property reference is of the form ${p1,p2} or ${p1,p2:v} then the primary and the secondary properties will be tried in turn, before returning either the unchanged input, or the default value. The property ${/} is replaced with System.getProperty("file.separator") value and the property ${:} is replaced with System.getProperty("path.separator").

Parameters

string:String: - the string with possible ${} references

Returns:String

the input string with all property references replaced if any. If there are no valid references the input string will be returned.

replaceProperties	back to summary
public static String replaceProperties(final String string, final Properties props) Go through the input string and replace any occurance of ${p} with the props.getProperty(p) value. If there is no such property p defined, then the ${p} reference will remain unchanged. If the property reference is of the form ${p:v} and there is no such property p, then the default value v will be returned. If the property reference is of the form ${p1,p2} or ${p1,p2:v} then the primary and the secondary properties will be tried in turn, before returning either the unchanged input, or the default value. The property ${/} is replaced with System.getProperty("file.separator") value and the property ${:} is replaced with System.getProperty("path.separator"). Parameters string:String - the string with possible ${} references props:Properties - the source for ${x} property ref values, null means use System.getProperty() Returns:String the input string with all property references replaced if any. If there are no valid references the input string will be returned.

replaceProperties

back to summary

public static String replaceProperties(final String string, final Properties props)

Go through the input string and replace any occurance of ${p} with the props.getProperty(p) value. If there is no such property p defined, then the ${p} reference will remain unchanged. If the property reference is of the form ${p:v} and there is no such property p, then the default value v will be returned. If the property reference is of the form ${p1,p2} or ${p1,p2:v} then the primary and the secondary properties will be tried in turn, before returning either the unchanged input, or the default value. The property ${/} is replaced with System.getProperty("file.separator") value and the property ${:} is replaced with System.getProperty("path.separator").

Parameters

string:String: - the string with possible ${} references
props:Properties: - the source for ${x} property ref values, null means use System.getProperty()

Returns:String

the input string with all property references replaced if any. If there are no valid references the input string will be returned.

replaceProperties	back to summary
public static String replaceProperties(final String string, StringPropertyReplacer.PropertyResolver resolver)

resolveCompositeKey	back to summary
private static String resolveCompositeKey(String key, final Properties props) Try to resolve a "key" from the provided properties by checking if it is actually a "key1,key2", in which case try first "key1", then "key2". If all fails, return null. It also accepts "key1," and ",key2". Parameters key:String the key to resolve props:Properties the properties to use Returns:String the resolved key or null

resolveCompositeKey

back to summary

private static String resolveCompositeKey(String key, final Properties props)

Try to resolve a "key" from the provided properties by checking if it is actually a "key1,key2", in which case try first "key1", then "key2". If all fails, return null. It also accepts "key1," and ",key2".

Parameters

key:String: the key to resolve
props:Properties: the properties to use

Returns:String

the resolved key or null

resolveCompositeKey	back to summary
private static String resolveCompositeKey(String key, StringPropertyReplacer.PropertyResolver resolver)

public final Class StringPropertyReplacer

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface StringPropertyReplacer.PropertyResolver

Method Summary

Method Detail