org.apache.cocoon.core
Interface BaseSettings

All Known Subinterfaces:
Settings
All Known Implementing Classes:
MutableSettings

public interface BaseSettings

The settings (configuration) for the Cocoon core are described through the BaseSettings interface and the DynamicSettings interface. Whereas the settings of the BaseSettings object can't be changed at runtime, the settings of the DynamicSettings object are mutable. Use the Core instance to update the settings.

Since:
2.2
Version:
$Id: BaseSettings.java 312637 2005-10-10 13:00:42Z cziegeler $

Field Summary
static String DEFAULT_RUNNING_MODE
          The default running mode.
static String KEY_CACHE_DIRECTORY
          This parameter allows to specify where Cocoon should create its page and other objects cache.
static String KEY_CONFIGURATION
          This parameter points to the main configuration file for Cocoon.
static String KEY_EXTRA_CLASSPATHS
          This parameter allows to specify additional directories or jars which Cocoon should put into it's own classpath.
static String KEY_FORCE_PROPERTIES
          This parameter allows to set system properties
static String KEY_FORM_ENCODING
          Set form encoding.
static String KEY_LOAD_CLASSES
          This parameter is used to list classes that should be loaded at initialization time of the servlet.
static String KEY_LOGGING_BOOTSTRAP_LOGLEVEL
          This parameter indicates the log level to use throughout startup of the system.
static String KEY_LOGGING_COCOON_LOGGER
          This parameter indicates the category id of the logger from the LogKit management configuration for the Cocoon engine.
static String KEY_LOGGING_CONFIGURATION
          This parameter indicates the configuration file of the LogKit management
static String KEY_LOGGING_ENVIRONMENT_LOGGER
          This parameter indicates the category id of the logger from the LogKit configuration used by the environment.
static String KEY_LOGGING_MANAGER_CLASS
          This parameter switches the logging system from LogKit to Log4J for Cocoon.
static String KEY_LOGGING_OVERRIDE_LOGLEVEL
          If this value is specified, it will be interpreted as a log level and all logging categories will be set to this level regardless of their definition in the logging configuration.
static String KEY_MANAGE_EXCEPTIONS
          If true or not set, this class will try to catch and handle all Cocoon exceptions.
static String KEY_PARENT_SERVICE_MANAGER
          This parameter allows you to select the parent service manager.
static String KEY_PROPERTY_PROVIDER
          This key allows to add own PropertyProviders.
static String KEY_UPLOADS_DIRECTORY
          This parameter allows to specify where Cocoon should put uploaded files.
static String KEY_WORK_DIRECTORY
          This parameter allows to specify where Cocoon should put it's working files.
static boolean MANAGE_EXCEPTIONS
          Default value for isManageExceptions().
static String PROPERTY_RUNNING_MODE
          Name of the property specifying the running mode.
static String PROPERTY_USER_SETTINGS
          Name of the property specifying a custom user properties file.
 
Method Summary
 String getBootstrapLogLevel()
           
 String getCacheDirectory()
           
 String getCocoonLogger()
           
 String getConfiguration()
           
 long getCreationTime()
          The creation time of the current Cocoon instance.
 String getEnvironmentLogger()
           
 List getExtraClasspaths()
           
 Map getForceProperties()
           
 String getFormEncoding()
           
 List getLoadClasses()
           
 String getLoggerManagerClassName()
           
 String getLoggingConfiguration()
           
 String getOverrideLogLevel()
           
 String getParentServiceManagerClassName()
           
 List getPropertyProviders()
           
 String getUploadDirectory()
           
 String getWorkDirectory()
           
 boolean isManageExceptions()
           
 

Field Detail

MANAGE_EXCEPTIONS

public static final boolean MANAGE_EXCEPTIONS
Default value for isManageExceptions().

See Also:
Constant Field Values

PROPERTY_USER_SETTINGS

public static final String PROPERTY_USER_SETTINGS
Name of the property specifying a custom user properties file.

See Also:
Constant Field Values

