001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.configuration;
029
030import java.util.List;
031
032/**
033 * Bean containing additional log folders available for the log file viewer.<p>
034 */
035public class CmsAdditionalLogFolderConfig implements I_CmsConfigurationParameterHandler {
036
037    /** XML element name for the folder list. */
038    public static final String N_ADDITIONAL_LOG_FOLDERS = "additional-log-folders";
039
040    /** XML element name for the individual log folder. */
041    public static final String N_LOG_FOLDER = "log-folder";
042
043    /**
044     * The config helper instance.
045     **/
046    public static CmsElementWithSubElementsParamConfigHelper ADD_LOG_FOLDER_HELPER = new CmsElementWithSubElementsParamConfigHelper(
047        "*/" + CmsWorkplaceConfiguration.N_WORKPLACE,
048        N_ADDITIONAL_LOG_FOLDERS,
049        CmsAdditionalLogFolderConfig.class,
050        N_LOG_FOLDER);
051
052    /** The parameter configuration used to store the config values. */
053    CmsParameterConfiguration m_params = new CmsParameterConfiguration();
054
055    /**
056     * @see org.opencms.configuration.I_CmsConfigurationParameterHandler#addConfigurationParameter(java.lang.String, java.lang.String)
057     */
058    public void addConfigurationParameter(String paramName, String paramValue) {
059
060        m_params.add(paramName, paramValue.trim());
061    }
062
063    /**
064     * @see org.opencms.configuration.I_CmsConfigurationParameterHandler#getConfiguration()
065     */
066    public CmsParameterConfiguration getConfiguration() {
067
068        return m_params;
069
070    }
071
072    /**
073     * Gets the log folders.<p>
074     *
075     * @return the log folders
076     */
077    public List<String> getLogFolders() {
078
079        return m_params.getList(N_LOG_FOLDER);
080
081    }
082
083    /**
084     * @see org.opencms.configuration.I_CmsConfigurationParameterHandler#initConfiguration()
085     */
086    public void initConfiguration() {
087        // do nothing
088    }
089
090}