Class DiskFileUpload

java.lang.Object

io.netty.util.AbstractReferenceCounted

io.netty.handler.codec.http.multipart.AbstractHttpData

io.netty.handler.codec.http.multipart.AbstractDiskHttpData

io.netty.handler.codec.http.multipart.DiskFileUpload

All Implemented Interfaces:

ByteBufHolder, FileUpload, HttpData, InterfaceHttpData, ReferenceCounted, java.lang.Comparable<InterfaceHttpData>

public class DiskFileUpload
extends AbstractDiskHttpData
implements FileUpload

Disk FileUpload implementation that stores file into real files

Nested Class Summary

Nested classes/interfaces inherited from interface InterfaceHttpData

InterfaceHttpData.HttpDataType

Field Summary

Fields

Modifier and Type	Field	Description
private final java.lang.String	baseDir
static java.lang.String	baseDirectory
private java.lang.String	contentTransferEncoding
private java.lang.String	contentType
private final boolean	deleteOnExit
static boolean	deleteOnExitTemporaryFile
private java.lang.String	filename
static final java.lang.String	postfix
static final java.lang.String	prefix

Fields inherited from class AbstractHttpData

definedSize, size

Constructor Summary

Constructors

Constructor	Description
DiskFileUpload(java.lang.String name, java.lang.String filename, java.lang.String contentType, java.lang.String contentTransferEncoding, java.nio.charset.Charset charset, long size)
DiskFileUpload(java.lang.String name, java.lang.String filename, java.lang.String contentType, java.lang.String contentTransferEncoding, java.nio.charset.Charset charset, long size, java.lang.String baseDir, boolean deleteOnExit)

Method Summary

Modifier and Type	Method	Description
int	compareTo(FileUpload o)
int	compareTo(InterfaceHttpData o)
FileUpload	copy()	Creates a deep copy of this ByteBufHolder.
protected boolean	deleteOnExit()
FileUpload	duplicate()	Duplicates this ByteBufHolder.
boolean	equals(java.lang.Object o)
protected java.lang.String	getBaseDirectory()
java.lang.String	getContentTransferEncoding()	Returns the Content-Transfer-Encoding
java.lang.String	getContentType()	Returns the content type passed by the browser or null if not defined.
protected java.lang.String	getDiskFilename()
java.lang.String	getFilename()	Returns the original filename in the client's filesystem, as provided by the browser (or other client software).
InterfaceHttpData.HttpDataType	getHttpDataType()
protected java.lang.String	getPostfix()
protected java.lang.String	getPrefix()
int	hashCode()
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(java.lang.String contentTransferEncoding)	Set the Content-Transfer-Encoding type from String as 7bit, 8bit or binary
void	setContentType(java.lang.String contentType)	Set the Content Type passed by the browser if defined
void	setFilename(java.lang.String filename)	Set the original filename.
java.lang.String	toString()
FileUpload	touch()	Records the current access location of this object for debugging purposes.
FileUpload	touch(java.lang.Object hint)	Records the current access location of this object with an additional arbitrary information for debugging purposes.

Methods inherited from class AbstractDiskHttpData

addContent, delete, get, getByteBuf, getChunk, getFile, getString, getString, isInMemory, renameTo, setContent, setContent, setContent

Methods inherited from class AbstractHttpData

checkSize, content, deallocate, definedLength, getCharset, getMaxSize, getName, isCompleted, length, setCharset, setCompleted, setCompleted, setMaxSize

Methods inherited from class AbstractReferenceCounted

refCnt, release, release, setRefCnt

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ByteBufHolder

content

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

Methods inherited from interface InterfaceHttpData

getName

Methods inherited from interface ReferenceCounted

refCnt, release, release

Field Details

baseDirectory

public static java.lang.String baseDirectory

deleteOnExitTemporaryFile

public static boolean deleteOnExitTemporaryFile

prefix

public static final java.lang.String prefix

See Also:

• Constant Field Values

postfix

public static final java.lang.String postfix

See Also:

• Constant Field Values

baseDir

private final java.lang.String baseDir

deleteOnExit

private final boolean deleteOnExit

filename

private java.lang.String filename

contentType

private java.lang.String contentType

contentTransferEncoding

private java.lang.String contentTransferEncoding

Constructor Details

DiskFileUpload

