yacy_search_server/source/de/anomic/server/serverCachedFileOutputStream.java

// FileFallbackByteArrayOutputStream.java 
// -------------------------------------
// part of YACY
// (C) by Michael Peter Christen; mc@anomic.de
// first published on http://www.anomic.de
// Frankfurt, Germany, 2004
// 
// This file ist contributed by Franz Brausze
// 
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
// 
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
// 
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
// 
// Using this software in any meaning (reading, learning, copying, compiling,
// running) means that you agree that the Author(s) is (are) not responsible
// for cost, loss of data or any harm that may be caused directly or indirectly
// by usage of this softare or this documentation. The usage of this software
// is on your own risk. The installation and usage (starting/running) of this
// software may allow other people or application to access your computer and
// any attached devices and is highly dependent on the configuration of the
// software which must be done by the user of the software; the author(s) is
// (are) also not responsible for proper configuration and usage of the
// software, even if provoked by documentation provided together with
// the software.
// 
// Any changes to this file according to the GPL as documented in the file
// gpl.txt aside this file in the shipment you received can be done to the
// lines that follows this copyright notice here, but changes must not be
// done inside the copyright notive above. A re-distribution must contain
// the intact and unchanged copyright notice.
// Contributions and changes to the program code must be marked as such.

package de.anomic.server;

import java.io.BufferedInputStream;
import java.io.BufferedOutputStream;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;

public class serverCachedFileOutputStream extends ByteArrayOutputStream {
    
    protected File fallbackFile;
    protected long fallbackSize;
    protected boolean buffered;
    
    protected long size = 0;
    protected boolean isFallback = false;
    protected OutputStream fallback = null;
    
    public serverCachedFileOutputStream(long fallbackSize) throws IOException {
        this(fallbackSize, null, true, 32);
    }
    
    public serverCachedFileOutputStream(long fallbackSize, File fallback, boolean buffered)
            throws IOException {
        this(fallbackSize, fallback, buffered, 32);
    }
    
    public serverCachedFileOutputStream(long fallbackSize, File fallback, boolean buffered,
            long size) throws IOException {
        this.fallbackSize = fallbackSize;
        this.fallbackFile = (fallback == null) ? File.createTempFile(
                serverCachedFileOutputStream.class.getName(),
                Long.toString(System.currentTimeMillis())) : fallback;
        this.buffered = buffered;
        checkFallback(size);
    }
    
    public serverCachedFileOutputStream(long fallbackSize, File fallback, boolean buffered,
            byte[] data) throws IOException {
        this(fallbackSize, fallback, buffered, 0);
        super.buf = data;
        super.count = data.length;
        checkFallback(this.size = data.length);
    }
    
    protected boolean checkFallback(long size) {
        if (size > this.fallbackSize) try {
            fallback();
            return true;
        } catch (IOException e) {
            throw new RuntimeException("error falling back to file", e);
        } else {
            return false;
        }
    }
    
    public void fallback() throws IOException {
        if (this.isFallback) return;
        this.isFallback = true;
        if (!this.fallbackFile.exists()) {
            this.fallbackFile.createNewFile();
        } else if (this.fallbackFile.isDirectory()) {
            throw new IOException("cannot write on a directory");
        }
        OutputStream os = new FileOutputStream(this.fallbackFile);
        this.fallback = (this.buffered) ? new BufferedOutputStream(os) : os;
        serverFileUtils.copy(new ByteArrayInputStream(super.buf), this.fallback);
        super.buf = new byte[0];
        super.count = 0;
        super.reset();
    }
    
    public boolean isFallback() {
        return this.isFallback;
    }
    
    public void write(int b) {
        if (checkFallback(++this.size)) try {
            this.fallback.write(b);
        } catch (IOException e) {
            throw new RuntimeException("error writing to fallback", e);
        } else {
            super.write(b);
        }
    }
    
    public void write(byte[] b, int off, int len) {
        if (checkFallback(this.size += len)) try {
            this.fallback.write(b, off, len);
        } catch (IOException e) {
            throw new RuntimeException("error writing to fallback", e);
        } else {
            super.write(b, off, len);
        }
    }
    
    public void close() throws IOException {
        if (this.fallback != null)
            this.fallback.close();
        super.close();
    }
    
    public InputStream getContent() throws IOException {
        close();
        if (this.isFallback) {
            InputStream is = new FileInputStream(this.fallbackFile);
            return (this.buffered) ? new BufferedInputStream(is) : is;
        } else {
            return new ByteArrayInputStream(this.buf);
        }
    }
    
    public byte[] getContentBAOS() {
        if (this.isFallback)
            throw new RuntimeException("underlying ByteArrayOutputStream not available, already fell back to file");
        return super.buf;
    }
    
    public File getContentFile() {
        if (!this.isFallback)
            throw new RuntimeException("haven't fallen back yet, fallback file has no content");
        return this.fallbackFile;
    }
    
    public long getLength() {
        return this.size;
    }
}