org.directwebremoting.io.FileTransfer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dwr Show documentation

DWR is easy Ajax for Java. It makes it simple to call Java code directly from Javascript. It gets rid of almost all the boiler plate code between the web browser and your Java code.

There is a newer version: 3.0.2-RELEASE

Show newest version

/*
 * Copyright 2005 Joe Walker
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.directwebremoting.io;

import java.io.ByteArrayInputStream;
import java.io.InputStream;

/**
 * One of the 2 ways you can receive uploaded files from a DWR enabled page is
 * to expose a method with a {@link FileTransfer} parameter.
 * The other is to expose a method with an {@link InputStream} parameter.
 * @author Lance Semmens [uklance at gmail dot com]
 * @author Joe Walker [joe at getahead dot ltd dot uk]
 */
public class FileTransfer
{
    /**
     * A ctor for the 3 things browsers tell us about the uploaded file
     * @param name The remote source filename
     * @param mimeType The mime type passed in by the browser
     * @param inputStream A means by which the data can be read
     */
    public FileTransfer(String name, String mimeType, InputStream inputStream)
    {
        this.name = name;
        this.mimeType = mimeType;
        this.inputStream = inputStream;
    }

    /**
     * A ctor for the 3 things browsers tell us about the uploaded file
     * @param name The remote source filename
     * @param mimeType The mime type passed in by the browser
     * @param data The data to be transfered
     */
    public FileTransfer(String name, String mimeType, byte[] data)
    {
        this.name = name;
        this.mimeType = mimeType;
        this.inputStream = new ByteArrayInputStream(data);
    }

    /**
     * Returns the content type passed by the browser or null if not defined. 
     * @return The content type passed by the browser or null if not defined.
     */
    public String getMimeType()
    {
        return mimeType;
    }

    /**
     * Returns an InputStream that can be used to retrieve the contents of the file. 
     * @return An InputStream that can be used to retrieve the contents of the file.
     */
    public InputStream getInputStream()
    {
        return inputStream;
    }

    /**
     * Returns the original filename in the client's file-system, as provided by
     * the browser (or other client software). 
     * In most cases, this will be the base file name, without path information.
     * However, some clients, such as the Opera browser, do include path
     * information.
     * @return The original filename in the client's file-system.
     */
    public String getName()
    {
        return name;
    }

    /**
     * The remote source filename
     */
    private String name;

    /**
     * The mime type passed in by the browser
     */
    private String mimeType;

    /**
     * A means by which the data can be read
     */
    private InputStream inputStream;
}