Interface FileUpload

All Superinterfaces:

ByteBufHolder, Comparable<InterfaceHttpData>, HttpData, InterfaceHttpData, ReferenceCounted

All Known Implementing Classes:

DiskFileUpload, MemoryFileUpload, MixedFileUpload

public interface FileUpload
extends HttpData

FileUpload interface that could be in memory, on temporary file or any other implementations. Most methods are inspired from java.io.File API.

Nested Class Summary

Nested classes/interfaces inherited from interface InterfaceHttpData

InterfaceHttpData.HttpDataType

Modifier and Type	Interface	Description
static enum	InterfaceHttpData.HttpDataType

Method Summary

Modifier and Type	Method	Description
FileUpload	copy()	Creates a deep copy of this ByteBufHolder.
FileUpload	duplicate()	Duplicates this ByteBufHolder.
String	getContentTransferEncoding()	Returns the Content-Transfer-Encoding
String	getContentType()	Returns the content type passed by the browser or null if not defined.
String	getFilename()	Returns the original filename in the client's filesystem, as provided by the browser (or other client software).
FileUpload	replace(ByteBuf content)	Returns a new ByteBufHolder which contains the specified content.
FileUpload	retain()	Increases the reference count by 1.
FileUpload	retain(int increment)	Increases the reference count by the specified increment.
FileUpload	retainedDuplicate()	Duplicates this ByteBufHolder.
void	setContentTransferEncoding(String contentTransferEncoding)	Set the Content-Transfer-Encoding type from String as 7bit, 8bit or binary
void	setContentType(String contentType)	Set the Content Type passed by the browser if defined
void	setFilename(String filename)	Set the original filename.
FileUpload	touch()	Records the current access location of this object for debugging purposes.
FileUpload	touch(Object hint)	Records the current access location of this object with an additional arbitrary information for debugging purposes.

Methods inherited from interface ByteBufHolder

content

Modifier and Type	Method	Description
ByteBuf	content()	Return the data which is held by this ByteBufHolder.

Methods inherited from interface Comparable

compareTo

Methods inherited from interface HttpData

addContent, checkSize, definedLength, delete, get, getByteBuf, getCharset, getChunk, getFile, getMaxSize, getString, getString, isCompleted, isInMemory, length, renameTo, setCharset, setContent, setContent, setContent, setMaxSize

Modifier and Type	Method	Description
void	addContent(ByteBuf buffer, boolean last)	Add the content from the ChannelBuffer
void	checkSize(long newSize)	Check if the new size is not reaching the max limit allowed.
long	definedLength()	Returns the defined length of the HttpData.
void	delete()	Deletes the underlying storage for a file item, including deleting any associated temporary disk file.
byte[]	get()	Returns the contents of the file item as an array of bytes. Note: this method will allocate a lot of memory, if the data is currently stored on the file system.
ByteBuf	getByteBuf()	Returns the content of the file item as a ByteBuf. Note: this method will allocate a lot of memory, if the data is currently stored on the file system.
Charset	getCharset()	Returns the Charset passed by the browser or null if not defined.
ByteBuf	getChunk(int length)	Returns a ChannelBuffer for the content from the current position with at most length read bytes, increasing the current position of the Bytes read.
File	getFile()
long	getMaxSize()	Returns the maxSize for this HttpData.
String	getString()	Returns the contents of the file item as a String, using the default character encoding.
String	getString(Charset encoding)	Returns the contents of the file item as a String, using the specified charset.
boolean	isCompleted()
boolean	isInMemory()	Provides a hint as to whether or not the file contents will be read from memory.
long	length()	Returns the size in byte of the InterfaceHttpData
boolean	renameTo(File dest)	A convenience getMethod to write an uploaded item to disk.
void	setCharset(Charset charset)	Set the Charset passed by the browser if defined
void	setContent(ByteBuf buffer)	Set the content from the ChannelBuffer (erase any previous data)
void	setContent(File file)	Set the content from the file (erase any previous data)
void	setContent(InputStream inputStream)	Set the content from the inputStream (erase any previous data)
void	setMaxSize(long maxSize)	Set the maxSize for this HttpData.

