Vert.x 4.5.13 · io.vertx.core.http.impl.NettyFileUpload

Modifier and Type	Field and Description
private Charset	charset
private boolean	completed
private String	contentTransferEncoding
private String	contentType
private Handler<Buffer>	dataHandler
private Handler<Void>	endHandler
private Handler<Throwable>	exceptionHandler
private String	filename
private long	maxSize
private final String	name
private final InboundBuffer<Object>	pending
private final HttpServerRequest	request
private final long	size

Access	Constructor and Description
pack-priv	NettyFileUpload(Context context, HttpServerRequest request, String name, String filename, String contentType, String contentTransferEncoding, Charset charset, long size)

Method Summary

Modifier and Type	Method and Description
public void	addContent(ByteBuf must be not null except if last is set to False channelBuffer, boolean True of the buffer is the last one last) Implements io.netty.handler.codec.http.multipart.HttpData.addContent. Add the content from the ChannelBuffer `ByteBuf#release()` ownership of `buffer` is transferred to this `HttpData`.
public void	checkSize(long newSize) Implements io.netty.handler.codec.http.multipart.HttpData.checkSize. Check if the new size is not reaching the max limit allowed.
public int	compareTo(InterfaceHttpData the object to be compared. o) Implements java.lang.Comparable.compareTo. Compares this object with the specified object for order.
public ByteBuf	content() Implements io.netty.buffer.ByteBufHolder.content. Return the data which is held by this `ByteBufHolder`.
public FileUpload	copy() Implements io.netty.handler.codec.http.multipart.FileUpload.copy. Creates a deep copy of this `ByteBufHolder`.
public long	definedLength() Implements io.netty.handler.codec.http.multipart.HttpData.definedLength. Returns the defined length of the HttpData.
public void	delete() Implements io.netty.handler.codec.http.multipart.HttpData.delete. Deletes the underlying storage for a file item, including deleting any associated temporary disk file.
public FileUpload	duplicate() Implements io.netty.handler.codec.http.multipart.FileUpload.duplicate. Duplicates this `ByteBufHolder`.
private void	end()
private synchronized Handler<Void>	endHandler()
public synchronized NettyFileUpload	endHandler(Handler<Void> handler)
public synchronized NettyFileUpload	exceptionHandler(Handler<Throwable> handler)
public NettyFileUpload	fetch(long amount) Implements io.vertx.core.streams.ReadStream.fetch. Fetch the specified `amount` of elements.
public byte[]	get() Implements io.netty.handler.codec.http.multipart.HttpData.get. Returns the contents of the file item as an array of bytes.
public ByteBuf	getByteBuf() Implements io.netty.handler.codec.http.multipart.HttpData.getByteBuf. Returns the content of the file item as a ByteBuf.
public Charset	getCharset() Implements io.netty.handler.codec.http.multipart.HttpData.getCharset. Returns the Charset passed by the browser or null if not defined.
public ByteBuf	getChunk(int i) Implements io.netty.handler.codec.http.multipart.HttpData.getChunk. Returns a ChannelBuffer for the content from the current position with at most length read bytes, increasing the current position of the Bytes read.
public String	getContentTransferEncoding() Implements io.netty.handler.codec.http.multipart.FileUpload.getContentTransferEncoding. Returns the Content-Transfer-Encoding
public String	getContentType() Implements io.netty.handler.codec.http.multipart.FileUpload.getContentType. Returns the content type passed by the browser or null if not defined.
public File	getFile() Implements io.netty.handler.codec.http.multipart.HttpData.getFile.
public String	getFilename() Implements io.netty.handler.codec.http.multipart.FileUpload.getFilename. Returns the original filename in the client's filesystem, as provided by the browser (or other client software).
public InterfaceHttpData.HttpDataType	getHttpDataType() Implements io.netty.handler.codec.http.multipart.InterfaceHttpData.getHttpDataType.
public long	getMaxSize() Implements io.netty.handler.codec.http.multipart.HttpData.getMaxSize. Returns the maxSize for this HttpData.
public String	getName() Implements io.netty.handler.codec.http.multipart.InterfaceHttpData.getName. Returns the name of this InterfaceHttpData.
public String	getString() Implements io.netty.handler.codec.http.multipart.HttpData.getString. Returns the contents of the file item as a String, using the default character encoding.
public String	getString(Charset the charset to use charset) Implements io.netty.handler.codec.http.multipart.HttpData.getString. Returns the contents of the file item as a String, using the specified charset.
public void	handleException(Throwable err)
private Handler<Buffer>	handler()
public synchronized NettyFileUpload	handler(Handler<Buffer> handler)
public boolean	isCompleted() Implements io.netty.handler.codec.http.multipart.HttpData.isCompleted.
public boolean	isInMemory() Implements io.netty.handler.codec.http.multipart.HttpData.isInMemory. Provides a hint as to whether or not the file contents will be read from memory.
public long	length() Implements io.netty.handler.codec.http.multipart.HttpData.length. Returns the size in byte of the InterfaceHttpData
public NettyFileUpload	pause() Implements io.vertx.core.streams.ReadStream.pause. Pause the `ReadStream`, it sets the buffer in `fetch` mode and clears the actual demand.
private void	receiveData(Buffer data) References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element.
public int	refCnt() Implements io.netty.util.ReferenceCounted.refCnt. Returns the reference count of this object.
public boolean	release() Implements io.netty.util.ReferenceCounted.release. Decreases the reference count by `1` and deallocates this object if the reference count reaches at `0`.
public boolean	release(int decrement) Implements io.netty.util.ReferenceCounted.release. Decreases the reference count by the specified `decrement` and deallocates this object if the reference count reaches at `0`.
public boolean	renameTo(File destination file - must be not null file) Implements io.netty.handler.codec.http.multipart.HttpData.renameTo. A convenience getMethod to write an uploaded item to disk.
public FileUpload	replace(ByteBuf content) Implements io.netty.handler.codec.http.multipart.FileUpload.replace. Returns a new `ByteBufHolder` which contains the specified `content`.
public NettyFileUpload	resume() Implements io.vertx.core.streams.ReadStream.resume. Resume reading, and sets the buffer in `flowing` mode.
public FileUpload	retain() Implements io.netty.handler.codec.http.multipart.FileUpload.retain. Increases the reference count by `1`.
public FileUpload	retain(int increment) Implements io.netty.handler.codec.http.multipart.FileUpload.retain. Increases the reference count by the specified `increment`.
public FileUpload	retainedDuplicate() Implements io.netty.handler.codec.http.multipart.FileUpload.retainedDuplicate. Duplicates this `ByteBufHolder`.
public void	setCharset(Charset Charset to set - must be not null charset) Implements io.netty.handler.codec.http.multipart.HttpData.setCharset. Set the Charset passed by the browser if defined
public void	setContent(ByteBuf must be not null channelBuffer) Implements io.netty.handler.codec.http.multipart.HttpData.setContent. Set the content from the ChannelBuffer (erase any previous data) `ByteBuf#release()` ownership of `buffer` is transferred to this `HttpData`.
public void	setContent(File must be not null file) Implements io.netty.handler.codec.http.multipart.HttpData.setContent. Set the content from the file (erase any previous data)
public void	setContent(InputStream must be not null inputStream) Implements io.netty.handler.codec.http.multipart.HttpData.setContent. Set the content from the inputStream (erase any previous data)
public void	setContentTransferEncoding(String contentTransferEncoding) Implements io.netty.handler.codec.http.multipart.FileUpload.setContentTransferEncoding. Set the Content-Transfer-Encoding type from String as 7bit, 8bit or binary
public void	setContentType(String Content Type to set - must be not null contentType) Implements io.netty.handler.codec.http.multipart.FileUpload.setContentType. Set the Content Type passed by the browser if defined
public void	setFilename(String filename) Implements io.netty.handler.codec.http.multipart.FileUpload.setFilename. Set the original filename
public void	setMaxSize(long maxSize) Implements io.netty.handler.codec.http.multipart.HttpData.setMaxSize. Set the maxSize for this HttpData.
public FileUpload	touch(Object hint) Implements io.netty.handler.codec.http.multipart.FileUpload.touch. Records the current access location of this object with an additional arbitrary information for debugging purposes.
public FileUpload	touch() Implements io.netty.handler.codec.http.multipart.FileUpload.touch. Records the current access location of this object for debugging purposes.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

