fr.paris.lutece.portal.service.util

Class AppPropertiesService

java.lang.Object

fr.paris.lutece.portal.service.util.AppPropertiesService

public final class AppPropertiesService
extends Object

this class provides management services for properties files

Method Summary

Modifier and Type	Method and Description
static List<String>	getKeys(String strPrefix) Returns a list of keys that match a given prefix.
static Properties	getProperties() Gets properties
static Map<String,String>	getPropertiesAsMap() Gets all properties as a Map
static String	getProperty(String strProperty) Returns the value of a variable defined in the .properties file of the application as a String
static String	getProperty(String strProperty, String strDefault) Returns the value of a variable defined in the .properties file of the application as a String
static boolean	getPropertyBoolean(String strProperty, boolean bDefault) Returns the value of a variable defined in the .properties file of the application as a boolean
static int	getPropertyInt(String strProperty, int nDefault) Returns the value of a variable defined in the .properties file of the application as an int
static long	getPropertyLong(String strProperty, long lDefault) Returns the value of a variable defined in the .properties file of the application as an long
static void	init(String strConfPath) Initializes the service
static void	reload(String strFilename) Reloads a given properties file
static void	reloadAll() Reloads all the properties files

Methods inherited from class java.lang.Object

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

Method Detail

init

public static void init(String strConfPath)

Initializes the service

Parameters:

strConfPath - The configuration path

getProperty

public static String getProperty(String strProperty)

Returns the value of a variable defined in the .properties file of the application as a String

Parameters:

strProperty - The variable name

Returns:

The variable value read in the properties file

getProperty

public static String getProperty(String strProperty,
                                 String strDefault)

Returns the value of a variable defined in the .properties file of the application as a String

Parameters:

strProperty - The variable name

strDefault - The default value which is returned if no value is found for the variable in the .properties file.

Returns:

The variable value read in the properties file

getPropertyInt

public static int getPropertyInt(String strProperty,
                                 int nDefault)

Returns the value of a variable defined in the .properties file of the application as an int

Parameters:

strProperty - The variable name

nDefault - The default value which is returned if no value is found for the variable in the le downloadFile .properties. .properties file.

Returns:

The variable value read in the properties file

getPropertyLong

public static long getPropertyLong(String strProperty,
                                   long lDefault)

Returns the value of a variable defined in the .properties file of the application as an long

Parameters:

strProperty - The variable name

lDefault - The default value which is returned if no value is found for the variable in the le downloadFile .properties. .properties file.

Returns:

The variable value read in the properties file

getPropertyBoolean

public static boolean getPropertyBoolean(String strProperty,
                                         boolean bDefault)

Returns the value of a variable defined in the .properties file of the application as a boolean

Parameters:

strProperty - The variable name

bDefault - The default value which is returned if no value is found for the variable in the le downloadFile .properties. .properties file.

Returns:

The variable value read in the properties file

reloadAll

public static void reloadAll()

Reloads all the properties files

reload

public static void reload(String strFilename)

Reloads a given properties file

Parameters:

strFilename - The file name

getProperties

public static Properties getProperties()

Gets properties

Returns:

All properties

Since:

version 3.0

getPropertiesAsMap

public static Map<String,String> getPropertiesAsMap()

Gets all properties as a Map

Returns:

a Map of all properties

Since:

version 5.0

getKeys

public static List<String> getKeys(String strPrefix)

Returns a list of keys that match a given prefix.

Parameters:

strPrefix - the str prefix

Returns:

A list of keys that match the prefix

Since:

version 3.0