public class

MultipartRequestEntity

extends Object
implements RequestEntity
java.lang.Object
   ↳ com.ning.http.multipart.MultipartRequestEntity

Class Overview

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

Summary

Fields
protected Part[] parts The MIME parts as set by the constructor
Public Constructors
MultipartRequestEntity(Part[] parts, FluentStringsMap methodParams)
Creates a new multipart entity containing the given parts.
Public Methods
long getContentLength()
Gets the request entity's length.
String getContentType()
Gets the entity's content type.
boolean isRepeatable()
Returns true if all parts are repeatable, false otherwise.
void writeRequest(OutputStream out)
Writes the request entity to the given stream.
Protected Methods
byte[] getMultipartBoundary()
Returns the MIME boundary string that is used to demarcate boundaries of this part.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.ning.http.multipart.RequestEntity

Fields

protected Part[] parts

The MIME parts as set by the constructor

Public Constructors

public MultipartRequestEntity (Part[] parts, FluentStringsMap methodParams)

Creates a new multipart entity containing the given parts.

Parameters
parts The parts to include.
methodParams The params of the HttpMethod using this entity.

Public Methods

public long getContentLength ()

Gets the request entity's length. This method should return a non-negative value if the content length is known or a negative value if it is not. In the latter case the EntityEnclosingMethod will use chunk encoding to transmit the request entity.

Returns
  • a non-negative value when content length is known or a negative value when content length is not known

public String getContentType ()

Gets the entity's content type. This content type will be used as the value for the "Content-Type" header.

Returns
  • the entity's content type

public boolean isRepeatable ()

Returns true if all parts are repeatable, false otherwise.

Returns
  • true if the entity can be written to java.io.OutputStream more than once, false otherwise.

public void writeRequest (OutputStream out)

Writes the request entity to the given stream.

Throws
IOException

Protected Methods

protected byte[] getMultipartBoundary ()

Returns the MIME boundary string that is used to demarcate boundaries of this part. The first call to this method will implicitly create a new boundary string. To create a boundary string first the HttpMethodParams.MULTIPART_BOUNDARY parameter is considered. Otherwise a random one is generated.

Returns
  • The boundary string of this entity in ASCII encoding.