Package org.opencms.configuration

Class CmsAdditionalLogFolderConfig

java.lang.Object

org.opencms.configuration.CmsAdditionalLogFolderConfig

All Implemented Interfaces:

I_CmsConfigurationParameterHandler

public class CmsAdditionalLogFolderConfig
extends Object
implements I_CmsConfigurationParameterHandler

Bean containing additional log folders available for the log file viewer.

Field Summary

Fields

Modifier and Type	Field	Description
static CmsElementWithSubElementsParamConfigHelper	ADD_LOG_FOLDER_HELPER	The config helper instance.
static final String	N_ADDITIONAL_LOG_FOLDERS	XML element name for the folder list.
static final String	N_LOG_FOLDER	XML element name for the individual log folder.

Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

Constructor Summary

Constructors

Constructor	Description
CmsAdditionalLogFolderConfig()

Method Summary

Modifier and Type	Method	Description
void	addConfigurationParameter(String paramName, String paramValue)	Adds a configuration parameter to this parameter configurable class instance.
CmsParameterConfiguration	getConfiguration()	Returns the parameters of this configurable class instance, or null if the class does not need any parameters.
List<String>	getLogFolders()	Gets the log folders.
void	initConfiguration()	Initializes a configuration after all parameters have been added.

Methods inherited from class java.lang.Object

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

Field Details

N_ADDITIONAL_LOG_FOLDERS

public static final String N_ADDITIONAL_LOG_FOLDERS

XML element name for the folder list.

See Also:

• Constant Field Values

N_LOG_FOLDER

public static final String N_LOG_FOLDER

XML element name for the individual log folder.

See Also:

• Constant Field Values

ADD_LOG_FOLDER_HELPER

public static CmsElementWithSubElementsParamConfigHelper ADD_LOG_FOLDER_HELPER

The config helper instance.

Constructor Details

CmsAdditionalLogFolderConfig

public CmsAdditionalLogFolderConfig()

Method Details

addConfigurationParameter

public void addConfigurationParameter(String paramName,
 String paramValue)

Description copied from interface: I_CmsConfigurationParameterHandler

Adds a configuration parameter to this parameter configurable class instance.

Specified by:

addConfigurationParameter in interface I_CmsConfigurationParameterHandler

Parameters:

paramName - the name of the parameter

paramValue - the value for the parameter

See Also:

• I_CmsConfigurationParameterHandler.addConfigurationParameter(java.lang.String, java.lang.String)

getConfiguration

public CmsParameterConfiguration getConfiguration()

Description copied from interface: I_CmsConfigurationParameterHandler

Returns the parameters of this configurable class instance, or null if the class does not need any parameters.

Specified by:

getConfiguration in interface I_CmsConfigurationParameterHandler

Returns:

the parameters of this configurable class instance, or null if the class does not need any parameters

See Also:

• I_CmsConfigurationParameterHandler.getConfiguration()

getLogFolders

public List<String> getLogFolders()

Gets the log folders.

Returns:

the log folders

initConfiguration

public void initConfiguration()

Description copied from interface: I_CmsConfigurationParameterHandler

Initializes a configuration after all parameters have been added.

Specified by:

initConfiguration in interface I_CmsConfigurationParameterHandler

See Also:

• I_CmsConfigurationParameterHandler.initConfiguration()