public DiskFileUpload(java.lang.String name,
 java.lang.String filename,
 java.lang.String contentType,
 java.lang.String contentTransferEncoding,
 java.nio.charset.Charset charset,
 long size,
 java.lang.String baseDir,
 boolean deleteOnExit)

DiskFileUpload

public DiskFileUpload(java.lang.String name,
 java.lang.String filename,
 java.lang.String contentType,
 java.lang.String contentTransferEncoding,
 java.nio.charset.Charset charset,
 long size)

Method Details

getHttpDataType

public InterfaceHttpData.HttpDataType getHttpDataType()

Specified by:

getHttpDataType in interface InterfaceHttpData

Returns:

The HttpDataType

getFilename

public java.lang.String getFilename()

Description copied from interface: FileUpload

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

Specified by:

getFilename in interface FileUpload

Returns:

the original filename

setFilename

public void setFilename(java.lang.String filename)

Description copied from interface: FileUpload

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.

Specified by:

setFilename in interface FileUpload

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

compareTo

public int compareTo(InterfaceHttpData o)

Specified by:

compareTo in interface java.lang.Comparable<InterfaceHttpData>

compareTo

public int compareTo(FileUpload o)

setContentType

public void setContentType(java.lang.String contentType)

Description copied from interface: FileUpload

Set the Content Type passed by the browser if defined

Specified by:

setContentType in interface FileUpload

Parameters:

contentType - Content Type to set - must be not null

getContentType

public java.lang.String getContentType()

Description copied from interface: FileUpload

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

Specified by:

getContentType in interface FileUpload

Returns:

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

getContentTransferEncoding

public java.lang.String getContentTransferEncoding()

Description copied from interface: FileUpload

Returns the Content-Transfer-Encoding

Specified by:

getContentTransferEncoding in interface FileUpload

Returns:

the Content-Transfer-Encoding

setContentTransferEncoding

public void setContentTransferEncoding(java.lang.String contentTransferEncoding)

Description copied from interface: FileUpload

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

Specified by:

setContentTransferEncoding in interface FileUpload

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

deleteOnExit

protected boolean deleteOnExit()

Specified by:

deleteOnExit in class AbstractDiskHttpData

Returns:

True if the file should be deleted on Exit by default

getBaseDirectory

protected java.lang.String getBaseDirectory()

Specified by:

getBaseDirectory in class AbstractDiskHttpData

Returns:

the default base Directory

getDiskFilename

protected java.lang.String getDiskFilename()

Specified by:

getDiskFilename in class AbstractDiskHttpData

Returns:

the real DiskFilename (basename)

getPostfix

protected java.lang.String getPostfix()

Specified by:

getPostfix in class AbstractDiskHttpData

Returns:

the default postfix

getPrefix

protected java.lang.String getPrefix()

Specified by:

getPrefix in class AbstractDiskHttpData

Returns:

the default prefix

copy

public 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 FileUpload

Specified by:

copy in interface HttpData

duplicate

public 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 FileUpload

Specified by:

duplicate in interface HttpData

retainedDuplicate

public 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 FileUpload

Specified by:

retainedDuplicate in interface HttpData

See Also:

• ByteBuf.retainedDuplicate()

replace

public 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 FileUpload

Specified by:

replace in interface HttpData

retain

public 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 FileUpload

Specified by:

retain in interface HttpData

Specified by:

retain in interface InterfaceHttpData

Specified by:

retain in interface ReferenceCounted

Overrides:

retain in class AbstractHttpData

retain

public FileUpload retain()

Description copied from interface: ReferenceCounted

Increases the reference count by 1.

Specified by:

retain in interface ByteBufHolder

Specified by:

retain in interface FileUpload

Specified by:

retain in interface HttpData

Specified by:

retain in interface InterfaceHttpData

Specified by:

retain in interface ReferenceCounted

Overrides:

retain in class AbstractHttpData

touch

public 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 FileUpload

Specified by:

touch in interface HttpData

Specified by:

touch in interface InterfaceHttpData

Specified by:

touch in interface ReferenceCounted

Overrides:

touch in class AbstractDiskHttpData

touch

public FileUpload touch(java.lang.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 FileUpload

Specified by:

touch in interface HttpData

Specified by:

touch in interface InterfaceHttpData

Specified by:

touch in interface ReferenceCounted

Overrides:

touch in class AbstractDiskHttpData