org.apache.http.entity.mime
Class HttpMultipart

java.lang.Object
  org.apache.james.mime4j.message.Multipart
      org.apache.http.entity.mime.HttpMultipart

All Implemented Interfaces:

Body, Disposable

@NotThreadSafe
public class HttpMultipart
extends Multipart

An extension of the mime4j standard Multipart class, which is capable of operating either in the strict (fully RFC 822, RFC 2045, RFC 2046 compliant) or the browser compatible modes.

Since:

4.0

Constructor Summary

HttpMultipart(String subType)

Method Summary

protected String	getBoundary()
protected Charset	getCharset()
HttpMultipartMode	getMode()
long	getTotalLength() Determines the total length of the multipart content (content length of individual parts plus that of extra elements required to delimit the parts from one another).
void	setMode(HttpMultipartMode mode)
void	writeTo(OutputStream out) Writes out the content in the multipart/form encoding.

Methods inherited from class org.apache.james.mime4j.message.Multipart

addBodyPart, addBodyPart, dispose, getBodyParts, getCount, getEpilogue, getParent, getPreamble, getSubType, removeBodyPart, replaceBodyPart, setBodyParts, setEpilogue, setParent, setPreamble, setSubType

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpMultipart

public HttpMultipart(String subType)

Method Detail

getMode

public HttpMultipartMode getMode()

setMode

public void setMode(HttpMultipartMode mode)

getCharset

protected Charset getCharset()

getBoundary

protected String getBoundary()

writeTo

public void writeTo(OutputStream out)
             throws IOException

Writes out the content in the multipart/form encoding. This method produces slightly different formatting depending on its compatibility mode.

Throws:

IOException

See Also:

getMode()

getTotalLength

public long getTotalLength()

Determines the total length of the multipart content (content length of individual parts plus that of extra elements required to delimit the parts from one another). If any of the @{link BodyPart}s contained in this object is of a streaming entity of unknown length the total length is also unknown.

This method buffers only a small amount of data in order to determine the total length of the entire entity. The content of individual parts is not buffered.

Returns:

total length of the multipart entity if known, -1 otherwise.