org.apache.jetspeed.services.resources
Class JetspeedResources

java.lang.Object
  org.apache.turbine.services.resources.TurbineResources
      org.apache.jetspeed.services.resources.JetspeedResources

Direct Known Subclasses:

FusionResources

public class JetspeedResources

extends org.apache.turbine.services.resources.TurbineResources

This class defines the Jetspeed properties keys. All properties can be retrieved using TurbineResources or JetspeedResources directly. This class also overrides the covers for many of the get routines. It handles the cases where we want a single value, perhaps as a boolean or float, but the configuration may have an array of values. In these cases, we let the first value override all the others and use it.

Version:

$Id: JetspeedResources.java,v 1.22 2005/03/21 18:21:44 sgala Exp $

Author:

Kevin A. Burton, Raphaël Luta, Tom Adams, Chris Kimpton, Glenn R. Golden

Field Summary

static java.lang.String	ADMIN_PASSWORD_KEY
static java.lang.String	ADMIN_PORTLET_NAME_KEY
static java.lang.String	ADMIN_USERNAME_KEY
static java.lang.String	AUTOCREATE_PORTLETS_KEY
static java.lang.String	CACHE_DIRECTORY_KEY
static java.lang.String	CACHE_REQUIRE_CACHED_KEY
static java.lang.String	CHANGE_PASSWORD_TEMPLATE
static java.lang.String	CONFIGURATION_DIRECTORY_KEY
static java.lang.String	CONFIRM_VALUE
static java.lang.String	CONFIRM_VALUE_PENDING
static java.lang.String	CONFIRM_VALUE_REJECTED
static java.lang.String	CONTENT_ENCODING_KEY
static java.lang.String	CONTENT_PROVIDER_LIST_KEY
static java.lang.String	CONTENT_ROOT_URL_KEY
static java.lang.String	CONTENTFEEDS_FETCHALL_KEY
static java.lang.String	CONTENTFEEDS_PORTLETBROWSER_OVERVIEW_MAXPORTLETS_KEY
static java.lang.String	CONTENTFEEDS_PORTLETBROWSER_PREVIEW_MAXPORTLETS_KEY
static java.lang.String	CONTENTFEEDS_STYLESHEET_URL_KEY
static java.lang.String	CUSTOMIZATION_CANCEL_ACTION
static java.lang.String	CUSTOMIZATION_MAX_NUMBER
static java.lang.String	CUSTOMIZATION_RESOURCE_KEY
static java.lang.String	CUSTOMIZATION_SAVE_ACTION
static java.lang.String	DAEMON_ENTRY
static java.lang.String	DEFAULT_DCE_EXPIRATION_TIME_KEY
static java.lang.String	DEFAULT_DESCRIPTION_KEY
static java.lang.String	DEFAULT_IMAGE_KEY
static java.lang.String	DEFAULT_TITLE_KEY
static java.lang.String	DEFAULTPORTLETCONTROL_WIDTH_KEY
static java.lang.String	DEFAULTPORTLETCONTROLLER_NUMCOLUMNS_KEY
static java.lang.String	DEFAULTPORTLETCONTROLLER_WIDTH_KEY
static java.lang.String	EDIT_IMAGE
static java.lang.String	GROUP_BROWSER_CLIENT_SORTING
static java.lang.String	HTML_COLOR_NAME_KEY
static java.lang.String	HTML_HEX_COLOR_KEY
static java.lang.String	INFO_IMAGE
static java.lang.String	JETSPEED_CONFIG_KEY
static java.lang.String	JETSPEED_NAME_KEY
static java.lang.String	JETSPEED_VERSION_KEY
static java.lang.String	MANDATORY_PORTLET
static java.lang.String	MAX_IMAGE
static java.lang.String	NAVIGATIONS_BOTTOM_KEY
static java.lang.String	NAVIGATIONS_TOP_KEY
static java.lang.String	PATH_ACTION_KEY
static java.lang.String	PATH_PANEID_KEY
static java.lang.String	PATH_PANEL_KEY
static java.lang.String	PATH_PANENAME_KEY
static java.lang.String	PATH_PORTLET_KEY
static java.lang.String	PATH_PORTLETID_KEY
static java.lang.String	PATH_SCREEN_KEY
static java.lang.String	PATH_SUBPANE_SEPARATOR
static java.lang.String	PATH_TEMPLATE_KEY
static java.lang.String	PORTLETCONTROL_DEFAULT_CLASSNAME_KEY
static java.lang.String	PORTLETCONTROL_MAXIMIZED_CLASSNAME_KEY
static java.lang.String	PORTLETCONTROLLER_DEFAULT_CLASSNAME_KEY
static java.lang.String	PORTLETMARKUP_ALL_KEY
static java.lang.String	PROFILER_CONFIGURATION_KEY
static java.lang.String	PROFILER_DEFAULT_CLASSNAME_KEY
static java.lang.String	PSML_REGISTRY_URL_KEY
static java.lang.String	RESTORE_IMAGE
static java.lang.String	ROLE_BROWSER_CLIENT_SORTING
static java.lang.String	SITE_FOOTER_LOGO
static java.lang.String	SITE_FOOTER_LOGO_KEY
static java.lang.String	SITE_HEADER_LOGO
static java.lang.String	SITE_HEADER_LOGO_KEY
static java.lang.String	SITE_HEADER_WELCOME_KEY
static java.lang.String	SITE_STYLESHEET
static java.lang.String	SITE_WELCOME
static java.lang.String	SKIN_DEFAULT_KEY
static java.lang.String	TEMP_DIRECTORY_KEY
static java.lang.String	TIME_TO_LIVE Special portlet registry parameter used to override default portlet cache expiration value
static java.lang.String	TRANSPARENT_IMAGE
static java.lang.String	USER_BROWSER_CLIENT_SORTING
static java.lang.String	XMLPORTLETCONTROLLER_STYLESHEET_KEY
static java.lang.String	XMLPORTLETCONTROLLER_WIDTH_KEY

Fields inherited from class org.apache.turbine.services.resources.TurbineResources

ACTION_CACHE_SIZE_KEY, DB_DRIVER_KEY, DB_EXPIRYTIME_KEY, DB_IDBROKER_CLEVERQUANTITY, DB_IDBROKER_PREFETCH, DB_MAXCONNECTIONS_KEY, DB_PASSWORD_KEY, DB_URL_KEY, DB_USERNAME_KEY, FILE_SERVER, LAYOUT_CACHE_SIZE_KEY, LOGIN_ERROR, LOGIN_MESSAGE, LOGIN_MESSAGE_NOSCREEN, LOGOUT_MESSAGE, MAIL_SERVER_KEY, MAX_FILE_SIZE_KEY, MODULE_CACHE_KEY, MODULE_PACKAGES_KEY, NAVIGATION_CACHE_SIZE_KEY, PAGE_CACHE_SIZE_KEY, SCREEN_CACHE_SIZE_KEY, USER_CLASS_KEY

Constructor Summary

JetspeedResources()

Method Summary

static boolean	getBoolean(java.lang.String name) The purpose of this method is to get the configuration resource with the given name as a boolean value.
static boolean	getBoolean(java.lang.String name, boolean def) The purppose of this method is to get the configuration resource with the given name as a boolean value, or a default value.
static double	getDouble(java.lang.String name) The purpose of this method is to get the configuration resource with the given name as a double.
static double	getDouble(java.lang.String name, double def) The purpose of this method is to get the configuration resource with the given name as a double, or a default value.
static float	getFloat(java.lang.String name) The purpose of this method is to get the configuration resource with the given name as a float.
static float	getFloat(java.lang.String name, float def) The purpose of this method is to get the configuration resource with the given name as a float, or a default value.
static int	getInt(java.lang.String name) The purpose of this method is to get the configuration resource with the given name as an integer.
static int	getInt(java.lang.String name, int def) The purpose of this method is to get the configuration resource with the given name as an integer, or a default value.
static long	getLong(java.lang.String name) The purpose of this method is to get the configuration resource with the given name as a long.
static long	getLong(java.lang.String name, long def) The purpose of this method is to get the configuration resource with the given name as a long, or a default value.
static java.lang.String	getString(java.lang.String name) The purpose of this method is to get the configuration resource with the given name as a string.
static java.lang.String	getString(java.lang.String name, java.lang.String def) The purpose of this method is to get the configuration resource with the given name as a string, or a default value.

Methods inherited from class org.apache.turbine.services.resources.TurbineResources

getConfiguration, getConfiguration, getKeys, getKeys, getResources, getService, getStringArray, getVector, getVector, setProperty

Methods inherited from class java.lang.Object

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

Field Detail

SITE_HEADER_LOGO_KEY

public static final java.lang.String SITE_HEADER_LOGO_KEY

See Also:

Constant Field Values

SITE_HEADER_WELCOME_KEY

public static final java.lang.String SITE_HEADER_WELCOME_KEY

See Also:

Constant Field Values

