001/*
002 * #%L
003 * Netarchivesuite - common
004 * %%
005 * Copyright (C) 2005 - 2014 The Royal Danish Library, the Danish State and University Library,
006 *             the National Library of France and the Austrian National Library.
007 * %%
008 * This program is free software: you can redistribute it and/or modify
009 * it under the terms of the GNU Lesser General Public License as
010 * published by the Free Software Foundation, either version 2.1 of the
011 * License, or (at your option) any later version.
012 * 
013 * This program is distributed in the hope that it will be useful,
014 * but WITHOUT ANY WARRANTY; without even the implied warranty of
015 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
016 * GNU General Lesser Public License for more details.
017 * 
018 * You should have received a copy of the GNU General Lesser Public
019 * License along with this program.  If not, see
020 * <http://www.gnu.org/licenses/lgpl-2.1.html>.
021 * #L%
022 */
023
024package dk.netarkivet.common.utils.batch;
025
026import java.io.File;
027import java.io.OutputStream;
028
029/**
030 * This class implements a batchjob that enables you to delete files from an archive. Note that the default Java
031 * Security Policy distributed with NetarchiveSuite does not allow this.
032 *
033 * @author ngiraud
034 * @author svc
035 */
036@SuppressWarnings({"serial"})
037public class FileRemover extends FileBatchJob {
038
039    /**
040     * The method to initialize the batchjob.
041     *
042     * @param os The OutputStream to which output should be written
043     * @see FileBatchJob#initialize(OutputStream)
044     */
045    @Override
046    public void initialize(OutputStream os) {
047    }
048
049    /**
050     * This method deletes the file in the argument list. Note that the default Java Security Policy distributed with
051     * NetarchiveSuite does not allow this.
052     *
053     * @param file The file to be processed
054     * @param os The OutputStream to which output should be written
055     * @return true, if and only if the file is succesfully deleted.
056     * @see FileBatchJob#processFile(File, OutputStream)
057     */
058    @Override
059    public boolean processFile(File file, OutputStream os) {
060        return file.delete();
061    }
062
063    /**
064     * The method to finish the batchjob.
065     *
066     * @param os The OutputStream to which output should be written
067     * @see FileBatchJob#finish(OutputStream)
068     */
069    @Override
070    public void finish(OutputStream os) {
071    }
072
073}