io.jooby

Interface FileUpload

public interface FileUpload

File upload class, file upload are available when request body is encoded as MediaType.MULTIPART_FORMDATA. Example:

 {

   post("/submit", ctx -> {

     FileUpload file = ctx.file("myfile");

   });

 }
 

Since:

2.0.0

Author:

edgar

Method Summary

Modifier and Type	Method and Description
byte[]	bytes() Content as byte array.
void	destroy() Free resources, delete temporary file.
String	getContentType() Content type of file upload.
String	getFileName() Name of file upload.
long	getFileSize() File size or -1 when unknown.
String	getName() File key.
Path	path() File system path to access file content.
InputStream	stream() Content as input stream.

Method Detail

getName

@Nonnull
String getName()

File key. That's the field form name, not the file name. Example:

Returns:

File key. That's the field form name, not the file name.

getFileName

@Nonnull
String getFileName()

Name of file upload.

Returns:

Name of file upload.

getContentType

@Nullable
String getContentType()

Content type of file upload.

Returns:

Content type of file upload.

stream

@Nonnull
InputStream stream()

Content as input stream.

Returns:

Content as input stream.

bytes

@Nonnull
byte[] bytes()

Content as byte array.

Returns:

Content as byte array.

path

@Nonnull
Path path()

File system path to access file content.

Returns:

File system path to access file content.

getFileSize

long getFileSize()

File size or -1 when unknown.

Returns:

File size or -1 when unknown.

destroy

void destroy()

Free resources, delete temporary file.