io.netty.handler.codec.http.multipart

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 io.netty.handler.codec.http.multipart.InterfaceHttpData

InterfaceHttpData.HttpDataType

Method Summary

Modifier and Type	Method and 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 io.netty.handler.codec.http.multipart.HttpData

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

Methods inherited from interface io.netty.handler.codec.http.multipart.InterfaceHttpData

getHttpDataType, getName

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface io.netty.buffer.ByteBufHolder

content

Methods inherited from interface io.netty.util.ReferenceCounted

refCnt, release, release

Method Detail

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

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