Package org.apache.hc.client5.http.entity.mime

Class FileBody

java.lang.Object

org.apache.hc.client5.http.entity.mime.AbstractContentBody

org.apache.hc.client5.http.entity.mime.FileBody

All Implemented Interfaces:

ContentBody, ContentDescriptor

public class FileBody
extends AbstractContentBody

Binary body part backed by a file.

Since:

4.0

See Also:

MultipartEntityBuilder

Field Summary

Fields

Modifier and Type	Field	Description
private java.io.File	file
private java.lang.String	filename

Constructor Summary

Constructors

Constructor	Description
FileBody(java.io.File file)
FileBody(java.io.File file, org.apache.hc.core5.http.ContentType contentType)
FileBody(java.io.File file, org.apache.hc.core5.http.ContentType contentType, java.lang.String filename)

Method Summary

Modifier and Type	Method	Description
long	getContentLength()	Returns the body descriptors content-length.
java.io.File	getFile()
java.lang.String	getFilename()
java.io.InputStream	getInputStream()
void	writeTo(java.io.OutputStream out)

Methods inherited from class org.apache.hc.client5.http.entity.mime.AbstractContentBody

getCharset, getContentType, getMediaType, getMimeType, getSubType

Methods inherited from class java.lang.Object

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

Field Detail

file

private final java.io.File file

filename

private final java.lang.String filename

Constructor Detail

FileBody

public FileBody(java.io.File file)

FileBody

public FileBody(java.io.File file,
                org.apache.hc.core5.http.ContentType contentType,
                java.lang.String filename)

Since:

4.3

FileBody

public FileBody(java.io.File file,
                org.apache.hc.core5.http.ContentType contentType)

Since:

4.3

Method Detail

getInputStream

public java.io.InputStream getInputStream()
                                   throws java.io.IOException

Throws:

java.io.IOException

writeTo

public void writeTo(java.io.OutputStream out)
             throws java.io.IOException

Throws:

java.io.IOException

getContentLength

public long getContentLength()

Description copied from interface: ContentDescriptor

Returns the body descriptors content-length.

Returns:

Content length, if known, or -1, to indicate the absence of a content-length header.

getFilename

public java.lang.String getFilename()

getFile

public java.io.File getFile()