charset	back to summary
private Charset charset

completed	back to summary
private boolean completed

contentTransferEncoding	back to summary
private String contentTransferEncoding

contentType	back to summary
private String contentType

dataHandler	back to summary
private Handler<Buffer> dataHandler

endHandler	back to summary
private Handler<Void> endHandler

exceptionHandler	back to summary
private Handler<Throwable> exceptionHandler

filename	back to summary
private String filename

maxSize	back to summary
private long maxSize

name	back to summary
private final String name

pending	back to summary
private final InboundBuffer<Object> pending

request	back to summary
private final HttpServerRequest request

size	back to summary
private final long size

NettyFileUpload	back to summary
pack-priv NettyFileUpload(Context context, HttpServerRequest request, String name, String filename, String contentType, String contentTransferEncoding, Charset charset, long size)

Method Detail

addContent back to summary

addContent	back to summary
public void addContent(ByteBuf channelBuffer, boolean last) throws IOException Implements io.netty.handler.codec.http.multipart.HttpData.addContent. Doc from io.netty.handler.codec.http.multipart.HttpData.addContent. Add the content from the ChannelBuffer `ByteBuf#release()` ownership of `buffer` is transferred to this `HttpData`. Parameters channelBuffer:ByteBuf must be not null except if last is set to False last:boolean True of the buffer is the last one Annotations @Override

public void addContent(ByteBuf channelBuffer, boolean last) throws IOException

Implements io.netty.handler.codec.http.multipart.HttpData.addContent.

Doc from io.netty.handler.codec.http.multipart.HttpData.addContent.

Add the content from the ChannelBuffer

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

Parameters

channelBuffer:ByteBuf: must be not null except if last is set to False
last:boolean: True of the buffer is the last one

Annotations

@Override

checkSize	back to summary
public void checkSize(long newSize) throws IOException Implements io.netty.handler.codec.http.multipart.HttpData.checkSize. Doc from io.netty.handler.codec.http.multipart.HttpData.checkSize. Check if the new size is not reaching the max limit allowed. The limit is always computed in terms of bytes. Annotations @Override

checkSize

back to summary

public void checkSize(long newSize) throws IOException

Implements io.netty.handler.codec.http.multipart.HttpData.checkSize.

Doc from io.netty.handler.codec.http.multipart.HttpData.checkSize.

Check if the new size is not reaching the max limit allowed. The limit is always computed in terms of bytes.

Annotations

@Override

compareTo back to summary

compareTo	back to summary
public int compareTo(InterfaceHttpData o) Implements java.lang.Comparable.compareTo. Doc from java.lang.Comparable.compareTo. Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. The implementor must ensure `signum(x.compareTo(y)) == -signum(y.compareTo(x))` for all `x` and `y`. (This implies that `x.compareTo(y)` must throw an exception if and only if `y.compareTo(x)` throws an exception.) The implementor must also ensure that the relation is transitive: `(x.compareTo(y) > 0 && y.compareTo(z) > 0)` implies `x.compareTo(z) > 0`. Finally, the implementor must ensure that `x.compareTo(y)==0` implies that `signum(x.compareTo(z)) == signum(y.compareTo(z))`, for all `z`. Parameters o:InterfaceHttpData the object to be compared. Returns:int a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. Annotations @Override

public int compareTo(InterfaceHttpData o)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters

o:InterfaceHttpData: the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations

@Override

content back to summary

content	back to summary
public ByteBuf content() Implements io.netty.buffer.ByteBufHolder.content. Doc from io.netty.buffer.ByteBufHolder.content. Return the data which is held by this `ByteBufHolder`. Annotations @Override

public ByteBuf content()

Implements io.netty.buffer.ByteBufHolder.content.

Doc from io.netty.buffer.ByteBufHolder.content.

Return the data which is held by this ByteBufHolder.

Annotations

@Override

copy back to summary

copy	back to summary
public FileUpload copy() Implements io.netty.handler.codec.http.multipart.FileUpload.copy. Doc from io.netty.buffer.ByteBufHolder.copy. Creates a deep copy of this `ByteBufHolder`. Annotations @Override

public FileUpload copy()

Implements io.netty.handler.codec.http.multipart.FileUpload.copy.

Doc from io.netty.buffer.ByteBufHolder.copy.

Creates a deep copy of this ByteBufHolder.

Annotations

@Override

definedLength back to summary

definedLength	back to summary
public long definedLength() Implements io.netty.handler.codec.http.multipart.HttpData.definedLength. Doc from io.netty.handler.codec.http.multipart.HttpData.definedLength. Returns the defined length of the HttpData. If no Content-Length is provided in the request, the defined length is always 0 (whatever during decoding or in final state). If Content-Length is provided in the request, this is this given defined length. This value does not change, whatever during decoding or in the final state. This method could be used for instance to know the amount of bytes transmitted for one particular HttpData, for example one `FileUpload` or any known big `Attribute`. Returns:long the defined length of the HttpData Annotations @Override

public long definedLength()

Implements io.netty.handler.codec.http.multipart.HttpData.definedLength.

Doc from io.netty.handler.codec.http.multipart.HttpData.definedLength.

Returns the defined length of the HttpData. If no Content-Length is provided in the request, the defined length is always 0 (whatever during decoding or in final state). If Content-Length is provided in the request, this is this given defined length. This value does not change, whatever during decoding or in the final state. This method could be used for instance to know the amount of bytes transmitted for one particular HttpData, for example one FileUpload or any known big Attribute.

Returns:long

the defined length of the HttpData

Annotations

@Override

delete	back to summary
public void delete() Implements io.netty.handler.codec.http.multipart.HttpData.delete. Doc from io.netty.handler.codec.http.multipart.HttpData.delete. Deletes the underlying storage for a file item, including deleting any associated temporary disk file. Annotations @Override

delete

back to summary

public void delete()

Implements io.netty.handler.codec.http.multipart.HttpData.delete.

Doc from io.netty.handler.codec.http.multipart.HttpData.delete.

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

Annotations

@Override

duplicate back to summary

duplicate	back to summary
public FileUpload duplicate() Implements io.netty.handler.codec.http.multipart.FileUpload.duplicate. Doc from io.netty.buffer.ByteBufHolder.duplicate. Duplicates this `ByteBufHolder`. Be aware that this will not automatically call `retain()`.

public FileUpload duplicate()

Implements io.netty.handler.codec.http.multipart.FileUpload.duplicate.

Doc from io.netty.buffer.ByteBufHolder.duplicate.

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

end	back to summary
private void end()

endHandler	back to summary
private synchronized Handler<Void> endHandler()

endHandler	back to summary
public synchronized NettyFileUpload endHandler(Handler<Void> handler) Annotations @Override

exceptionHandler	back to summary
public synchronized NettyFileUpload exceptionHandler(Handler<Throwable> handler) Annotations @Override

fetch back to summary

fetch	back to summary
public NettyFileUpload fetch(long amount) Implements io.vertx.core.streams.ReadStream.fetch. Doc from io.vertx.core.streams.ReadStream.fetch. Fetch the specified `amount` of elements. If the `ReadStream` has been paused, reading will recommence with the specified `amount` of items, otherwise the specified `amount` will be added to the current stream demand. Returns:NettyFileUpload a reference to this, so the API can be used fluently Annotations @Override

public NettyFileUpload fetch(long amount)

Implements io.vertx.core.streams.ReadStream.fetch.

Doc from io.vertx.core.streams.ReadStream.fetch.

Fetch the specified amount of elements. If the ReadStream has been paused, reading will recommence with the specified amount of items, otherwise the specified amount will be added to the current stream demand.

Returns:NettyFileUpload

a reference to this, so the API can be used fluently

Annotations

@Override

get	back to summary
public byte[] get() throws IOException Implements io.netty.handler.codec.http.multipart.HttpData.get. Doc from io.netty.handler.codec.http.multipart.HttpData.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. Returns:byte[] the contents of the file item as an array of bytes. Annotations @Override

get

back to summary

public byte[] get() throws IOException

Implements io.netty.handler.codec.http.multipart.HttpData.get.

