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.site.xmlsitemap;
029
030import org.opencms.main.CmsLog;
031
032import java.util.concurrent.ConcurrentHashMap;
033
034import org.apache.commons.logging.Log;
035
036/**
037 * Cache for XML sitemaps.<p>
038 */
039public class CmsXmlSitemapCache {
040
041    /** The logger for this class. */
042    private static final Log LOG = CmsLog.getLog(CmsXmlSitemapCache.class);
043
044    /** Static instance for this class. */
045    public static final CmsXmlSitemapCache INSTANCE = new CmsXmlSitemapCache();
046
047    /** The map for storing the cached sitemaps. */
048    private ConcurrentHashMap<String, String> m_cache = new ConcurrentHashMap<String, String>();
049
050    /**
051     * Clears the cache.<p>
052     */
053    public void clear() {
054
055        m_cache.clear();
056    }
057
058    /**
059     * Gets the cached entry for the given key (the key will normally be the root path of a sitemap.xml file).<p>
060     *
061     * @param key the key
062     * @return the cached XML sitemap, or null if no cached value exists
063     */
064    public String get(String key) {
065
066        return m_cache.get(key);
067    }
068
069    /**
070     * Stores an XML sitemap in the cache.<p>
071     *
072     * @param key the XML sitemap key (usually the root path of the sitemap.xml)
073     * @param value the XML sitemap content
074     */
075    public void put(String key, String value) {
076
077        LOG.info("Caching sitemap for key " + key + ", size = " + value.length());
078        m_cache.put(key, value);
079    }
080
081}