org.apache.cocoon.core
Interface Settings

All Superinterfaces:
BaseSettings, DynamicSettings
All Known Implementing Classes:
MutableSettings

public interface Settings
extends BaseSettings, DynamicSettings

This object holds the global configuration of Cocoon.

Since:
2.2
Version:
$Id: Settings.java 312930 2005-10-11 18:13:35Z cziegeler $

Field Summary
 
Fields inherited from interface org.apache.cocoon.core.BaseSettings
DEFAULT_RUNNING_MODE, KEY_CACHE_DIRECTORY, KEY_CONFIGURATION, KEY_EXTRA_CLASSPATHS, KEY_FORCE_PROPERTIES, KEY_FORM_ENCODING, KEY_LOAD_CLASSES, KEY_LOGGING_BOOTSTRAP_LOGLEVEL, KEY_LOGGING_COCOON_LOGGER, KEY_LOGGING_CONFIGURATION, KEY_LOGGING_ENVIRONMENT_LOGGER, KEY_LOGGING_MANAGER_CLASS, KEY_LOGGING_OVERRIDE_LOGLEVEL, KEY_MANAGE_EXCEPTIONS, KEY_PARENT_SERVICE_MANAGER, KEY_PROPERTY_PROVIDER, KEY_UPLOADS_DIRECTORY, KEY_WORK_DIRECTORY, MANAGE_EXCEPTIONS, PROPERTY_RUNNING_MODE, PROPERTY_USER_SETTINGS
 
Fields inherited from interface org.apache.cocoon.core.DynamicSettings
ENABLE_UPLOADS, HIDE_SHOW_TIME, KEY_HIDE_SHOWTIME, KEY_LAZY_MODE, KEY_RELOAD_DELAY, KEY_RELOADING, KEY_SHOW_VERSION, KEY_SHOWTIME, KEY_UPLOADS_AUTOSAVE, KEY_UPLOADS_ENABLE, KEY_UPLOADS_MAXSIZE, KEY_UPLOADS_OVERWRITE, MAX_UPLOAD_SIZE, RELOADING_ENABLED_DEFAULT, SAVE_UPLOADS_TO_DISK, SHOW_COCOON_VERSION, SHOW_TIME
 
Method Summary
 List getProperties(String keyPrefix)
          Return all available properties starting with the prefix.
 String getProperty(String key)
          Get the value of a property.
 String getProperty(String key, String defaultValue)
          Get the value of a property.
 
Methods inherited from interface org.apache.cocoon.core.BaseSettings
getBootstrapLogLevel, getCacheDirectory, getCocoonLogger, getConfiguration, getCreationTime, getEnvironmentLogger, getExtraClasspaths, getForceProperties, getFormEncoding, getLoadClasses, getLoggerManagerClassName, getLoggingConfiguration, getOverrideLogLevel, getParentServiceManagerClassName, getPropertyProviders, getUploadDirectory, getWorkDirectory, isManageExceptions
 
Methods inherited from interface org.apache.cocoon.core.DynamicSettings
getMaxUploadSize, getOverwriteUploads, getReloadDelay, isAllowOverwrite, isAutosaveUploads, isEnableUploads, isHideShowTime, isLazyMode, isReloadingEnabled, isShowTime, isShowVersion, isSilentlyRename
 

Method Detail

getProperty

public String getProperty(String key)
Get the value of a property.

Parameters:
key - The name of the property.
Returns:
The value of the property or null.

getProperty

public String getProperty(String key,
                          String defaultValue)
Get the value of a property.

Parameters:
key - The name of the property.
defaultValue - The value returned if the property is not available.
Returns:
The value of the property or if the property cannot be found the default value.

getProperties

public List getProperties(String keyPrefix)
Return all available properties starting with the prefix.

Parameters:
keyPrefix - The prefix each property name must have.
Returns:
A list of property names (including the prefix) or an empty list.


Copyright ? 1999-2005 The Apache Software Foundation. All Rights Reserved.