jodd.io.upload.FileUpload Maven / Gradle / Ivy
// Copyright (c) 2003-present, Jodd Team (http://jodd.org)
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
package jodd.io.upload;
import java.io.IOException;
import java.io.InputStream;
/**
* Encapsulates base for uploaded file. Its instance may be
* either valid, when it represent an uploaded file, or invalid
* when uploaded file doesn't exist or there was a problem with it.
*/
public abstract class FileUpload {
protected final MultipartRequestInputStream input;
protected final int maxFileSize;
protected final FileUploadHeader header;
protected FileUpload(final MultipartRequestInputStream input, final int maxFileSize) {
this.input = input;
this.header = input.lastHeader;
this.maxFileSize = maxFileSize;
}
// ---------------------------------------------------------------- header
/**
* Returns {@link FileUploadHeader} of uploaded file.
*/
public FileUploadHeader getHeader() {
return header;
}
// ---------------------------------------------------------------- data
/**
* Returns all bytes of uploaded file.
*/
public abstract byte[] getFileContent() throws IOException;
/**
* Returns input stream of uploaded file.
*/
public abstract InputStream getFileInputStream() throws IOException;
// ---------------------------------------------------------------- size and validity
protected boolean valid;
protected int size = -1;
protected boolean fileTooBig;
/**
* Returns the file upload size or -1 if file was not uploaded.
*/
public int getSize() {
return size;
}
/**
* Returns true if file was uploaded.
*/
public boolean isUploaded() {
return size != -1;
}
/**
* Returns true if upload process went correctly.
* This still does not mean that file is uploaded, e.g. when file
* was not specified on the form.
*/
public boolean isValid() {
return valid;
}
/**
* Returns max file size or -1 if there is no max file size.
*/
public int getMaxFileSize() {
return maxFileSize;
}
/**
* Returns true if file is too big. File will be marked as invalid.
*/
public boolean isFileTooBig() {
return fileTooBig;
}
// ---------------------------------------------------------------- status
/**
* Returns true if uploaded file content is stored in memory.
*/
public abstract boolean isInMemory();
// ---------------------------------------------------------------- process
/**
* Process request input stream. Note that file size is unknown at this point.
* Therefore, the implementation should set the {@link #getSize() size}
* attribute after successful processing. This method also must set the
* {@link #isValid() valid} attribute.
*
* @see MultipartRequestInputStream
*/
protected abstract void processStream() throws IOException;
// ---------------------------------------------------------------- toString
/**
* Returns basic information about the uploaded file.
*/
@Override
public String toString() {
return "FileUpload: uploaded=[" + isUploaded() + "] valid=[" + valid + "] field=[" +
header.getFormFieldName() + "] name=[" + header.getFileName() + "] size=[" + size + ']';
}
}