org.vaadin.viritin.button.DownloadButton Maven / Gradle / Ivy

Go to download
package org.vaadin.viritin.button;

import com.vaadin.server.FileDownloader;
import com.vaadin.server.Resource;
import com.vaadin.server.StreamResource;

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.PipedInputStream;
import java.io.PipedOutputStream;
import java.io.Serializable;

/**
 * A helper class to implement typical file downloads.
 * 
 * With this class you'll get rid of lots of boilerplate code from your
 * application. It also inverts the bit cumbersome input-output stream API in
 * Vaadin so, normally you just "wire" this button to your backend method that
 * writes your resource to OutputStream (instead of playing around with piped
 * streams or storing resources temporary in memory. Example of usage:
 * 

 *  new DownloadButton(invoice::toPdf).setFileName("invoice.pdf")
 * 
 * 
 * The button extension hooks FileDownloader extension internally and inverts
 * the cumbersome default Vaadin API.
 * 
 * The writing of response is also spawn to separate thread, so in case your
 * resource generation takes lots of time, the UI wont block.
 */
public class DownloadButton extends MButton {

    private static final long serialVersionUID = 356223526447669958L;

    public interface ContentWriter {

        void write(OutputStream stream);
    }

    private ContentWriter writer;
    private MimeTypeProvider mimeTypeProvider;
    private FileNameProvider fileNameProvider;

    private final StreamResource streamResource = new StreamResource(new StreamResource.StreamSource() {

        private static final long serialVersionUID = 3641967669172064511L;

        @Override
        public InputStream getStream() {
            try {
                final PipedOutputStream out = new PipedOutputStream();
                final PipedInputStream in = new PipedInputStream(out);
                writeResponce(out);
                return in;
            } catch (IOException ex) {
                throw new RuntimeException(ex);
            }
        }
    }, "") {

        private static final long serialVersionUID = -8221900203840804581L;

        @Override
        public String getFilename() {
            if (fileNameProvider != null) {
                return fileNameProvider.getFileName();
            }
            return DownloadButton.this.getFileName();
        }

        @Override
        public String getMIMEType() {
            if (mimeTypeProvider != null) {
                return mimeTypeProvider.getMimeType();
            }
            return super.getMIMEType();
        }

    };

    /**
     * Constructs a new Download button without ContentWriter. Be sure to set
     * the ContentWriter or override its getter, before instance is actually
     * used.
     */
    public DownloadButton() {
        new FileDownloader(streamResource).extend(this);

    }

    public DownloadButton(ContentWriter writer) {
        this();
        this.writer = writer;
    }

    /**
     * By default just spans a new raw thread to get the input. For strict Java
     * EE fellows, this might not suite, so override and use executor service.
     *
     * @param out the output stream where the output is targeted
     */
    protected void writeResponce(final PipedOutputStream out) {
        new Thread() {
            @Override
            public void run() {
                try {
                    getWriter().write(out);
                    out.close();
                } catch (IOException e) {
                    throw new RuntimeException(e);
                }
            }
        }.start();
    }

    public ContentWriter getWriter() {
        return writer;
    }

    public String getMimeType() {
        return streamResource.getMIMEType();
    }

    public DownloadButton setMimeType(String mimeType) {
        streamResource.setMIMEType(mimeType);
        return this;
    }

    public DownloadButton setCacheTime(long cacheTime) {
        streamResource.setCacheTime(cacheTime);
        return this;
    }

    public DownloadButton setWriter(ContentWriter writer) {
        this.writer = writer;
        return this;
    }

    public String getFileName() {
        return fileNameProvider != null ? fileNameProvider.getFileName() : "file";
    }

    public DownloadButton setFileName(final String fileName) {
        this.fileNameProvider = new FileNameProvider() {

            private static final long serialVersionUID = -3449552786114328636L;

            @Override
            public String getFileName() {
                return fileName;
            }
        };
        return this;
    }

    @Override
    public DownloadButton withIcon(Resource icon) {
        setIcon(icon);
        return this;
    }

    @Override
    public DownloadButton withClickShortcut(int keycode, int... modifiers) {
        setClickShortcut(keycode, modifiers);
        return this;
    }

    public MimeTypeProvider getMimeTypeProvider() {
        return mimeTypeProvider;
    }

    public FileNameProvider getFileNameProvider() {
        return fileNameProvider;
    }

    @Override
    public DownloadButton withCaption(String caption) {
        return (DownloadButton) super.withCaption(caption);
    }

    public DownloadButton setFileNameProvider(FileNameProvider fileNameProvider) {
        this.fileNameProvider = fileNameProvider;
        return this;
    }

    public DownloadButton setMimeTypeProvider(MimeTypeProvider mimeTypeProvider) {
        this.mimeTypeProvider = mimeTypeProvider;
        return this;
    }

    public interface FileNameProvider extends Serializable {

        String getFileName();
    }

    public interface MimeTypeProvider extends Serializable {

        String getMimeType();
    }

}