Package org.apache.http.entity.mime.content

Class FileBody

java.lang.Object

org.apache.http.entity.mime.content.AbstractContentBody

org.apache.http.entity.mime.content.FileBody

All Implemented Interfaces:

ContentBody, ContentDescriptor

public class FileBody
extends AbstractContentBody

Binary body part backed by a file.

Since:

4.0

See Also:

MultipartEntityBuilder

Constructor Summary

Constructors

Constructor	Description
FileBody(java.io.File file)
FileBody(java.io.File file, java.lang.String mimeType)	Deprecated. (4.3) use FileBody(File, ContentType) or MultipartEntityBuilder
FileBody(java.io.File file, java.lang.String mimeType, java.lang.String charset)	Deprecated. (4.3) use FileBody(File, ContentType) or MultipartEntityBuilder
FileBody(java.io.File file, java.lang.String filename, java.lang.String mimeType, java.lang.String charset)	Deprecated. (4.3) use FileBody(File, ContentType, String) or MultipartEntityBuilder
FileBody(java.io.File file, ContentType contentType)
FileBody(java.io.File file, 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()
java.lang.String	getTransferEncoding()	Returns the body descriptors transfer encoding.
void	writeTo(java.io.OutputStream out)

Methods inherited from class org.apache.http.entity.mime.content.AbstractContentBody

getCharset, getContentType, getMediaType, getMimeType, getSubType

Methods inherited from class java.lang.Object

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

Constructor Detail

FileBody

@Deprecated
public FileBody(java.io.File file,
                java.lang.String filename,
                java.lang.String mimeType,
                java.lang.String charset)

Deprecated.

(4.3) use FileBody(File, ContentType, String) or MultipartEntityBuilder

Since:

4.1

FileBody

@Deprecated
public FileBody(java.io.File file,
                java.lang.String mimeType,
                java.lang.String charset)

Deprecated.

(4.3) use FileBody(File, ContentType) or MultipartEntityBuilder

Since:

4.1

FileBody

@Deprecated
public FileBody(java.io.File file,
                java.lang.String mimeType)

Deprecated.

(4.3) use FileBody(File, ContentType) or MultipartEntityBuilder

FileBody

public FileBody(java.io.File file)

FileBody

public FileBody(java.io.File file,
                ContentType contentType,
                java.lang.String filename)

Since:

4.3

FileBody

public FileBody(java.io.File file,
                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

getTransferEncoding

public java.lang.String getTransferEncoding()

Description copied from interface: ContentDescriptor

Returns the body descriptors transfer encoding.

Returns:

The transfer encoding. Must not be null, but "7bit", if no transfer-encoding was specified.

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