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.ui.apps.logfile;
029
030import java.io.InputStream;
031import java.util.Set;
032
033/**
034 * Provides log file download functionality.
035 */
036public interface I_CmsLogDownloadProvider {
037
038    /**
039     * Checks if the user can download a zip with all logs.
040     *
041     * @return true if the user can download a zip with all logs
042     */
043    boolean canDownloadAllLogs();
044
045    /**
046     * Gets the prefix to use for the download file name.
047     *
048     * @return the prefix for the download
049     */
050    String getDownloadPrefix();
051
052    /**
053     * Gets the set of log file paths.
054     *
055     * @return the set of log file paths
056     */
057    Set<String> getLogFiles();
058
059    /**
060     * Gets the input stream for the download with all logs (only works if canDownloadAllLogs() returned true)
061     *
062     * @return the input stream for the collected logs zip file
063     */
064    InputStream readAllLogs();
065
066    /**
067     * Gets the input stream for the download of a single log file
068     *
069     * @param path the full path of the log file (must be a value in the set returned by getLogFiles())
070     *
071     * @return the input stream for the download
072     */
073    InputStream readLog(String path);
074}