PROPERTY_RUNNING_MODE

public static final String PROPERTY_RUNNING_MODE
Name of the property specifying the running mode.

See Also:
Constant Field Values

DEFAULT_RUNNING_MODE

public static final String DEFAULT_RUNNING_MODE
The default running mode.

See Also:
Constant Field Values

KEY_FORCE_PROPERTIES

public static final String KEY_FORCE_PROPERTIES
This parameter allows to set system properties

See Also:
Constant Field Values

KEY_CONFIGURATION

public static final String KEY_CONFIGURATION
This parameter points to the main configuration file for Cocoon. Note that the path is specified in absolute notation but it will be resolved relative to the application context path.

See Also:
Constant Field Values

KEY_LOGGING_CONFIGURATION

public static final String KEY_LOGGING_CONFIGURATION
This parameter indicates the configuration file of the LogKit management

See Also:
Constant Field Values

KEY_LOGGING_BOOTSTRAP_LOGLEVEL

public static final String KEY_LOGGING_BOOTSTRAP_LOGLEVEL
This parameter indicates the log level to use throughout startup of the system. As soon as the logkit.xconf the setting of the logkit.xconf configuration is used instead! Only for startup and if the logkit.xconf is not readable/available this log level is of importance.

See Also:
Constant Field Values

KEY_LOGGING_MANAGER_CLASS

public static final String KEY_LOGGING_MANAGER_CLASS
This parameter switches the logging system from LogKit to Log4J for Cocoon. Log4J has to be configured already.

See Also:
Constant Field Values

KEY_LOAD_CLASSES

public static final String KEY_LOAD_CLASSES
This parameter is used to list classes that should be loaded at initialization time of the servlet. For example, JDBC Drivers used need to be named here. Additional entries may be inserted here during build depending on your build properties.

See Also:
Constant Field Values

KEY_EXTRA_CLASSPATHS

public static final String KEY_EXTRA_CLASSPATHS
This parameter allows to specify additional directories or jars which Cocoon should put into it's own classpath. Note that absolute pathes are taken as such but relative pathes are rooted at the context root of the Cocoon servlet.

See Also:
Constant Field Values

KEY_PARENT_SERVICE_MANAGER

public static final String KEY_PARENT_SERVICE_MANAGER
This parameter allows you to select the parent service manager. The class will be instantiated via the constructor that takes a single String as a parameter. That String will be equal to the text after the '/'. Cocoon honors the LogEnabled, Initializable and Disposable interfaces for this class, if it implements them.

See Also:
Constant Field Values

KEY_LOGGING_ENVIRONMENT_LOGGER

public static final String KEY_LOGGING_ENVIRONMENT_LOGGER
This parameter indicates the category id of the logger from the LogKit configuration used by the environment.

See Also:
Constant Field Values

KEY_LOGGING_COCOON_LOGGER

public static final String KEY_LOGGING_COCOON_LOGGER
This parameter indicates the category id of the logger from the LogKit management configuration for the Cocoon engine. This logger is used for all components described in the cocoon.xconf and sitemap.xmap file not having specified a logger with the logger="..." attribute in the component configuration file.

See Also:
Constant Field Values

KEY_UPLOADS_DIRECTORY

public static final String KEY_UPLOADS_DIRECTORY
This parameter allows to specify where Cocoon should put uploaded files. The path specified can be either absolute or relative to the context path of the servlet. On windows platform, absolute directory must start with volume: C:\Path\To\Upload\Directory.

See Also:
Constant Field Values

KEY_CACHE_DIRECTORY

public static final String KEY_CACHE_DIRECTORY
This parameter allows to specify where Cocoon should create its page and other objects cache. The path specified can be either absolute or relative to the context path of the servlet. On windows platform, absolute directory must start with volume: C:\Path\To\Cache\Directory.

See Also:
Constant Field Values

KEY_WORK_DIRECTORY

