public class

FilePart

extends PartBase

java.lang.Object
↳	com.ning.http.multipart.Part
	↳	com.ning.http.multipart.PartBase
		↳	com.ning.http.multipart.FilePart

Class Overview

This class is an adaptation of the Apache HttpClient implementationhttp://hc.apache.org/httpclient-3.x/

Summary

Constants
String	DEFAULT_CHARSET	Default charset of file attachments.
String	DEFAULT_CONTENT_TYPE	Default content encoding of file attachments.
String	DEFAULT_TRANSFER_ENCODING	Default transfer encoding of file attachments.
String	FILE_NAME	Attachment's file name

[Expand]

Inherited Constants

From class com.ning.http.multipart.Part

Public Constructors
	FilePart(String name, PartSource partSource) FilePart Constructor.
	FilePart(String name, PartSource partSource, String contentType, String charset) FilePart Constructor.
	FilePart(String name, File file) FilePart Constructor.
	FilePart(String name, File file, String contentType, String charset) FilePart Constructor.
	FilePart(String name, String fileName, File file) FilePart Constructor.
	FilePart(String name, String fileName, File file, String contentType, String charset) FilePart Constructor.

Public Methods
long	getStalledTime()
void	setStalledTime(long ms)

Protected Methods
PartSource	getSource() Returns the source of the file part.
long	lengthOfData() Return the length of the data.
void	sendData(OutputStream out) Write the data in "source" to the specified stream.
void	sendDispositionHeader(OutputStream out) Write the disposition header to the output stream

[Expand]

Inherited Methods

From class com.ning.http.multipart.PartBase

From class com.ning.http.multipart.Part

static String	getBoundary() This method is deprecated. uses a constant string. Rather use `getPartBoundary()`
abstract String	getCharSet() Return the character encoding of this part.
abstract String	getContentType() Returns the content type of this part.
static long	getLengthOfParts(Part[] parts) Return the total sum of all parts and that of the last boundary
static long	getLengthOfParts(Part[] parts, byte[] partBoundary) Gets the length of the multipart message including the given parts.
abstract String	getName() Return the name of this part.
byte[]	getPartBoundary() Gets the part boundary to be used.
abstract String	getTransferEncoding() Return the transfer encoding of this part.
boolean	isRepeatable() Tests if this part can be sent more than once.
long	length() Return the full length of all the data.
abstract long	lengthOfData() Return the length of the main content
void	send(OutputStream out) Write all the data to the output stream.
void	sendContentTypeHeader(OutputStream out) Write the content type header to the specified output stream
abstract void	sendData(OutputStream out) Write the data to the specified output stream
void	sendDispositionHeader(OutputStream out) Write the content disposition header to the specified output stream
void	sendEnd(OutputStream out) Write the end data to the output stream.
void	sendEndOfHeader(OutputStream out) Write the end of the header to the output stream
static void	sendMessageEnd(OutputStream out, byte[] partBoundary)
static void	sendPart(OutputStream out, Part part, byte[] partBoundary) Write all parts and the last boundary to the specified output stream.
static void	sendParts(OutputStream out, Part[] parts) Write all parts and the last boundary to the specified output stream.
static void	sendParts(OutputStream out, Part[] parts, byte[] partBoundary) Write all parts and the last boundary to the specified output stream.
void	sendStart(OutputStream out) Write the start to the specified output stream
void	sendTransferEncodingHeader(OutputStream out) Write the content transfer encoding header to the specified output stream
String	toString() Return a string representation of this object.

From class java.lang.Object

From interface com.ning.http.client.Part

Constants

public static final String DEFAULT_CHARSET

Default charset of file attachments.

Constant Value: "ISO-8859-1"

public static final String DEFAULT_CONTENT_TYPE

Default content encoding of file attachments.

Constant Value: "application/octet-stream"

public static final String DEFAULT_TRANSFER_ENCODING

Default transfer encoding of file attachments.

Constant Value: "binary"

protected static final String FILE_NAME

Attachment's file name

Constant Value: "; filename="

Public Constructors

public FilePart (String name, PartSource partSource)

FilePart Constructor.

Parameters

name	the name for this part
partSource	the source for this part

public FilePart (String name, PartSource partSource, String contentType, String charset)

FilePart Constructor.

Parameters

name	the name for this part
partSource	the source for this part
contentType	the content type for this part, if `null` the `default` is used
charset	the charset encoding for this part, if `null` the `default` is used

public FilePart (String name, File file)

FilePart Constructor.

Parameters

name	the name of the file part
file	the file to post

Throws

FileNotFoundException	if the file is not a normal file or if it is not readable.

public FilePart (String name, File file, String contentType, String charset)

FilePart Constructor.

Parameters

name	the name of the file part
file	the file to post
contentType	the content type for this part, if `null` the `default` is used
charset	the charset encoding for this part, if `null` the `default` is used

Throws

FileNotFoundException	if the file is not a normal file or if it is not readable.

public FilePart (String name, String fileName, File file)

FilePart Constructor.

Parameters

name	the name of the file part
fileName	the file name
file	the file to post

Throws

FileNotFoundException	if the file is not a normal file or if it is not readable.

public FilePart (String name, String fileName, File file, String contentType, String charset)

FilePart Constructor.

Parameters

name	the name of the file part
fileName	the file name
file	the file to post
contentType	the content type for this part, if `null` the `default` is used
charset	the charset encoding for this part, if `null` the `default` is used

Throws

FileNotFoundException	if the file is not a normal file or if it is not readable.

Public Methods

public long getStalledTime ()

public void setStalledTime (long ms)

Protected Methods

protected PartSource getSource ()

Returns the source of the file part.

Returns

The source.

protected long lengthOfData ()

Return the length of the data.

Returns

The length.

Throws

IOException	if an IO problem occurs

protected void sendData (OutputStream out)

Write the data in "source" to the specified stream.

Parameters

out	The output stream.

Throws

IOException	if an IO problem occurs.

protected void sendDispositionHeader (OutputStream out)

Write the disposition header to the output stream

Parameters

out	The output stream

Throws

IOException	If an IO problem occurs

Interfaces

Classes

Exceptions

FilePart

Class Overview

Summary

Constants

public static final String DEFAULT_CHARSET

public static final String DEFAULT_CONTENT_TYPE

public static final String DEFAULT_TRANSFER_ENCODING

protected static final String FILE_NAME

Public Constructors

public FilePart (String name, PartSource partSource)

Parameters

public FilePart (String name, PartSource partSource, String contentType, String charset)

Parameters

public FilePart (String name, File file)

Parameters

Throws

public FilePart (String name, File file, String contentType, String charset)

Parameters

Throws

public FilePart (String name, String fileName, File file)

Parameters

Throws

public FilePart (String name, String fileName, File file, String contentType, String charset)

Parameters

Throws

Public Methods

public long getStalledTime ()

public void setStalledTime (long ms)

Protected Methods

protected PartSource getSource ()

Returns

protected long lengthOfData ()

Returns

Throws

protected void sendData (OutputStream out)

Parameters

Throws

protected void sendDispositionHeader (OutputStream out)

Parameters

Throws