Package io.netty.handler.codec.http.multipart

Class DiskAttribute

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.DiskAttribute

All Implemented Interfaces:

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

public class DiskAttribute
extends AbstractDiskHttpData
implements Attribute

Disk implementation of Attributes

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.handler.codec.http.multipart.InterfaceHttpData

InterfaceHttpData.HttpDataType

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	baseDirectory
static boolean	deleteOnExitTemporaryFile
static java.lang.String	postfix
static java.lang.String	prefix

Fields inherited from class io.netty.handler.codec.http.multipart.AbstractHttpData

definedSize, size

Constructor Summary

Constructors

Constructor	Description
DiskAttribute(java.lang.String name)	Constructor used for huge Attribute
DiskAttribute(java.lang.String name, long definedSize)
DiskAttribute(java.lang.String name, long definedSize, java.lang.String baseDir, boolean deleteOnExit)
DiskAttribute(java.lang.String name, long definedSize, java.nio.charset.Charset charset)
DiskAttribute(java.lang.String name, long definedSize, java.nio.charset.Charset charset, java.lang.String baseDir, boolean deleteOnExit)
DiskAttribute(java.lang.String name, java.lang.String value)
DiskAttribute(java.lang.String name, java.lang.String baseDir, boolean deleteOnExit)
DiskAttribute(java.lang.String name, java.lang.String value, java.nio.charset.Charset charset)
DiskAttribute(java.lang.String name, java.lang.String value, java.nio.charset.Charset charset, java.lang.String baseDir, boolean deleteOnExit)
DiskAttribute(java.lang.String name, java.nio.charset.Charset charset)
DiskAttribute(java.lang.String name, java.nio.charset.Charset charset, java.lang.String baseDir, boolean deleteOnExit)

Method Summary

Modifier and Type	Method	Description
void	addContent(ByteBuf buffer, boolean last)	Add the content from the ChannelBuffer
int	compareTo(Attribute o)
int	compareTo(InterfaceHttpData o)
Attribute	copy()	Creates a deep copy of this ByteBufHolder.
protected boolean	deleteOnExit()
Attribute	duplicate()	Duplicates this ByteBufHolder.
boolean	equals(java.lang.Object o)
protected java.lang.String	getBaseDirectory()
protected java.lang.String	getDiskFilename()
InterfaceHttpData.HttpDataType	getHttpDataType()
protected java.lang.String	getPostfix()
protected java.lang.String	getPrefix()
java.lang.String	getValue()	Returns the value of this HttpData.
int	hashCode()
Attribute	replace(ByteBuf content)	Returns a new ByteBufHolder which contains the specified content.
Attribute	retain()	Increases the reference count by 1.
Attribute	retain(int increment)	Increases the reference count by the specified increment.
Attribute	retainedDuplicate()	Duplicates this ByteBufHolder.
void	setValue(java.lang.String value)	Sets the value of this HttpData.
java.lang.String	toString()
Attribute	touch()	Records the current access location of this object for debugging purposes.
Attribute	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 io.netty.handler.codec.http.multipart.AbstractDiskHttpData

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

Methods inherited from class io.netty.handler.codec.http.multipart.AbstractHttpData

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

Methods inherited from class io.netty.util.AbstractReferenceCounted

refCnt, release, release, setRefCnt

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.buffer.ByteBufHolder

content

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

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

getName

Methods inherited from interface io.netty.util.ReferenceCounted

refCnt, release, release

Field Detail

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

Constructor Detail

DiskAttribute

public DiskAttribute(java.lang.String name)

Constructor used for huge Attribute

DiskAttribute

public DiskAttribute(java.lang.String name,
                     java.lang.String baseDir,
                     boolean deleteOnExit)

DiskAttribute

public DiskAttribute(java.lang.String name,
                     long definedSize)

DiskAttribute

public DiskAttribute(java.lang.String name,
                     long definedSize,
                     java.lang.String baseDir,
                     boolean deleteOnExit)

DiskAttribute

public DiskAttribute(java.lang.String name,
                     java.nio.charset.Charset charset)

DiskAttribute