SITE_FOOTER_LOGO_KEY

public static final java.lang.String SITE_FOOTER_LOGO_KEY

See Also:

Constant Field Values

PROFILER_DEFAULT_CLASSNAME_KEY

public static final java.lang.String PROFILER_DEFAULT_CLASSNAME_KEY

See Also:

Constant Field Values

PROFILER_CONFIGURATION_KEY

public static final java.lang.String PROFILER_CONFIGURATION_KEY

See Also:

Constant Field Values

SKIN_DEFAULT_KEY

public static final java.lang.String SKIN_DEFAULT_KEY

See Also:

Constant Field Values

PORTLETCONTROL_DEFAULT_CLASSNAME_KEY

public static final java.lang.String PORTLETCONTROL_DEFAULT_CLASSNAME_KEY

See Also:

Constant Field Values

PORTLETCONTROL_MAXIMIZED_CLASSNAME_KEY

public static final java.lang.String PORTLETCONTROL_MAXIMIZED_CLASSNAME_KEY

See Also:

Constant Field Values

PORTLETCONTROLLER_DEFAULT_CLASSNAME_KEY

public static final java.lang.String PORTLETCONTROLLER_DEFAULT_CLASSNAME_KEY

See Also:

Constant Field Values

CACHE_DIRECTORY_KEY

public static final java.lang.String CACHE_DIRECTORY_KEY

See Also:

Constant Field Values

CACHE_REQUIRE_CACHED_KEY

public static final java.lang.String CACHE_REQUIRE_CACHED_KEY

See Also:

Constant Field Values

DEFAULT_DCE_EXPIRATION_TIME_KEY

public static final java.lang.String DEFAULT_DCE_EXPIRATION_TIME_KEY

See Also:

Constant Field Values

DEFAULTPORTLETCONTROL_WIDTH_KEY

public static final java.lang.String DEFAULTPORTLETCONTROL_WIDTH_KEY

See Also:

Constant Field Values

DEFAULTPORTLETCONTROLLER_NUMCOLUMNS_KEY

public static final java.lang.String DEFAULTPORTLETCONTROLLER_NUMCOLUMNS_KEY

See Also:

Constant Field Values

DEFAULTPORTLETCONTROLLER_WIDTH_KEY

public static final java.lang.String DEFAULTPORTLETCONTROLLER_WIDTH_KEY

See Also:

Constant Field Values

XMLPORTLETCONTROLLER_WIDTH_KEY

public static final java.lang.String XMLPORTLETCONTROLLER_WIDTH_KEY

See Also:

Constant Field Values

XMLPORTLETCONTROLLER_STYLESHEET_KEY

public static final java.lang.String XMLPORTLETCONTROLLER_STYLESHEET_KEY

See Also:

Constant Field Values

PORTLETMARKUP_ALL_KEY

public static final java.lang.String PORTLETMARKUP_ALL_KEY

See Also:

Constant Field Values

CONTENTFEEDS_STYLESHEET_URL_KEY

public static final java.lang.String CONTENTFEEDS_STYLESHEET_URL_KEY

See Also:

Constant Field Values

CONTENTFEEDS_FETCHALL_KEY

public static final java.lang.String CONTENTFEEDS_FETCHALL_KEY

See Also:

Constant Field Values

CONTENTFEEDS_PORTLETBROWSER_PREVIEW_MAXPORTLETS_KEY

public static final java.lang.String CONTENTFEEDS_PORTLETBROWSER_PREVIEW_MAXPORTLETS_KEY

See Also:

Constant Field Values

CONTENTFEEDS_PORTLETBROWSER_OVERVIEW_MAXPORTLETS_KEY

public static final java.lang.String CONTENTFEEDS_PORTLETBROWSER_OVERVIEW_MAXPORTLETS_KEY

See Also:

Constant Field Values

GROUP_BROWSER_CLIENT_SORTING

public static final java.lang.String GROUP_BROWSER_CLIENT_SORTING

See Also:

Constant Field Values

ROLE_BROWSER_CLIENT_SORTING

public static final java.lang.String ROLE_BROWSER_CLIENT_SORTING

See Also:

Constant Field Values

USER_BROWSER_CLIENT_SORTING

public static final java.lang.String USER_BROWSER_CLIENT_SORTING

See Also:

Constant Field Values

CONFIGURATION_DIRECTORY_KEY

public static final java.lang.String CONFIGURATION_DIRECTORY_KEY

See Also:

Constant Field Values

CONTENT_ROOT_URL_KEY

