com.vaadin.flow.component.upload.receivers.FileBuffer Maven / Gradle / Ivy
/*
* Copyright 2000-2024 Vaadin Ltd.
*
* 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 com.vaadin.flow.component.upload.receivers;
import java.io.ByteArrayInputStream;
import java.io.File;
import java.io.FileDescriptor;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.logging.Level;
import com.vaadin.flow.component.upload.Receiver;
/**
* Basic in file receiver implementation. File is stored by default to File
* created using {@link java.io.File#createTempFile(String, String)} with a null
* suffix.
*
* For a custom file the constructor {@link AbstractFileBuffer(FileFactory)}
* should be used.
*/
public class FileBuffer extends AbstractFileBuffer implements Receiver {
private transient FileData file;
/**
* Creates a file buffer with a default file factory.
*
* Files will be created using {@link File#createTempFile(String, String)}
* and have that build 'upload_tmpfile_{FILENAME}_{currentTimeMillis}'
*/
public FileBuffer() {
super();
}
/**
* Creates a file buffer that uses a file factory to create a custom upload
* {@link File}.
*
* @param factory
* file factory for file buffer
*/
public FileBuffer(FileFactory factory) {
super(factory);
}
@Override
public OutputStream receiveUpload(String fileName, String mimeType) {
FileOutputStream outputBuffer = createFileOutputStream(fileName);
file = new FileData(fileName, mimeType, outputBuffer);
return outputBuffer;
}
/**
* Get the file data object.
*
* @return file data for the latest upload or null
*/
public FileData getFileData() {
return file;
}
/**
* Get the file name for this buffer.
*
* @return file name or empty if no file
*/
public String getFileName() {
return file != null ? file.getFileName() : "";
}
/**
* Get the output stream for file.
*
* @return file output stream or null if not available
*/
public FileDescriptor getFileDescriptor() {
if (file != null) {
try {
return ((FileOutputStream) file.getOutputBuffer()).getFD();
} catch (IOException e) {
getLogger().log(Level.WARNING,
"Failed to get file descriptor for: '" + getFileName()
+ "'",
e);
}
}
return null;
}
/**
* Get the input stream for file.
*
* @return input stream for file or empty stream if file not found
*/
public InputStream getInputStream() {
if (file != null) {
final File path = file.getFile();
try {
return new FileInputStream(path);
} catch (IOException e) {
getLogger().log(Level.WARNING,
"Failed to create InputStream for: '" + getFileName()
+ "'",
e);
}
}
return new ByteArrayInputStream(new byte[0]);
}
}