Doc from io.netty.handler.codec.http.multipart.HttpData.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.

Returns:byte[]

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

Annotations

@Override

getByteBuf	back to summary
public ByteBuf getByteBuf() throws IOException Implements io.netty.handler.codec.http.multipart.HttpData.getByteBuf. Doc from io.netty.handler.codec.http.multipart.HttpData.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. Returns:ByteBuf the content of the file item as a ByteBuf Annotations @Override

getByteBuf

back to summary

public ByteBuf getByteBuf() throws IOException

Implements io.netty.handler.codec.http.multipart.HttpData.getByteBuf.

Doc from io.netty.handler.codec.http.multipart.HttpData.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.

Returns:ByteBuf

the content of the file item as a ByteBuf

Annotations

@Override

getCharset	back to summary
public Charset getCharset() Implements io.netty.handler.codec.http.multipart.HttpData.getCharset. Doc from io.netty.handler.codec.http.multipart.HttpData.getCharset. Returns the Charset passed by the browser or null if not defined. Returns:Charset the Charset passed by the browser or null if not defined. Annotations @Override

getCharset

back to summary

public Charset getCharset()

Implements io.netty.handler.codec.http.multipart.HttpData.getCharset.

Doc from io.netty.handler.codec.http.multipart.HttpData.getCharset.

Returns the Charset passed by the browser or null if not defined.

Returns:Charset

the Charset passed by the browser or null if not defined.

Annotations

@Override

getChunk	back to summary
public ByteBuf getChunk(int i) throws IOException Implements io.netty.handler.codec.http.multipart.HttpData.getChunk. Doc from io.netty.handler.codec.http.multipart.HttpData.getChunk. 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:ByteBuf a ChannelBuffer for the content from the current position or an EMPTY_BUFFER if there is no more data to return Annotations @Override

getChunk

back to summary

public ByteBuf getChunk(int i) throws IOException

Implements io.netty.handler.codec.http.multipart.HttpData.getChunk.

Doc from io.netty.handler.codec.http.multipart.HttpData.getChunk.

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:ByteBuf

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

Annotations

@Override

getContentTransferEncoding	back to summary
public String getContentTransferEncoding() Implements io.netty.handler.codec.http.multipart.FileUpload.getContentTransferEncoding. Doc from io.netty.handler.codec.http.multipart.FileUpload.getContentTransferEncoding. Returns the Content-Transfer-Encoding Returns:String the Content-Transfer-Encoding Annotations @Override

getContentTransferEncoding

back to summary

public String getContentTransferEncoding()

Implements io.netty.handler.codec.http.multipart.FileUpload.getContentTransferEncoding.

Doc from io.netty.handler.codec.http.multipart.FileUpload.getContentTransferEncoding.

Returns the Content-Transfer-Encoding

Returns:String

the Content-Transfer-Encoding

Annotations

@Override

getContentType	back to summary
public String getContentType() Implements io.netty.handler.codec.http.multipart.FileUpload.getContentType. Doc from io.netty.handler.codec.http.multipart.FileUpload.getContentType. Returns the content type passed by the browser or null if not defined. Returns:String the content type passed by the browser or null if not defined. Annotations @Override

getContentType

back to summary

public String getContentType()

Implements io.netty.handler.codec.http.multipart.FileUpload.getContentType.

Doc from io.netty.handler.codec.http.multipart.FileUpload.getContentType.

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

Returns:String

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

Annotations

@Override

getFile	back to summary
public File getFile() throws IOException Implements io.netty.handler.codec.http.multipart.HttpData.getFile. Returns:File Doc from io.netty.handler.codec.http.multipart.HttpData.getFile. the associated File if this data is represented in a file Annotations @Override Exceptions IOException: Doc from io.netty.handler.codec.http.multipart.HttpData.getFile. if this data is not represented by a file

getFile

back to summary

public File getFile() throws IOException

Implements io.netty.handler.codec.http.multipart.HttpData.getFile.

Returns:File

Doc from io.netty.handler.codec.http.multipart.HttpData.getFile.

the associated File if this data is represented in a file

Annotations

@Override

Exceptions

IOException:

Doc from io.netty.handler.codec.http.multipart.HttpData.getFile.

if this data is not represented by a file

getFilename	back to summary
public String getFilename() Implements io.netty.handler.codec.http.multipart.FileUpload.getFilename. Doc from io.netty.handler.codec.http.multipart.FileUpload.getFilename. Returns the original filename in the client's filesystem, as provided by the browser (or other client software). Returns:String the original filename Annotations @Override

getFilename

back to summary

public String getFilename()

Implements io.netty.handler.codec.http.multipart.FileUpload.getFilename.

Doc from io.netty.handler.codec.http.multipart.FileUpload.getFilename.

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

Returns:String

the original filename

Annotations

@Override

getHttpDataType	back to summary
public InterfaceHttpData.HttpDataType getHttpDataType() Implements io.netty.handler.codec.http.multipart.InterfaceHttpData.getHttpDataType. Returns:InterfaceHttpData.HttpDataType Doc from io.netty.handler.codec.http.multipart.InterfaceHttpData.getHttpDataType. The HttpDataType Annotations @Override

getHttpDataType

back to summary

public InterfaceHttpData.HttpDataType getHttpDataType()

Implements io.netty.handler.codec.http.multipart.InterfaceHttpData.getHttpDataType.

Returns:InterfaceHttpData.HttpDataType

Doc from io.netty.handler.codec.http.multipart.InterfaceHttpData.getHttpDataType.

The HttpDataType

Annotations

@Override

getMaxSize	back to summary
public long getMaxSize() Implements io.netty.handler.codec.http.multipart.HttpData.getMaxSize. Doc from io.netty.handler.codec.http.multipart.HttpData.getMaxSize. Returns the maxSize for this HttpData. Annotations @Override

getMaxSize

back to summary

public long getMaxSize()

Implements io.netty.handler.codec.http.multipart.HttpData.getMaxSize.

Doc from io.netty.handler.codec.http.multipart.HttpData.getMaxSize.

Returns the maxSize for this HttpData.

Annotations

@Override

getName	back to summary
public String getName() Implements io.netty.handler.codec.http.multipart.InterfaceHttpData.getName. Doc from io.netty.handler.codec.http.multipart.InterfaceHttpData.getName. Returns the name of this InterfaceHttpData. Annotations @Override

getName

back to summary

public String getName()

Implements io.netty.handler.codec.http.multipart.InterfaceHttpData.getName.

Doc from io.netty.handler.codec.http.multipart.InterfaceHttpData.getName.

Returns the name of this InterfaceHttpData.

Annotations

@Override

getString	back to summary
public String getString() throws IOException Implements io.netty.handler.codec.http.multipart.HttpData.getString. Doc from io.netty.handler.codec.http.multipart.HttpData.getString. Returns the contents of the file item as a String, using the default character encoding. Returns:String the contents of the file item as a String, using the default character encoding. Annotations @Override

getString

back to summary

public String getString() throws IOException

Implements io.netty.handler.codec.http.multipart.HttpData.getString.

Doc from io.netty.handler.codec.http.multipart.HttpData.getString.

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

Returns:String

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

Annotations

@Override

getString	back to summary
public String getString(Charset charset) throws IOException Implements io.netty.handler.codec.http.multipart.HttpData.getString. Doc from io.netty.handler.codec.http.multipart.HttpData.getString. Returns the contents of the file item as a String, using the specified charset. Parameters charset:Charset the charset to use Returns:String the contents of the file item as a String, using the specified charset. Annotations @Override

getString

back to summary

public String getString(Charset charset) throws IOException

Implements io.netty.handler.codec.http.multipart.HttpData.getString.

Doc from io.netty.handler.codec.http.multipart.HttpData.getString.

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

Parameters

charset:Charset: the charset to use

Returns:String

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

Annotations

@Override

handleException	back to summary
public void handleException(Throwable err)

handler	back to summary
private Handler<Buffer> handler()

handler	back to summary
public synchronized NettyFileUpload handler(Handler<Buffer> handler) Annotations @Override

isCompleted	back to summary
public boolean isCompleted() Implements io.netty.handler.codec.http.multipart.HttpData.isCompleted. Returns:boolean Doc from io.netty.handler.codec.http.multipart.HttpData.isCompleted. True if the InterfaceHttpData is completed (all data are stored) Annotations @Override

