Top Description Fields Constructors Methods
io.netty.contrib.handler.codec.http.multipart

public Class DiskFileUpload

extends AbstractDiskHttpData
implements FileUpload
Class Inheritance
All Implemented Interfaces
io.netty.contrib.handler.codec.http.multipart.FileUpload, io.netty.contrib.handler.codec.http.multipart.HttpData, io.netty.contrib.handler.codec.http.multipart.InterfaceHttpData, io.netty5.util.Resource, java.lang.AutoCloseable, java.lang.Comparable
Imports
io.netty5.buffer.Buffer, .Owned, io.netty5.channel.ChannelException, io.netty5.handler.codec.http.HttpHeaderNames, .HttpHeaderValues, io.netty5.util.internal.ObjectUtil, java.io.File, .IOException, java.nio.charset.Charset
Disk FileUpload implementation that stores file into real files

Field Summary

Modifier and TypeField and Description
private final String
baseDir

public static String
baseDirectory

private String
contentTransferEncoding

private String
contentType

private final boolean
deleteOnExit

public static boolean
deleteOnExitTemporaryFile

private String
filename

public static final String
postfix

public static final String
prefix

Constructor Summary

AccessConstructor and Description
public
DiskFileUpload(String name, String filename, String contentType, String contentTransferEncoding, Charset charset, long size, String baseDir, boolean deleteOnExit)

public
DiskFileUpload(String name, String filename, String contentType, String contentTransferEncoding, Charset charset, long size)

public
DiskFileUpload(DiskFileUpload copy)

Method Summary

Modifier and TypeMethod and Description
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 int
compareTo(FileUpload
the object to be compared.
o)

Implements java.lang.Comparable.compareTo.

Compares this object with the specified object for order.
public FileUpload
copy()

Implements io.netty.contrib.handler.codec.http.multipart.FileUpload.copy, io.netty.contrib.handler.codec.http.multipart.HttpData.copy.

Creates a deep copy of this HttpData.
protected boolean
deleteOnExit()

Implements abstract io.netty.contrib.handler.codec.http.multipart.AbstractDiskHttpData.deleteOnExit.

public boolean
equals(Object
the reference object with which to compare.
o)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
protected String
getBaseDirectory()

Implements abstract io.netty.contrib.handler.codec.http.multipart.AbstractDiskHttpData.getBaseDirectory.

public String
getContentTransferEncoding()

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

Returns the Content-Transfer-Encoding
public String
getContentType()

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

Returns the content type passed by the browser or null if not defined.
protected String
getDiskFilename()

Implements abstract io.netty.contrib.handler.codec.http.multipart.AbstractDiskHttpData.getDiskFilename.

public String
getFilename()

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

protected String
getPostfix()

Implements abstract io.netty.contrib.handler.codec.http.multipart.AbstractDiskHttpData.getPostfix.

protected String
getPrefix()

Implements abstract io.netty.contrib.handler.codec.http.multipart.AbstractDiskHttpData.getPrefix.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
protected Owned<AbstractHttpData>
prepareSend()

Implements abstract io.netty5.buffer.internal.ResourceSupport.prepareSend.

Prepare this instance for ownership transfer.
public FileUpload
replace(Buffer content)

Implements io.netty.contrib.handler.codec.http.multipart.FileUpload.replace, io.netty.contrib.handler.codec.http.multipart.HttpData.replace.

Returns a new HttpData which contains the specified content.
public void
setContentTransferEncoding(String contentTransferEncoding)

Implements io.netty.contrib.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.contrib.handler.codec.http.multipart.FileUpload.setContentType.

Set the Content Type passed by the browser if defined
public void
setFilename(String filename)

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

Set the original filename
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from io.netty.contrib.handler.codec.http.multipart.AbstractDiskHttpData:
addContentdeletegetgetChunkgetContentgetFilegetStringgetStringisInMemoryrenameTosetContentsetContentsetContentusingBuffer

Field Detail

baseDirback to summary
private final String baseDir
baseDirectoryback to summary
public static String baseDirectory
contentTransferEncodingback to summary
private String contentTransferEncoding
contentTypeback to summary
private String contentType
deleteOnExitback to summary
private final boolean deleteOnExit
deleteOnExitTemporaryFileback to summary
public static boolean deleteOnExitTemporaryFile
filenameback to summary
private String filename
postfixback to summary
public static final String postfix
prefixback to summary
public static final String prefix

Constructor Detail

