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.upload;
029
030import org.opencms.util.CmsUUID;
031
032import java.util.concurrent.TimeUnit;
033
034import com.google.common.cache.Cache;
035import com.google.common.cache.CacheBuilder;
036
037/**
038 * A table to temporarily store warnings that should be displayed for uploaded files.
039 *
040 * <p>Warning messages are automatically removed from the table after some time.
041 */
042public class CmsUploadWarningTable {
043
044    /** The internal cache. */
045    private Cache<CmsUUID, String> m_cache;
046
047    /**
048     * Creates a new instance.
049     */
050    public CmsUploadWarningTable() {
051
052        m_cache = CacheBuilder.<CmsUUID, String> newBuilder().concurrencyLevel(2).expireAfterWrite(
053            12,
054            TimeUnit.HOURS).build();
055
056    }
057
058    /**
059     * Clears the table.
060     */
061    public void clear() {
062
063        m_cache.invalidateAll();
064    }
065
066    /**
067     * Gets the warning message for the given structure id.
068     *
069     * @param id a resource structure id
070     * @return the warning message (or null if there is no message)
071     */
072    public String getMessage(CmsUUID id) {
073
074        return m_cache.getIfPresent(id);
075    }
076
077    /**
078     * Sets the warning message for the given structure id (or clears it, if the message isn null).
079     *
080     * @param id the structure id of a resource
081     * @param message the message to store
082     */
083    public void setMessage(CmsUUID id, String message) {
084
085        if (message != null) {
086            m_cache.put(id, message);
087        } else {
088            m_cache.invalidate(id);
089        }
090    }
091
092    /**
093     * Gets the size of the table.
094     *
095     * @return the size
096     */
097    public long size() {
098
099        return m_cache.size();
100    }
101
102}