public static final java.lang.String CONTENT_ROOT_URL_KEY

See Also:

Constant Field Values

TEMP_DIRECTORY_KEY

public static final java.lang.String TEMP_DIRECTORY_KEY

See Also:

Constant Field Values

ADMIN_PORTLET_NAME_KEY

public static final java.lang.String ADMIN_PORTLET_NAME_KEY

See Also:

Constant Field Values

ADMIN_USERNAME_KEY

public static final java.lang.String ADMIN_USERNAME_KEY

See Also:

Constant Field Values

ADMIN_PASSWORD_KEY

public static final java.lang.String ADMIN_PASSWORD_KEY

See Also:

Constant Field Values

DAEMON_ENTRY

public static final java.lang.String DAEMON_ENTRY

See Also:

Constant Field Values

PSML_REGISTRY_URL_KEY

public static final java.lang.String PSML_REGISTRY_URL_KEY

See Also:

Constant Field Values

NAVIGATIONS_TOP_KEY

public static final java.lang.String NAVIGATIONS_TOP_KEY

See Also:

Constant Field Values

NAVIGATIONS_BOTTOM_KEY

public static final java.lang.String NAVIGATIONS_BOTTOM_KEY

See Also:

Constant Field Values

AUTOCREATE_PORTLETS_KEY

public static final java.lang.String AUTOCREATE_PORTLETS_KEY

See Also:

Constant Field Values

CONTENT_PROVIDER_LIST_KEY

public static final java.lang.String CONTENT_PROVIDER_LIST_KEY

See Also:

Constant Field Values

DEFAULT_TITLE_KEY

public static final java.lang.String DEFAULT_TITLE_KEY

See Also:

Constant Field Values

DEFAULT_DESCRIPTION_KEY

public static final java.lang.String DEFAULT_DESCRIPTION_KEY

See Also:

Constant Field Values

DEFAULT_IMAGE_KEY

public static final java.lang.String DEFAULT_IMAGE_KEY

See Also:

Constant Field Values

JETSPEED_CONFIG_KEY

public static final java.lang.String JETSPEED_CONFIG_KEY

See Also:

Constant Field Values

CONTENT_ENCODING_KEY

public static final java.lang.String CONTENT_ENCODING_KEY

See Also:

Constant Field Values

CUSTOMIZATION_RESOURCE_KEY

public static final java.lang.String CUSTOMIZATION_RESOURCE_KEY

See Also:

Constant Field Values

CUSTOMIZATION_MAX_NUMBER

public static final java.lang.String CUSTOMIZATION_MAX_NUMBER

See Also:

Constant Field Values

CUSTOMIZATION_SAVE_ACTION

public static final java.lang.String CUSTOMIZATION_SAVE_ACTION

See Also:

Constant Field Values

CUSTOMIZATION_CANCEL_ACTION

public static final java.lang.String CUSTOMIZATION_CANCEL_ACTION

See Also:

Constant Field Values

HTML_HEX_COLOR_KEY

public static final java.lang.String HTML_HEX_COLOR_KEY

See Also:

Constant Field Values

HTML_COLOR_NAME_KEY

public static final java.lang.String HTML_COLOR_NAME_KEY

See Also:

Constant Field Values

MANDATORY_PORTLET

public static final java.lang.String MANDATORY_PORTLET

See Also:

Constant Field Values

CHANGE_PASSWORD_TEMPLATE

public static final java.lang.String CHANGE_PASSWORD_TEMPLATE

See Also:

Constant Field Values

MAX_IMAGE

public static final java.lang.String MAX_IMAGE

INFO_IMAGE

public static final java.lang.String INFO_IMAGE

EDIT_IMAGE

public static final java.lang.String EDIT_IMAGE

TRANSPARENT_IMAGE

public static final java.lang.String TRANSPARENT_IMAGE

RESTORE_IMAGE

public static final java.lang.String RESTORE_IMAGE

SITE_HEADER_LOGO

public static final java.lang.String SITE_HEADER_LOGO

SITE_FOOTER_LOGO

public static final java.lang.String SITE_FOOTER_LOGO

SITE_WELCOME

public static final java.lang.String SITE_WELCOME

SITE_STYLESHEET

public static final java.lang.String SITE_STYLESHEET

CONFIRM_VALUE

public static final java.lang.String CONFIRM_VALUE

See Also:

Constant Field Values

CONFIRM_VALUE_PENDING

public static final java.lang.String CONFIRM_VALUE_PENDING

See Also:

Constant Field Values

CONFIRM_VALUE_REJECTED

