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.ade.sitemap;
029
030import org.opencms.ade.sitemap.shared.CmsClientSitemapEntry;
031import org.opencms.file.CmsObject;
032
033import java.util.ArrayList;
034import java.util.List;
035
036/**
037 * Sitemap session cache.<p>
038 *
039 * @since 8.0.0
040 */
041public final class CmsSitemapSessionCache {
042
043    /** The sitemap recent list. */
044    private List<CmsClientSitemapEntry> m_recentList;
045
046    /** Session attribute name constant. */
047    public static final String SESSION_ATTR_SITEMAP_CACHE = "__OCMS_SITEMAP_CACHE__";
048
049    /**
050     * Initializes the session cache.<p>
051     *
052     * @param cms the cms context
053     */
054    public CmsSitemapSessionCache(CmsObject cms) {
055
056        // sitemap recent lists
057        m_recentList = new ArrayList<CmsClientSitemapEntry>();
058    }
059
060    /**
061     * Returns the cached recent list.<p>
062     *
063     * @return the cached recent list
064     */
065    public List<CmsClientSitemapEntry> getRecentList() {
066
067        return m_recentList;
068    }
069
070    /**
071     * Caches the given recent list.<p>
072     *
073     * @param list the recent list to cache
074     */
075    public void setRecentList(List<CmsClientSitemapEntry> list) {
076
077        m_recentList = list;
078    }
079}