isCompleted

back to summary

public boolean isCompleted()

Implements io.netty.handler.codec.http.multipart.HttpData.isCompleted.

Returns:boolean

Doc from io.netty.handler.codec.http.multipart.HttpData.isCompleted.

True if the InterfaceHttpData is completed (all data are stored)

Annotations

@Override

isInMemory	back to summary
public boolean isInMemory() Implements io.netty.handler.codec.http.multipart.HttpData.isInMemory. Doc from io.netty.handler.codec.http.multipart.HttpData.isInMemory. Provides a hint as to whether or not the file contents will be read from memory. Returns:boolean True if the file contents is in memory. Annotations @Override

isInMemory

back to summary

public boolean isInMemory()

Implements io.netty.handler.codec.http.multipart.HttpData.isInMemory.

Doc from io.netty.handler.codec.http.multipart.HttpData.isInMemory.

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

Returns:boolean

True if the file contents is in memory.

Annotations

@Override

length	back to summary
public long length() Implements io.netty.handler.codec.http.multipart.HttpData.length. Doc from io.netty.handler.codec.http.multipart.HttpData.length. Returns the size in byte of the InterfaceHttpData Returns:long the size of the InterfaceHttpData Annotations @Override

length

back to summary

public long length()

Implements io.netty.handler.codec.http.multipart.HttpData.length.

Doc from io.netty.handler.codec.http.multipart.HttpData.length.

Returns the size in byte of the InterfaceHttpData

Returns:long

the size of the InterfaceHttpData

Annotations

@Override

pause back to summary

pause	back to summary
public NettyFileUpload pause() Implements io.vertx.core.streams.ReadStream.pause. Doc from io.vertx.core.streams.ReadStream.pause. Pause the `ReadStream`, it sets the buffer in `fetch` mode and clears the actual demand. While it's paused, no data will be sent to the data `handler`. Returns:NettyFileUpload a reference to this, so the API can be used fluently Annotations @Override

public NettyFileUpload pause()

Implements io.vertx.core.streams.ReadStream.pause.

Doc from io.vertx.core.streams.ReadStream.pause.

Pause the ReadStream, it sets the buffer in fetch mode and clears the actual demand.

While it's paused, no data will be sent to the data handler.

Returns:NettyFileUpload

a reference to this, so the API can be used fluently

Annotations

@Override

receiveData	back to summary
private void receiveData(Buffer data) References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information.

refCnt back to summary

public int refCnt()

Implements io.netty.util.ReferenceCounted.refCnt.

Doc from io.netty.util.ReferenceCounted.refCnt.

Returns the reference count of this object. If 0, it means this object has been deallocated.

Annotations

@Override

release back to summary

public boolean release()

Implements io.netty.util.ReferenceCounted.release.

Doc from io.netty.util.ReferenceCounted.release.

Decreases the reference count by 1 and deallocates this object if the reference count reaches at 0.

Returns:boolean

true if and only if the reference count became 0 and this object has been deallocated

Annotations

@Override

release back to summary

public boolean release(int decrement)

Implements io.netty.util.ReferenceCounted.release.

Doc from io.netty.util.ReferenceCounted.release.

Decreases the reference count by the specified decrement and deallocates this object if the reference count reaches at 0.

Returns:boolean

true if and only if the reference count became 0 and this object has been deallocated

Annotations

@Override

renameTo

back to summary

public boolean renameTo(File file) throws IOException

Implements io.netty.handler.codec.http.multipart.HttpData.renameTo.

Doc from io.netty.handler.codec.http.multipart.HttpData.renameTo.

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

Parameters

file:File: destination file - must be not null

Returns:boolean

True if the write is successful

Annotations

@Override

replace back to summary

public FileUpload replace(ByteBuf content)

Implements io.netty.handler.codec.http.multipart.FileUpload.replace.

Doc from io.netty.buffer.ByteBufHolder.replace.

Returns a new ByteBufHolder which contains the specified content.

Annotations

@Override

resume back to summary

public NettyFileUpload resume()

