com.google.api.client.http

Class MultipartFormDataContent

java.lang.Object

com.google.api.client.http.AbstractHttpContent

com.google.api.client.http.MultipartContent

com.google.api.client.http.MultipartFormDataContent

All Implemented Interfaces:

com.google.api.client.http.HttpContent, com.google.api.client.util.StreamingContent

@Beta
@NotThreadSafe
public class MultipartFormDataContent
extends com.google.api.client.http.MultipartContent

Serializes MIME "multipart/form-data" content as specified by RFC 2388: Returning Values from Forms: multipart/form-data

The implementation is a subclass of MultipartContent that sets the media type to "multipart/form-data" and defaults to DEFAULT_BOUNDARY as a boundary string.

The generated content output differs from the superclass one to specifically meet the "multipart/form-data" RFC specifications, for example omitting redundant headers in the content parts (except for nested "multipart" parts).

Shortcut method #addPart(Part, String, String) is provided in order to easily set name and file name for the mandatory header "Content-Disposition". This header can be manually set in each part's headers using the following format (but in this case no consistency checks are made and the request will most likely fail):

Content-Disposition: form-data; name="user"

Specifications on the "content-disposition" header (RFC 2183):
http://tools.ietf.org/html/rfc2183

For a reference on how to build a multipart/form-data request see:

• http://chxo.com/be2/20050724_93bf.html
• http://www.faqs.org/rfcs/rfc1867.html

Since:

1.0

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.http.MultipartContent

com.google.api.client.http.MultipartContent.Part

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	DEFAULT_BOUNDARY

Constructor Summary

Constructors

Constructor and Description
MultipartFormDataContent() Creates a new empty MultipartFormDataContent.

Method Summary

Methods

Modifier and Type	Method and Description
MultipartFormDataContent	addPart(com.google.api.client.http.MultipartContent.Part part)
MultipartFormDataContent	addPart(com.google.api.client.http.MultipartContent.Part part, java.lang.String dispositionName, java.lang.String dispositionFilename) Adds an HTTP multipart part.
protected static com.google.api.client.http.HttpMediaType	getMultipartFormDataMediaType() Factory method to create HttpMediaType with media type "multipart/form-data"
MultipartFormDataContent	setBoundary(java.lang.String boundary) Sets the boundary string to use (must be not null) If this is not called, the boundary defaults to DEFAULT_BOUNDARY
MultipartFormDataContent	setContentParts(java.util.Collection<? extends com.google.api.client.http.HttpContent> contentParts)
MultipartFormDataContent	setMediaType(com.google.api.client.http.HttpMediaType mediaType)
MultipartFormDataContent	setParts(java.util.Collection<com.google.api.client.http.MultipartContent.Part> parts)
void	writeTo(java.io.OutputStream out)

Methods inherited from class com.google.api.client.http.MultipartContent

getBoundary, getParts, retrySupported

Methods inherited from class com.google.api.client.http.AbstractHttpContent

computeLength, computeLength, getCharset, getLength, getMediaType, getType

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_BOUNDARY

protected static final java.lang.String DEFAULT_BOUNDARY

See Also:

Constant Field Values

Constructor Detail

MultipartFormDataContent

public MultipartFormDataContent()

Creates a new empty MultipartFormDataContent.

Method Detail

getMultipartFormDataMediaType

protected static final com.google.api.client.http.HttpMediaType getMultipartFormDataMediaType()

Factory method to create HttpMediaType with media type "multipart/form-data"

writeTo

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

Specified by:

writeTo in interface com.google.api.client.http.HttpContent

Specified by:

writeTo in interface com.google.api.client.util.StreamingContent

Overrides:

writeTo in class com.google.api.client.http.MultipartContent

Throws:

java.io.IOException

addPart

public MultipartFormDataContent addPart(@Nonnull
                               com.google.api.client.http.MultipartContent.Part part,
                               @Nonnull
                               java.lang.String dispositionName,
                               @Nullable
                               java.lang.String dispositionFilename)

Adds an HTTP multipart part.

This is a shortcut method to allow adding the specified name and (optional) filename are added in the "content-disposition" headers for the content (as per RFC 2183 par. 2). If the header is already specified in the added part, its value is overridden.

Parameters:

part - The Part to add to the content

dispositionName - The name of the part (usually the field name in a web form)

dispositionFilename - The optional filename of the part (usually for adding a FileContent part)

addPart

public MultipartFormDataContent addPart(@Nonnull
                               com.google.api.client.http.MultipartContent.Part part)

Overrides:

addPart in class com.google.api.client.http.MultipartContent

setParts

public MultipartFormDataContent setParts(@Nonnull
                                java.util.Collection<com.google.api.client.http.MultipartContent.Part> parts)

Overrides:

setParts in class com.google.api.client.http.MultipartContent

setContentParts

public MultipartFormDataContent setContentParts(@Nonnull
                                       java.util.Collection<? extends com.google.api.client.http.HttpContent> contentParts)

Overrides:

setContentParts in class com.google.api.client.http.MultipartContent

setMediaType

public final MultipartFormDataContent setMediaType(@Nullable
                                    com.google.api.client.http.HttpMediaType mediaType)

Overrides:

setMediaType in class com.google.api.client.http.MultipartContent

setBoundary

public MultipartFormDataContent setBoundary(@Nonnull
                                   java.lang.String boundary)

Sets the boundary string to use (must be not null)

If this is not called, the boundary defaults to DEFAULT_BOUNDARY

Overrides:

setBoundary in class com.google.api.client.http.MultipartContent

Parameters:

boundary - The new boundary for the content

Throws:

java.lang.NullPointerException - if boundary is null