Methods inherited from interface InterfaceHttpData

getHttpDataType, getName

Modifier and Type	Method	Description
InterfaceHttpData.HttpDataType	getHttpDataType()
String	getName()	Returns the name of this InterfaceHttpData.

Methods inherited from interface ReferenceCounted

refCnt, release, release

Modifier and Type	Method	Description
int	refCnt()	Returns the reference count of this object.
boolean	release()	Decreases the reference count by 1 and deallocates this object if the reference count reaches at 0.
boolean	release(int decrement)	Decreases the reference count by the specified decrement and deallocates this object if the reference count reaches at 0.

Method Details

getFilename

String getFilename()

Returns the original filename in the client's filesystem, as provided by the browser (or other client software).

Returns:

the original filename

setFilename

void setFilename(String filename)

Set the original filename.

Note: This method validates that the filename is safe for including in an HTTP request, and will throw an exception if that's not the case.

setContentType

void setContentType(String contentType)

Set the Content Type passed by the browser if defined

Parameters:

contentType - Content Type to set - must be not null

getContentType

String getContentType()

Returns the content type passed by the browser or null if not defined.

Returns:

the content type passed by the browser or null if not defined.

setContentTransferEncoding

void setContentTransferEncoding(String contentTransferEncoding)

Set the Content-Transfer-Encoding type from String as 7bit, 8bit or binary

getContentTransferEncoding

String getContentTransferEncoding()

Returns the Content-Transfer-Encoding

Returns:

the Content-Transfer-Encoding

copy

FileUpload copy()

Description copied from interface: ByteBufHolder

Creates a deep copy of this ByteBufHolder.

Specified by:

copy in interface ByteBufHolder

Specified by:

copy in interface HttpData

duplicate

FileUpload duplicate()

Description copied from interface: ByteBufHolder

Duplicates this ByteBufHolder. Be aware that this will not automatically call ByteBufHolder.retain().

Specified by:

duplicate in interface ByteBufHolder

Specified by:

duplicate in interface HttpData

retainedDuplicate

FileUpload retainedDuplicate()

Description copied from interface: ByteBufHolder

Duplicates this ByteBufHolder. This method returns a retained duplicate unlike ByteBufHolder.duplicate().

Specified by:

retainedDuplicate in interface ByteBufHolder

Specified by:

retainedDuplicate in interface HttpData

See Also:

• ByteBuf.retainedDuplicate()

replace

FileUpload replace(ByteBuf content)

Description copied from interface: ByteBufHolder

Returns a new ByteBufHolder which contains the specified content.

Specified by:

replace in interface ByteBufHolder

Specified by:

replace in interface HttpData

retain

FileUpload retain()

Description copied from interface: ReferenceCounted

Increases the reference count by 1.

Specified by:

retain in interface ByteBufHolder

Specified by:

retain in interface HttpData

Specified by:

retain in interface InterfaceHttpData

Specified by:

retain in interface ReferenceCounted

retain

FileUpload retain(int increment)

Description copied from interface: ReferenceCounted

Increases the reference count by the specified increment.

Specified by:

retain in interface ByteBufHolder

Specified by:

retain in interface HttpData

Specified by:

retain in interface InterfaceHttpData

Specified by:

retain in interface ReferenceCounted

touch

FileUpload touch()

Description copied from interface: ReferenceCounted

Records the current access location of this object for debugging purposes. If this object is determined to be leaked, the information recorded by this operation will be provided to you via ResourceLeakDetector. This method is a shortcut to touch(null).

Specified by:

touch in interface ByteBufHolder

Specified by:

touch in interface HttpData

Specified by:

touch in interface InterfaceHttpData

Specified by:

touch in interface ReferenceCounted

touch

FileUpload touch(Object hint)

Description copied from interface: ReferenceCounted

Records the current access location of this object with an additional arbitrary information for debugging purposes. If this object is determined to be leaked, the information recorded by this operation will be provided to you via ResourceLeakDetector.

Specified by:

touch in interface ByteBufHolder

Specified by:

touch in interface HttpData

Specified by:

touch in interface InterfaceHttpData

Specified by:

touch in interface ReferenceCounted