All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.opencms.ade.containerpage.inherited.CmsContainerConfigurationCacheState Maven / Gradle / Ivy

Go to download

OpenCms is an enterprise-ready, easy to use website content management system based on Java and XML technology. Offering a complete set of features, OpenCms helps content managers worldwide to create and maintain beautiful websites fast and efficiently.

There is a newer version: 18.0
Show newest version
/*
 * File   : $Source$
 * Date   : $Date$
 * Version: $Revision$
 *
 * This library is part of OpenCms -
 * the Open Source Content Management System
 *
 * Copyright (C) 2002 - 2011 Alkacon Software (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, 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.ade.containerpage.inherited;

import org.opencms.main.CmsLog;
import org.opencms.util.CmsFileUtil;
import org.opencms.util.CmsUUID;

import java.util.Collection;
import java.util.HashMap;
import java.util.Map;

import org.apache.commons.logging.Log;

import com.google.common.collect.Maps;

/**
 * A cache class for storing inherited container configurations.

*/ public class CmsContainerConfigurationCacheState { /** The standard file name for inherited container configurations. */ public static final String INHERITANCE_CONFIG_FILE_NAME = ".inherited"; /** The logger instance for this class. */ public static final Log LOG = CmsLog.getLog(CmsContainerConfigurationCacheState.class); /** Inheritance configurations by structure id. */ private Map m_configurationsById = new HashMap(); /** The map of cached configurations, with the base paths as keys. */ private Map m_configurationsByPath = new HashMap(); /** * Creates a new cache state.

* * @param groups the inheritance group configurations.

*/ public CmsContainerConfigurationCacheState(Collection groups) { for (CmsContainerConfigurationGroup group : groups) { if (group != null) { m_configurationsByPath.put(getBasePath(group.getRootPath()), group); m_configurationsById.put(group.getStructureId(), group); } } } /** * Gets the container configuration for a given root path, name and locale.

* * @param rootPath the root path * @param name the configuration name * * @return the container configuration for the given combination of parameters */ public synchronized CmsContainerConfiguration getContainerConfiguration(String rootPath, String name) { String key = getCacheKey(rootPath); if (m_configurationsByPath.containsKey(key)) { CmsContainerConfigurationGroup group = m_configurationsByPath.get(key); CmsContainerConfiguration result = group.getConfiguration(name); return result; } return null; } /** * Creates a new inheritance container cache state, which is based on this instance, but with some changed configurations.

* * @param updateGroups a map of the updated configurations, with the structure ids as keys * * @return the new cache state */ public CmsContainerConfigurationCacheState updateWithChangedGroups( Map updateGroups) { Map newGroups = Maps.newHashMap(m_configurationsById); for (Map.Entry entry : updateGroups.entrySet()) { CmsUUID key = entry.getKey(); CmsContainerConfigurationGroup group = entry.getValue(); if (group == null) { newGroups.remove(key); } else { newGroups.put(key, group); } } return new CmsContainerConfigurationCacheState(newGroups.values()); } /** * Returns the base path for a given configuration file. * * E.g. the result for the input '/sites/default/.container-config' will be '/sites/default'.

* * @param rootPath the root path of the configuration file * * @return the base path for the configuration file */ protected String getBasePath(String rootPath) { if (rootPath.endsWith(INHERITANCE_CONFIG_FILE_NAME)) { return rootPath.substring(0, rootPath.length() - INHERITANCE_CONFIG_FILE_NAME.length()); } return rootPath; } /** * Gets the cache key for a given base path.

* * @param basePath the base path * * @return the cache key for the base path */ protected String getCacheKey(String basePath) { assert !basePath.endsWith(INHERITANCE_CONFIG_FILE_NAME); return CmsFileUtil.addTrailingSeparator(basePath); } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy