org.opencms.configuration.CmsModuleConfiguration Maven / Gradle / Ivy
Show all versions of opencms-core Show documentation
/*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* For further information about Alkacon Software GmbH & Co. KG, please see the
* company website: http://www.alkacon.com
*
* For further information about OpenCms, please see the
* project website: http://www.opencms.org
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.opencms.configuration;
import org.opencms.main.CmsLog;
import org.opencms.main.OpenCms;
import org.opencms.module.CmsModule;
import org.opencms.module.CmsModuleManager;
import org.opencms.module.CmsModuleXmlHandler;
import org.opencms.module.CmsModuleXmlHandler.XmlWriteMode;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import org.apache.commons.digester3.Digester;
import org.dom4j.Element;
/**
* Modules configuration class.
*
* @since 6.0.0
*/
public class CmsModuleConfiguration extends A_CmsXmlConfiguration {
/** The name of the DTD for this configuration. */
public static final String CONFIGURATION_DTD_NAME = "opencms-modules.dtd";
/** The name of the default XML file for this configuration. */
public static final String DEFAULT_XML_FILE_NAME = "opencms-modules.xml";
/** The node name for the modules top node. */
public static final String N_MODULES = "modules";
/** The module manager generated from the configuration. */
private CmsModuleManager m_moduleManager;
/** The configured list of module descriptions. */
private List m_modules;
/**
* @see org.opencms.configuration.I_CmsXmlConfiguration#addXmlDigesterRules(org.apache.commons.digester3.Digester)
*/
public void addXmlDigesterRules(Digester digester) {
// add finish rule
digester.addCallMethod("*/" + N_MODULES, "initializeFinished");
// add the module rules for the module digester
CmsModuleXmlHandler.addXmlDigesterRules(digester);
}
/**
* @see org.opencms.configuration.I_CmsXmlConfiguration#generateXml(org.dom4j.Element)
*/
public Element generateXml(Element parent) {
List modules;
if (OpenCms.getRunLevel() >= OpenCms.RUNLEVEL_3_SHELL_ACCESS) {
modules = new ArrayList();
Iterator names = OpenCms.getModuleManager().getModuleNames().iterator();
while (names.hasNext()) {
CmsModule module = OpenCms.getModuleManager().getModule(names.next());
if (module != null) {
modules.add(module);
}
}
Collections.sort(modules);
} else {
// simple unit tests
modules = m_modules;
}
// generate modules node and sub nodes
Element modulesNode = parent.addElement(N_MODULES);
for (int i = 0; i < modules.size(); i++) {
// append all configured modules
CmsModule module = modules.get(i);
Element moduleNode = CmsModuleXmlHandler.generateXml(module, XmlWriteMode.config);
modulesNode.add(moduleNode);
}
// return the modules node
return modulesNode;
}
/**
* @see org.opencms.configuration.I_CmsXmlConfiguration#getDtdFilename()
*/
public String getDtdFilename() {
return CONFIGURATION_DTD_NAME;
}
/**
* Returns the configured module manager.
*
* @return the configured module manager
*/
public CmsModuleManager getModuleManager() {
return m_moduleManager;
}
/**
* Will be called when configuration of this object is finished.
*/
public void initializeFinished() {
// create the module manager with the configured modules
m_moduleManager = new CmsModuleManager(m_modules);
if (CmsLog.INIT.isInfoEnabled()) {
CmsLog.INIT.info(Messages.get().getBundle().key(Messages.INIT_MODULE_CONFIG_FINISHED_0));
}
}
/**
* Adds a new module to the list of configured modules.
*
* @param moduleHandler contains the imported module
*/
public void setModule(CmsModuleXmlHandler moduleHandler) {
// add the module info to the list of configured modules
m_modules.add(moduleHandler.getModule());
}
/**
* @see org.opencms.configuration.A_CmsXmlConfiguration#initMembers()
*/
@Override
protected void initMembers() {
setXmlFileName(DEFAULT_XML_FILE_NAME);
m_modules = new ArrayList();
if (CmsLog.INIT.isInfoEnabled()) {
CmsLog.INIT.info(Messages.get().getBundle().key(Messages.INIT_MODULE_CONFIG_INIT_0));
}
}
}