public DiskAttribute(java.lang.String name,
                     java.nio.charset.Charset charset,
                     java.lang.String baseDir,
                     boolean deleteOnExit)

DiskAttribute

public DiskAttribute(java.lang.String name,
                     long definedSize,
                     java.nio.charset.Charset charset)

DiskAttribute

public DiskAttribute(java.lang.String name,
                     long definedSize,
                     java.nio.charset.Charset charset,
                     java.lang.String baseDir,
                     boolean deleteOnExit)

DiskAttribute

public DiskAttribute(java.lang.String name,
                     java.lang.String value)
              throws java.io.IOException

Throws:

java.io.IOException

DiskAttribute

public DiskAttribute(java.lang.String name,
                     java.lang.String value,
                     java.nio.charset.Charset charset)
              throws java.io.IOException

Throws:

java.io.IOException

DiskAttribute

public DiskAttribute(java.lang.String name,
                     java.lang.String value,
                     java.nio.charset.Charset charset,
                     java.lang.String baseDir,
                     boolean deleteOnExit)
              throws java.io.IOException

Throws:

java.io.IOException

Method Detail

getHttpDataType

public InterfaceHttpData.HttpDataType getHttpDataType()

Specified by:

getHttpDataType in interface InterfaceHttpData

Returns:

The HttpDataType

getValue

public java.lang.String getValue()
                          throws java.io.IOException

Description copied from interface: Attribute

Returns the value of this HttpData.

Specified by:

getValue in interface Attribute

Throws:

java.io.IOException

setValue

public void setValue(java.lang.String value)
              throws java.io.IOException

Description copied from interface: Attribute

Sets the value of this HttpData.

Specified by:

setValue in interface Attribute

Throws:

java.io.IOException

addContent

public void addContent(ByteBuf buffer,
                       boolean last)
                throws java.io.IOException

Description copied from interface: HttpData

Add the content from the ChannelBuffer

ReferenceCounted.release() ownership of buffer is transferred to this HttpData.

Specified by:

addContent in interface HttpData

Overrides:

addContent in class AbstractDiskHttpData

Parameters:

buffer - must be not null except if last is set to False

last - True of the buffer is the last one

Throws:

java.io.IOException

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(Attribute o)

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 Attribute copy()

Description copied from interface: ByteBufHolder

Creates a deep copy of this ByteBufHolder.

Specified by:

copy in interface Attribute

Specified by:

copy in interface ByteBufHolder

Specified by:

copy in interface HttpData

duplicate

public Attribute duplicate()

Description copied from interface: ByteBufHolder

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

Specified by:

duplicate in interface Attribute

Specified by:

duplicate in interface ByteBufHolder

Specified by:

duplicate in interface HttpData

retainedDuplicate

public Attribute retainedDuplicate()

Description copied from interface: ByteBufHolder

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

Specified by:

retainedDuplicate in interface Attribute

Specified by:

retainedDuplicate in interface ByteBufHolder

Specified by:

retainedDuplicate in interface HttpData

See Also:

ByteBuf.retainedDuplicate()

replace

public Attribute replace(ByteBuf content)

Description copied from interface: ByteBufHolder

Returns a new ByteBufHolder which contains the specified content.

Specified by:

replace in interface Attribute

Specified by:

replace in interface ByteBufHolder

Specified by:

replace in interface HttpData

retain

public Attribute retain(int increment)

Description copied from interface: ReferenceCounted

Increases the reference count by the specified increment.

Specified by:

retain in interface Attribute

Specified by:

retain in interface ByteBufHolder

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 Attribute retain()

Description copied from interface: ReferenceCounted

Increases the reference count by 1.

Specified by:

retain in interface Attribute

Specified by:

retain in interface ByteBufHolder

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 Attribute 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 Attribute

Specified by:

touch in interface ByteBufHolder

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 Attribute 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 Attribute

Specified by:

touch in interface ByteBufHolder

Specified by:

touch in interface HttpData

Specified by:

touch in interface InterfaceHttpData

Specified by:

touch in interface ReferenceCounted

Overrides:

touch in class AbstractDiskHttpData