Upload.java

/*
 * Copyright (C) 2014 Civilian Framework.
 *
 * Licensed under the Civilian License (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.civilian-framework.org/license.txt
 *
 * 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.civilian.request;


import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import org.civilian.Request;
import org.civilian.util.IoUtil;


/**
 * Upload represents an uploaded file.
 * @see Request#getUpload(String)
 * @see Request#getUploadNames()
 */
public abstract class Upload
{
	/**
	 * An empty Upload array.
	 */
	public static final Upload[] EMPTY_LIST = new Upload[0];
	
		
	/**
	 * Deletes the upload file including any temporary files.
	 * @throws IOException
	 */
	public abstract void delete() throws IOException;

	
	/**
	 * Returns the length of the uploaded file.
	 */
	public abstract long length();

	
	/**
	 * Returns the content type of the uploaded file.
	 */
	public abstract String getContentType();

	
	/**
	 * Returns an input stream to the uploaded data.
	 */
	public abstract InputStream getInputStream() throws IOException;

	
	/**
	 * Writes the upload to the specified file.
	 */
	public void write(File file) throws IOException
	{
		FileOutputStream out = new FileOutputStream(file);
		try
		{
			IoUtil.copy(getInputStream(), out);
		}
		finally
		{
			out.close();
		}
	}

	
	/**
	 * Returns the name of the upload parameter. 
	 */
	public abstract String getName();


	/**
	 * Returns the filename of the upload, indicating the original
	 * filename of the uploaded file.
	 */
	public abstract String getFileName();
}