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.configuration.I_CmsConfigurationParameterHandler;
031
032import java.io.InputStream;
033import java.util.List;
034
035/**
036 * Interface for virus scanners used to check uploaded files.
037 */
038public interface I_CmsVirusScanner extends I_CmsConfigurationParameterHandler {
039
040    /**
041     * Scans file data for viruses.
042     *
043     * @param data the data to scan as a stream
044     *
045     * @return a list of names of viruses found
046     */
047    List<String> scan(InputStream stream);
048
049    /**
050     * Used to test the availability of the virus scanner.
051     */
052    void test();
053
054}