Implements io.vertx.core.streams.ReadStream.resume.

Doc from io.vertx.core.streams.ReadStream.resume.

Resume reading, and sets the buffer in flowing mode.

If the ReadStream has been paused, reading will recommence on it.

Returns:NettyFileUpload

a reference to this, so the API can be used fluently

Annotations

@Override

retain back to summary

public FileUpload retain()

Implements io.netty.handler.codec.http.multipart.FileUpload.retain.

Doc from io.netty.util.ReferenceCounted.retain.

Increases the reference count by 1.

Annotations

@Override

retain back to summary

public FileUpload retain(int increment)

Implements io.netty.handler.codec.http.multipart.FileUpload.retain.

Doc from io.netty.util.ReferenceCounted.retain.

Increases the reference count by the specified increment.

Annotations

@Override

retainedDuplicate back to summary

public FileUpload retainedDuplicate()

Implements io.netty.handler.codec.http.multipart.FileUpload.retainedDuplicate.

Doc from io.netty.buffer.ByteBufHolder.retainedDuplicate.

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

Annotations

@Override

setCharset

back to summary

public void setCharset(Charset charset)

Implements io.netty.handler.codec.http.multipart.HttpData.setCharset.

Doc from io.netty.handler.codec.http.multipart.HttpData.setCharset.

Set the Charset passed by the browser if defined

Parameters

charset:Charset: Charset to set - must be not null

Annotations

@Override

setContent back to summary

public void setContent(ByteBuf channelBuffer) throws IOException

Implements io.netty.handler.codec.http.multipart.HttpData.setContent.

Doc from io.netty.handler.codec.http.multipart.HttpData.setContent.

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

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

Parameters

channelBuffer:ByteBuf: must be not null

Annotations

@Override

setContent

back to summary

public void setContent(File file) throws IOException

Implements io.netty.handler.codec.http.multipart.HttpData.setContent.

Doc from io.netty.handler.codec.http.multipart.HttpData.setContent.

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

Parameters

file:File: must be not null

Annotations

@Override

setContent

back to summary

public void setContent(InputStream inputStream) throws IOException

Implements io.netty.handler.codec.http.multipart.HttpData.setContent.

Doc from io.netty.handler.codec.http.multipart.HttpData.setContent.

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

Parameters

inputStream:InputStream: must be not null

Annotations

@Override

setContentTransferEncoding

back to summary

public void setContentTransferEncoding(String contentTransferEncoding)

Implements io.netty.handler.codec.http.multipart.FileUpload.setContentTransferEncoding.

Doc from io.netty.handler.codec.http.multipart.FileUpload.setContentTransferEncoding.

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

Annotations

@Override

setContentType

back to summary

public void setContentType(String contentType)

Implements io.netty.handler.codec.http.multipart.FileUpload.setContentType.

Doc from io.netty.handler.codec.http.multipart.FileUpload.setContentType.

Set the Content Type passed by the browser if defined

Parameters

contentType:String: Content Type to set - must be not null

Annotations

@Override

setFilename

back to summary

public void setFilename(String filename)

Implements io.netty.handler.codec.http.multipart.FileUpload.setFilename.

Doc from io.netty.handler.codec.http.multipart.FileUpload.setFilename.

Set the original filename

Annotations

@Override

setMaxSize

back to summary

public void setMaxSize(long maxSize)

Implements io.netty.handler.codec.http.multipart.HttpData.setMaxSize.

Doc from io.netty.handler.codec.http.multipart.HttpData.setMaxSize.

Set the maxSize for this HttpData. When limit will be reached, an exception will be raised. Setting it to (-1) means no limitation. By default, to be set from the HttpDataFactory.

Annotations

@Override

touch back to summary

public FileUpload touch(Object hint)

Implements io.netty.handler.codec.http.multipart.FileUpload.touch.

Doc from io.netty.util.ReferenceCounted.touch.

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.

Annotations

@Override

touch back to summary

public FileUpload touch()

Implements io.netty.handler.codec.http.multipart.FileUpload.touch.

Doc from io.netty.util.ReferenceCounted.touch.

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

Annotations

@Override

pack-priv final Class NettyFileUpload

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail