org.apache.jetspeed.administration

Interface PortalConfiguration

public interface PortalConfiguration

Retrieves configuration settings for all basic data types from the read only portal configuration. This configuration is usually a set of read only property files such as jetspeed.properties and override.properties.

Since:

2.1.2

Version:

$Id: $

Author:

David Sean Taylor

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getBoolean(String key) Retrieve a portal configuration setting
boolean	getBoolean(String key, boolean defaultValue) Retrieve a portal configuration setting
double	getDouble(String key) Retrieve a portal configuration setting
double	getDouble(String key, double defaultValue) Retrieve a portal configuration setting
float	getFloat(String key) Retrieve a portal configuration setting
float	getFloat(String key, float defaultValue) Retrieve a portal configuration setting
int	getInt(String key) Retrieve a portal configuration setting
int	getInt(String key, int defaultValue) Retrieve a portal configuration setting
Iterator<String>	getKeys() Retrieve an iterator over the keys of all portal configuration settings
List	getList(String key) Retrieve a list of multivalued portal configuration settings
long	getLong(String key) Retrieve a portal configuration setting
long	getLong(String key, long defaultValue) Retrieve a portal configuration setting
String	getString(String key) Retrieve a portal configuration setting
String	getString(String key, String defaultValue) Retrieve a portal configuration setting
String[]	getStringArray(String key) Retrieve the multivalued string array of portal configuration setting for a given key
void	setString(String key, String value) Set a non-persisted (runtime only) configuration setting value for a given key

Method Detail

getBoolean

boolean getBoolean(String key)

Retrieve a portal configuration setting

Parameters:

key - the name of the portal configuration setting

Returns:

the boolean representation of this setting

getBoolean

boolean getBoolean(String key,
                 boolean defaultValue)

Retrieve a portal configuration setting

Parameters:

key - the name of the portal configuration setting

defaultValue - if the property is not found, use this default value

Returns:

the boolean representation of this setting

getString

String getString(String key)

Retrieve a portal configuration setting

Parameters:

key - the name of the portal configuration setting

Returns:

the string representation of this setting

getString

String getString(String key,
               String defaultValue)

Retrieve a portal configuration setting

Parameters:

key - the name of the portal configuration setting

defaultValue - if the property is not found, use this default value

Returns:

the string representation of this setting

getDouble

double getDouble(String key)

Retrieve a portal configuration setting

Parameters:

key - the name of the portal configuration setting

Returns:

the double representation of this setting

getDouble

double getDouble(String key,
               double defaultValue)

Retrieve a portal configuration setting

Parameters:

key - the name of the portal configuration setting

defaultValue - if the property is not found, use this default value

Returns:

the double representation of this setting

getFloat

float getFloat(String key)

Retrieve a portal configuration setting

Parameters:

key - the name of the portal configuration setting

Returns:

the float representation of this setting

getFloat

float getFloat(String key,
             float defaultValue)

Retrieve a portal configuration setting

Parameters:

key - the name of the portal configuration setting

defaultValue - if the property is not found, use this default value

Returns:

the float representation of this setting

getInt

int getInt(String key)

Retrieve a portal configuration setting

Parameters:

key - the name of the portal configuration setting

Returns:

the integer representation of this setting

getInt

int getInt(String key,
         int defaultValue)

Retrieve a portal configuration setting

Parameters:

key - the name of the portal configuration setting

defaultValue - if the property is not found, use this default value

Returns:

the integer representation of this setting

getList

List getList(String key)

Retrieve a list of multivalued portal configuration settings

Parameters:

key - the name of the portal configuration setting

Returns:

the list of multivalued values for this setting

getLong

long getLong(String key)

Retrieve a portal configuration setting

Parameters:

key - the name of the portal configuration setting

Returns:

the long representation of this setting

getLong

long getLong(String key,
           long defaultValue)

Retrieve a portal configuration setting

Parameters:

key - the name of the portal configuration setting

defaultValue - if the property is not found, use this default value

Returns:

the long representation of this setting

getStringArray

String[] getStringArray(String key)

Retrieve the multivalued string array of portal configuration setting for a given key

Parameters:

key - the name of the portal configuration setting

Returns:

the string array multiple values for this setting key

getKeys

Iterator<String> getKeys()

Retrieve an iterator over the keys of all portal configuration settings

Returns:

an Iterator over the keys for all configuration settings

setString

void setString(String key,
             String value)

Set a non-persisted (runtime only) configuration setting value for a given key

Parameters:

key - the name of the portal configuration setting

value - the new value to override the existing value for this setting