DiskFileUploadback to summary
public DiskFileUpload(String name, String filename, String contentType, String contentTransferEncoding, Charset charset, long size, String baseDir, boolean deleteOnExit)
DiskFileUploadback to summary
public DiskFileUpload(String name, String filename, String contentType, String contentTransferEncoding, Charset charset, long size)
DiskFileUploadback to summary
public DiskFileUpload(DiskFileUpload copy)

Method Detail

compareToback 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
compareToback to summary
public int compareTo(FileUpload 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:FileUpload

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.

copyback to summary
public FileUpload copy()

Implements io.netty.contrib.handler.codec.http.multipart.FileUpload.copy, io.netty.contrib.handler.codec.http.multipart.HttpData.copy.

Doc from io.netty.contrib.handler.codec.http.multipart.HttpData.copy.

Creates a deep copy of this HttpData.

Annotations
@Override
deleteOnExitback to summary
protected boolean deleteOnExit()

Implements abstract io.netty.contrib.handler.codec.http.multipart.AbstractDiskHttpData.deleteOnExit.

Returns:boolean

Doc from io.netty.contrib.handler.codec.http.multipart.AbstractDiskHttpData.deleteOnExit.

True if the file should be deleted on Exit by default

Annotations
@Override
equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getBaseDirectoryback to summary
protected String getBaseDirectory()

Implements abstract io.netty.contrib.handler.codec.http.multipart.AbstractDiskHttpData.getBaseDirectory.

Returns:String

Doc from io.netty.contrib.handler.codec.http.multipart.AbstractDiskHttpData.getBaseDirectory.

the default base Directory

Annotations
@Override
getContentTransferEncodingback to summary
public String getContentTransferEncoding()

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

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

Returns the Content-Transfer-Encoding

Returns:String

the Content-Transfer-Encoding

Annotations
@Override
getContentTypeback to summary
public String getContentType()

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

Doc from io.netty.contrib.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
getDiskFilenameback to summary
protected String getDiskFilename()

Implements abstract io.netty.contrib.handler.codec.http.multipart.AbstractDiskHttpData.getDiskFilename.

Returns:String

Doc from io.netty.contrib.handler.codec.http.multipart.AbstractDiskHttpData.getDiskFilename.

the real DiskFilename (basename)

Annotations
@Override
getFilenameback to summary
public String getFilename()

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

Doc from io.netty.contrib.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
getHttpDataTypeback to summary
public InterfaceHttpData.HttpDataType getHttpDataType()

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

Returns:InterfaceHttpData.HttpDataType

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

The HttpDataType

Annotations
@Override
getPostfixback to summary
protected String getPostfix()

Implements abstract io.netty.contrib.handler.codec.http.multipart.AbstractDiskHttpData.getPostfix.

Returns:String

Doc from io.netty.contrib.handler.codec.http.multipart.AbstractDiskHttpData.getPostfix.

the default postfix

Annotations
@Override
getPrefixback to summary
protected String getPrefix()

Implements abstract io.netty.contrib.handler.codec.http.multipart.AbstractDiskHttpData.getPrefix.

Returns:String

Doc from io.netty.contrib.handler.codec.http.multipart.AbstractDiskHttpData.getPrefix.

the default prefix

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

Annotations
@Override
prepareSendback to summary
protected Owned<AbstractHttpData> prepareSend()

Implements abstract io.netty5.buffer.internal.ResourceSupport.prepareSend.

Doc from io.netty5.buffer.internal.ResourceSupport.prepareSend.

Prepare this instance for ownership transfer. This method is called from send() in the sending thread. This method should put this resource in a deactivated state where it is no longer accessible from the currently owning thread. In this state, the resource instance should only allow a call to Owned#transferOwnership(Drop) in the recipient thread.

Returns:Owned<AbstractHttpData>

This resource instance in a deactivated state.

Annotations
@Override
replaceback to summary
public FileUpload replace(Buffer content)

Implements io.netty.contrib.handler.codec.http.multipart.FileUpload.replace, io.netty.contrib.handler.codec.http.multipart.HttpData.replace.

Doc from io.netty.contrib.handler.codec.http.multipart.HttpData.replace.

Returns a new HttpData which contains the specified content.

Annotations
@Override
setContentTransferEncodingback to summary
public void setContentTransferEncoding(String contentTransferEncoding)

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

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

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

Annotations
@Override
setContentTypeback to summary
public void setContentType(String contentType)

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

Doc from io.netty.contrib.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
setFilenameback to summary
public void setFilename(String filename)

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

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

Set the original filename

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override