public static final java.lang.String CONFIRM_VALUE_REJECTED

See Also:

Constant Field Values

PATH_ACTION_KEY

public static final java.lang.String PATH_ACTION_KEY

See Also:

Constant Field Values

PATH_PANEID_KEY

public static final java.lang.String PATH_PANEID_KEY

See Also:

Constant Field Values

PATH_PANENAME_KEY

public static final java.lang.String PATH_PANENAME_KEY

See Also:

Constant Field Values

PATH_PORTLETID_KEY

public static final java.lang.String PATH_PORTLETID_KEY

See Also:

Constant Field Values

PATH_SCREEN_KEY

public static final java.lang.String PATH_SCREEN_KEY

See Also:

Constant Field Values

PATH_TEMPLATE_KEY

public static final java.lang.String PATH_TEMPLATE_KEY

See Also:

Constant Field Values

PATH_PORTLET_KEY

public static final java.lang.String PATH_PORTLET_KEY

See Also:

Constant Field Values

PATH_SUBPANE_SEPARATOR

public static final java.lang.String PATH_SUBPANE_SEPARATOR

See Also:

Constant Field Values

JETSPEED_NAME_KEY

public static final java.lang.String JETSPEED_NAME_KEY

See Also:

Constant Field Values

JETSPEED_VERSION_KEY

public static final java.lang.String JETSPEED_VERSION_KEY

See Also:

Constant Field Values

TIME_TO_LIVE

public static final java.lang.String TIME_TO_LIVE

Special portlet registry parameter used to override default portlet cache expiration value

See Also:

Constant Field Values

PATH_PANEL_KEY

public static final java.lang.String PATH_PANEL_KEY

See Also:

Constant Field Values

Constructor Detail

JetspeedResources

public JetspeedResources()

Method Detail

getBoolean

public static boolean getBoolean(java.lang.String name)

The purpose of this method is to get the configuration resource with the given name as a boolean value.

Parameters:

name - The resource name.

Returns:

The value of the named resource as a boolean.

getBoolean

public static boolean getBoolean(java.lang.String name,
                                 boolean def)

The purppose of this method is to get the configuration resource with the given name as a boolean value, or a default value.

Parameters:

name - The resource name.

def - The default value of the resource.

Returns:

The value of the named resource as a boolean.

getDouble

public static double getDouble(java.lang.String name)

The purpose of this method is to get the configuration resource with the given name as a double.

Parameters:

name - The resoource name.

Returns:

The value of the named resource as double.

getDouble

public static double getDouble(java.lang.String name,
                               double def)

The purpose of this method is to get the configuration resource with the given name as a double, or a default value.

Parameters:

name - The resource name.

def - The default value of the resource.

Returns:

The value of the named resource as a double.

getFloat

public static float getFloat(java.lang.String name)

The purpose of this method is to get the configuration resource with the given name as a float.

Parameters:

name - The resource name.

Returns:

The value of the resource as a float.

getFloat

public static float getFloat(java.lang.String name,
                             float def)

The purpose of this method is to get the configuration resource with the given name as a float, or a default value.

Parameters:

name - The resource name.

def - The default value of the resource.

Returns:

The value of the resource as a float.

getInt

public static int getInt(java.lang.String name)

The purpose of this method is to get the configuration resource with the given name as an integer.

Parameters:

name - The resource name.

Returns:

The value of the resource as an integer.

getInt

public static int getInt(java.lang.String name,
                         int def)

The purpose of this method is to get the configuration resource with the given name as an integer, or a default value.

Parameters:

name - The resource name.

def - The default value of the resource.

Returns:

The value of the resource as an integer.

getLong

public static long getLong(java.lang.String name)

The purpose of this method is to get the configuration resource with the given name as a long.

Parameters:

name - The resource name.

Returns:

The value of the resource as a long.

getLong

public static long getLong(java.lang.String name,
                           long def)

The purpose of this method is to get the configuration resource with the given name as a long, or a default value.

Parameters:

name - The resource name.

def - The default value of the resource.

Returns:

The value of the resource as a long.

getString

public static java.lang.String getString(java.lang.String name)

The purpose of this method is to get the configuration resource with the given name as a string.

Parameters:

name - The resource name.

Returns:

The value of the resource as a string.

getString

public static java.lang.String getString(java.lang.String name,
                                         java.lang.String def)

The purpose of this method is to get the configuration resource with the given name as a string, or a default value.

Parameters:

name - The resource name.

def - The default value of the resource.

Returns:

The value of the resource as a string.