org.jahia.settings

Class JahiaPropertiesUtils

java.lang.Object

org.jahia.settings.JahiaPropertiesUtils

public class JahiaPropertiesUtils
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JahiaPropertiesUtils.RemoveOperation Remove operation to remove content from jahia.properties file Operation type are used to specify the nature of the operation: EXACT_BLOCK: accept multiple lines deletion and search for that exact lines in the file then remove them REGEXP_LINE: accept only one line deletion and search for the first line that match the regexp, then remove it

Field Summary

Fields

Modifier and Type	Field and Description
static Charset	CHARSET

Method Summary

Modifier and Type	Method and Description
static void	addEntry(String key, String value, String comment, String afterLinePattern, File jahiaPropertiesFile) Add the provided entry into the specified properties file.
static void	addEntry(String key, String value, String comment, String afterLinePattern, String error) Add the provided entry into the automatically detected jahia.properties file.
static File	detectJahiaPropertiesFile() Detects the location of a jahia.properties file.
static String	getCommentedPropertyLine(String key, List<String> lines)
static String	getPropertyLine(String key, List<String> lines)
static void	jahiaPropertiesFileNotFound()
static void	removeEntry(JahiaPropertiesUtils.RemoveOperation[] operations) Remove content from jahia.properties, look at the RemoveOperation class java doc to see all the possibility available
static void	replace(String searchString, String replacement) Replaces all occurrences of the specified string in the jahia.properties file with the provided replacement.
static void	uncommentOrAddEntryIfMissing(String key, String defaultValue) Set a property to its default value in case the property is missing from the java.properties file.

Methods inherited from class java.lang.Object

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

Field Detail

CHARSET

public static final Charset CHARSET

Method Detail

addEntry

public static final void addEntry(String key,
                                  String value,
                                  String comment,
                                  String afterLinePattern,
                                  File jahiaPropertiesFile)
                           throws IOException

Add the provided entry into the specified properties file.

Parameters:

key - the key to be added

value - the key value to be added

comment - the entry comment

afterLinePattern - the pattern of the line after which the entry should be added; null if the entry should be appended to the end of the file

jahiaPropertiesFile - the target properties file

Throws:

IOException - in case of an I/O error

removeEntry

public static void removeEntry(JahiaPropertiesUtils.RemoveOperation[] operations)
                        throws IOException

Remove content from jahia.properties, look at the RemoveOperation class java doc to see all the possibility available

Parameters:

operations - the remove operations

Throws:

IOException - in case of an I/O error

replace

public static void replace(String searchString,
                           String replacement)
                    throws IOException

Replaces all occurrences of the specified string in the jahia.properties file with the provided replacement.

Parameters:

searchString - the string to be replaced

replacement - the replacement

Throws:

IOException - in case of an I/O error

addEntry

public static final void addEntry(String key,
                                  String value,
                                  String comment,
                                  String afterLinePattern,
                                  String error)
                           throws IOException

Add the provided entry into the automatically detected jahia.properties file. If the jahia.properties location could not be detected, issues a warning.

Parameters:

key - the key to be added

value - the key value to be added

comment - the entry comment

afterLinePattern - the pattern of the line after which the entry should be added; null if the entry should be appended to the end of the file

Throws:

IOException - in case of an I/O error

uncommentOrAddEntryIfMissing

public static final void uncommentOrAddEntryIfMissing(String key,
                                                      String defaultValue)
                                               throws IOException

Set a property to its default value in case the property is missing from the java.properties file. Leave the file unchanged if the property is already set to any value. Un-comment the property instead of adding it in case it is already set to the default value but commented out.

Note, multiline property values are unsupported.

Parameters:

key - Property key

defaultValue - Default property value

Throws:

IOException

getPropertyLine

public static String getPropertyLine(String key,
                                     List<String> lines)

getCommentedPropertyLine

public static String getCommentedPropertyLine(String key,
                                              List<String> lines)

jahiaPropertiesFileNotFound

public static void jahiaPropertiesFileNotFound()

detectJahiaPropertiesFile

public static File detectJahiaPropertiesFile()
                                      throws IOException

Detects the location of a jahia.properties file.

Returns:

the detected location of a jahia.properties file or null if the file could not be found

Throws:

IOException - in case of an I/O error