com.saperion.ngc.util

Class ConfigurationUtil

java.lang.Object

com.saperion.ngc.util.ConfigurationUtil

All Implemented Interfaces:

Serializable

public final class ConfigurationUtil
extends Object
implements Serializable

Utility class used to load configuration parameters from webclient configuration.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
static String	externalGetWebConfig(javax.servlet.http.HttpSession session, String paramName) Read string from WebContent web.xml context-param parameter values.
static int	externalGetWebConfigInt(javax.servlet.http.HttpSession session, String paramName, int defaultValue) Read integer from WebContent web.xml context-param parameter values.
static String	getContextPath() Get Context Path.
static String	getHost() Get Host.
static String	getWebConfig(String paramName) Read string from WebContent web.xml context-param parameter values.
static String	getWebConfig(String paramName, String defaultValue) Read string from WebContent web.xml context-parameter values.
static boolean	getWebConfigBoolean(String paramName) Read boolean from WebContent web.xml context-param parameter values.
static boolean	getWebConfigBoolean(String paramName, boolean defaultValue) Read boolean from WebContent web.xml context-param parameter values.
static int	getWebConfigInt(String paramName) Read the int value of a context-param from the web.xml.
static int	getWebConfigInt(String paramName, int defaultValue) Read the int value of a context-param from the web.xml.

Methods inherited from class java.lang.Object

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

Method Detail

getWebConfig

public static String getWebConfig(String paramName)

Read string from WebContent web.xml context-param parameter values.

Parameters:

paramName - param-name

Returns:

param-value or null if the corresponding value does not exist.

getWebConfig

public static String getWebConfig(String paramName,
                                  String defaultValue)

Read string from WebContent web.xml context-parameter values. If no context-parameter with the given paramName exists, the given defaultValue is returned.

Parameters:

paramName - The name of the context-parameter to get the value from.

defaultValue - The returned default value, if no context-paramter exists by the given name.

Returns:

The context-param value or the default value.

externalGetWebConfig

public static String externalGetWebConfig(javax.servlet.http.HttpSession session,
                                          String paramName)

Read string from WebContent web.xml context-param parameter values. Can be called from without ZK context (JSPs...).

Parameters:

session - the session

paramName - the param name

Returns:

param-value or null if the corresponding value does not exist.

externalGetWebConfigInt

public static int externalGetWebConfigInt(javax.servlet.http.HttpSession session,
                                          String paramName,
                                          int defaultValue)

Read integer from WebContent web.xml context-param parameter values. Can be called from without ZK context (JSPs...).

Parameters:

session - the session

paramName - the param name

defaultValue - the default value to return if context parameter does not exist

Returns:

param-value or the specified defaultValue if the corresponding value does not exist.

getContextPath

public static String getContextPath()

Get Context Path.

Returns:

contextPath

getHost

public static String getHost()

Get Host.

Returns:

host

getWebConfigBoolean

public static boolean getWebConfigBoolean(String paramName)

Read boolean from WebContent web.xml context-param parameter values.

Parameters:

paramName - param-name

Returns:

param-value

getWebConfigBoolean

public static boolean getWebConfigBoolean(String paramName,
                                          boolean defaultValue)

Read boolean from WebContent web.xml context-param parameter values. Returns the defaultValue if no context-param by the given paramName exists.

Parameters:

paramName - parameter name

defaultValue - default value

Returns:

param-value as boolean or defaultValue if context-param does not exist.

getWebConfigInt

public static int getWebConfigInt(String paramName)

Read the int value of a context-param from the web.xml.

Parameters:

paramName - name of the param to get the int value of.

Returns:

int value of the given param-name. If a NumberFormatException is thrown this method returns -1.

getWebConfigInt

public static int getWebConfigInt(String paramName,
                                  int defaultValue)

Read the int value of a context-param from the web.xml. Returns the default value if the context parameter for the setting does not exist.

Parameters:

paramName - name of the param to get the int value of.

defaultValue - default value

Returns:

int value of the given param-name. If a NumberFormatException is thrown this method returns -1.