org.jboss.netty.handler.codec.http.multipart

Class AbstractDiskHttpData

java.lang.Object

org.jboss.netty.handler.codec.http.multipart.AbstractHttpData

org.jboss.netty.handler.codec.http.multipart.AbstractDiskHttpData

All Implemented Interfaces:

java.lang.Comparable<InterfaceHttpData>, HttpData, InterfaceHttpData

Direct Known Subclasses:

DiskAttribute, DiskFileUpload

public abstract class AbstractDiskHttpData
extends AbstractHttpData

Abstract Disk HttpData implementation

Nested Class Summary

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

InterfaceHttpData.HttpDataType

Field Summary

Fields

Modifier and Type	Field and Description
protected java.io.File	file
private java.nio.channels.FileChannel	fileChannel
private boolean	isRenamed
private static InternalLogger	logger

Fields inherited from class org.jboss.netty.handler.codec.http.multipart.AbstractHttpData

charset, completed, definedSize, maxSize, name, size

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractDiskHttpData(java.lang.String name, java.nio.charset.Charset charset, long size)

Method Summary

Modifier and Type	Method and Description
void	addContent(ChannelBuffer buffer, boolean last) Add the content from the ChannelBuffer
void	delete() Deletes the underlying storage for a file item, including deleting any associated temporary disk file.
protected abstract boolean	deleteOnExit()
byte[]	get() Returns the contents of the file item as an array of bytes.
protected abstract java.lang.String	getBaseDirectory()
ChannelBuffer	getChannelBuffer() Returns the content of the file item as a ChannelBuffer
ChannelBuffer	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.
protected abstract java.lang.String	getDiskFilename()
java.io.File	getFile()
protected abstract java.lang.String	getPostfix()
protected abstract java.lang.String	getPrefix()
java.lang.String	getString() Returns the contents of the file item as a String, using the default character encoding.
java.lang.String	getString(java.nio.charset.Charset encoding) Returns the contents of the file item as a String, using the specified charset.
boolean	isInMemory() Provides a hint as to whether or not the file contents will be read from memory.
private static byte[]	readFrom(java.io.File src) Utility function
boolean	renameTo(java.io.File dest) A convenience method to write an uploaded item to disk.
void	setContent(ChannelBuffer buffer) Set the content from the ChannelBuffer (erase any previous data)
void	setContent(java.io.File file) Set the content from the file (erase any previous data)
void	setContent(java.io.InputStream inputStream) Set the content from the inputStream (erase any previous data)
private java.io.File	tempFile()

Methods inherited from class org.jboss.netty.handler.codec.http.multipart.AbstractHttpData

checkSize, getCharset, getName, isCompleted, length, setCharset, setMaxSize

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jboss.netty.handler.codec.http.multipart.InterfaceHttpData

getHttpDataType

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

logger

private static final InternalLogger logger

file

protected java.io.File file

isRenamed

private boolean isRenamed

fileChannel

private java.nio.channels.FileChannel fileChannel

Constructor Detail

AbstractDiskHttpData

protected AbstractDiskHttpData(java.lang.String name,
                               java.nio.charset.Charset charset,
                               long size)

Method Detail

getDiskFilename

protected abstract java.lang.String getDiskFilename()

Returns:

the real DiskFilename (basename)

getPrefix

protected abstract java.lang.String getPrefix()

Returns:

the default prefix

getBaseDirectory

protected abstract java.lang.String getBaseDirectory()

Returns:

the default base Directory

getPostfix

protected abstract java.lang.String getPostfix()

Returns:

the default postfix

deleteOnExit

protected abstract boolean deleteOnExit()

Returns:

True if the file should be deleted on Exit by default

tempFile

private java.io.File tempFile()
                       throws java.io.IOException

Returns:

a new Temp File from getDiskFilename(), default prefix, postfix and baseDirectory

Throws:

java.io.IOException

setContent

public void setContent(ChannelBuffer buffer)
                throws java.io.IOException

Description copied from interface: HttpData

Set the content from the ChannelBuffer (erase any previous data)

Parameters:

buffer - must be not null

Throws:

java.io.IOException

addContent

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

Description copied from interface: HttpData

Add the content from the ChannelBuffer

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

setContent

public void setContent(java.io.File file)
                throws java.io.IOException

Description copied from interface: HttpData

Set the content from the file (erase any previous data)

Parameters:

file - must be not null

Throws:

java.io.IOException

setContent

public void setContent(java.io.InputStream inputStream)
                throws java.io.IOException

Description copied from interface: HttpData

Set the content from the inputStream (erase any previous data)

Parameters:

inputStream - must be not null

Throws:

java.io.IOException

delete

public void delete()

Description copied from interface: HttpData

Deletes the underlying storage for a file item, including deleting any associated temporary disk file.

get

public byte[] get()
           throws java.io.IOException

Description copied from interface: HttpData

Returns the contents of the file item as an array of bytes.

Returns:

the contents of the file item as an array of bytes.

Throws:

java.io.IOException

getChannelBuffer

public ChannelBuffer getChannelBuffer()
                               throws java.io.IOException

Description copied from interface: HttpData

Returns the content of the file item as a ChannelBuffer

Returns:

the content of the file item as a ChannelBuffer

Throws:

java.io.IOException

getChunk

public ChannelBuffer getChunk(int length)
                       throws java.io.IOException

Description copied from interface: HttpData

Returns a ChannelBuffer for the content from the current position with at most length read bytes, increasing the current position of the Bytes read. Once it arrives at the end, it returns an EMPTY_BUFFER and it resets the current position to 0.

Returns:

a ChannelBuffer for the content from the current position or an EMPTY_BUFFER if there is no more data to return

Throws:

java.io.IOException

getString

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

Description copied from interface: HttpData

Returns the contents of the file item as a String, using the default character encoding.

Returns:

the contents of the file item as a String, using the default character encoding.

Throws:

java.io.IOException

getString

public java.lang.String getString(java.nio.charset.Charset encoding)
                           throws java.io.IOException

Description copied from interface: HttpData

Returns the contents of the file item as a String, using the specified charset.

Parameters:

encoding - the charset to use

Returns:

the contents of the file item as a String, using the specified charset.

Throws:

java.io.IOException

isInMemory

public boolean isInMemory()

Description copied from interface: HttpData

Provides a hint as to whether or not the file contents will be read from memory.

Returns:

True if the file contents is in memory.

renameTo

public boolean renameTo(java.io.File dest)
                 throws java.io.IOException

Description copied from interface: HttpData

A convenience method to write an uploaded item to disk. If a previous one exists, it will be deleted. Once this method is called, if successful, the new file will be out of the cleaner of the factory that creates the original InterfaceHttpData object.

Parameters:

dest - destination file - must be not null

Returns:

True if the write is successful

Throws:

java.io.IOException

readFrom

private static byte[] readFrom(java.io.File src)
                        throws java.io.IOException

Utility function

Returns:

the array of bytes

Throws:

java.io.IOException

getFile

public java.io.File getFile()
                     throws java.io.IOException

Returns:

the associated File if this data is represented in a file

Throws:

java.io.IOException - if this data is not represented by a file