public static final String KEY_WORK_DIRECTORY
This parameter allows to specify where Cocoon should put it's working files. The path specified is either absolute or relative to the context path of the Cocoon servlet. On windows platform, absolute directory must start with volume: C:\Path\To\Work\Directory.

See Also:
Constant Field Values

KEY_MANAGE_EXCEPTIONS

public static final String KEY_MANAGE_EXCEPTIONS
If true or not set, this class will try to catch and handle all Cocoon exceptions. If false, it will rethrow them to the servlet container.

See Also:
Constant Field Values

KEY_FORM_ENCODING

public static final String KEY_FORM_ENCODING
Set form encoding. This will be the character set used to decode request parameters. If not set the ISO-8859-1 encoding will be assumed.

See Also:
Constant Field Values

KEY_LOGGING_OVERRIDE_LOGLEVEL

public static final String KEY_LOGGING_OVERRIDE_LOGLEVEL
If this value is specified, it will be interpreted as a log level and all logging categories will be set to this level regardless of their definition in the logging configuration.

See Also:
Constant Field Values

KEY_PROPERTY_PROVIDER

public static final String KEY_PROPERTY_PROVIDER
This key allows to add own PropertyProviders.

See Also:
Constant Field Values
Method Detail

getConfiguration

public String getConfiguration()
Returns:
Returns the configuration.
See Also:
KEY_CONFIGURATION

getExtraClasspaths

public List getExtraClasspaths()
Returns:
Returns the extraClasspaths.
See Also:
KEY_EXTRA_CLASSPATHS

getForceProperties

public Map getForceProperties()
Returns:
Returns the forceProperties.
See Also:
KEY_FORCE_PROPERTIES

getLoadClasses

public List getLoadClasses()
Returns:
Returns the loadClasses.
See Also:
KEY_LOAD_CLASSES

getLoggerManagerClassName

public String getLoggerManagerClassName()
Returns:
Returns the loggerManagerClassName.
See Also:
KEY_LOGGING_MANAGER_CLASS

getLoggingConfiguration

public String getLoggingConfiguration()
Returns:
Returns the loggingConfiguration.
See Also:
KEY_LOGGING_CONFIGURATION

getBootstrapLogLevel

public String getBootstrapLogLevel()
Returns:
Returns the logLevel.
See Also:
KEY_LOGGING_BOOTSTRAP_LOGLEVEL

getParentServiceManagerClassName

public String getParentServiceManagerClassName()
Returns:
Returns the parentServiceManagerClassName.
See Also:
KEY_PARENT_SERVICE_MANAGER

getUploadDirectory

public String getUploadDirectory()
Returns:
Returns the uploadDirectory.
See Also:
KEY_UPLOADS_DIRECTORY

getWorkDirectory

public String getWorkDirectory()
Returns:
Returns the workDirectory.
See Also:
KEY_WORK_DIRECTORY

getEnvironmentLogger

public String getEnvironmentLogger()
Returns:
Returns the logger for the environment.
See Also:
KEY_LOGGING_ENVIRONMENT_LOGGER

getOverrideLogLevel

public String getOverrideLogLevel()
Returns:
Returns the overrideLogLevel.
See Also:
KEY_LOGGING_OVERRIDE_LOGLEVEL

getFormEncoding

public String getFormEncoding()
Returns:
Returns the formEncoding.
See Also:
KEY_FORM_ENCODING

isManageExceptions

public boolean isManageExceptions()
Returns:
Returns the manageExceptions.
See Also:
KEY_MANAGE_EXCEPTIONS

getCacheDirectory

public String getCacheDirectory()
Returns:
Returns the cacheDirectory.
See Also:
KEY_CACHE_DIRECTORY

getCocoonLogger

public String getCocoonLogger()
Returns:
Returns the cocoonLogger.
See Also:
KEY_LOGGING_COCOON_LOGGER

getCreationTime

public long getCreationTime()
The creation time of the current Cocoon instance.


getPropertyProviders

public List getPropertyProviders()
Returns:
All property providers.
See Also:
KEY_PROPERTY_PROVIDER


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