org.apache.axiom.om.impl
Class OMMultipartWriter

java.lang.Object
  org.apache.axiom.om.impl.OMMultipartWriter

public class OMMultipartWriter
extends Object

Writes a MIME multipart package as used by XOP/MTOM and SOAP with Attachments. This class wraps a MultipartWriter, providing a higher level API. In particular it will configure content types and content transfer encodings based on information from an OMOutputFormat object.

Constructor Summary

OMMultipartWriter(OutputStream out, OMOutputFormat format)

Method Summary

void	complete() Complete writing of the MIME multipart package.
String	getRootPartContentType() Get the content type of the root part, as determined by the OMOutputFormat passed to the constructor of this object.
void	writePart(DataHandler dataHandler, String contentID) Write a MIME part.
void	writePart(DataHandler dataHandler, String contentID, List extraHeaders) Write a MIME part.
OutputStream	writePart(String contentType, String contentID) Start writing an attachment part of the MIME package.
OutputStream	writePart(String contentType, String contentID, List extraHeaders) Start writing an attachment part of the MIME package.
OutputStream	writeRootPart() Start writing the root part of the MIME package.

Methods inherited from class java.lang.Object

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

Constructor Detail

OMMultipartWriter

public OMMultipartWriter(OutputStream out,
                         OMOutputFormat format)

Method Detail

getRootPartContentType

public String getRootPartContentType()

Get the content type of the root part, as determined by the OMOutputFormat passed to the constructor of this object.

Returns:

the content type of the root part

writeRootPart

public OutputStream writeRootPart()
                           throws IOException

Start writing the root part of the MIME package. This method delegates to MultipartWriter.writePart(String, String, String), but computes the content type, content transfer encoding and content ID from the OMOutputFormat.

Returns:

an output stream to write the content of the MIME part

Throws:

IOException - if an I/O error occurs when writing to the underlying stream

writePart

public OutputStream writePart(String contentType,
                              String contentID)
                       throws IOException

Start writing an attachment part of the MIME package. This method delegates to MultipartWriter.writePart(String, String, String), but computes the content transfer encoding based on the content type and the OMOutputFormat.

Parameters:

contentType - the content type of the MIME part to write

contentID - the content ID of the MIME part

Returns:

an output stream to write the content of the MIME part

Throws:

IOException - if an I/O error occurs when writing to the underlying stream

writePart

public OutputStream writePart(String contentType,
                              String contentID,
                              List extraHeaders)
                       throws IOException

Start writing an attachment part of the MIME package. This method delegates to MultipartWriter.writePart(String, String, String, List), but computes the content transfer encoding based on the content type and the OMOutputFormat.

Parameters:

contentType - the content type of the MIME part to write

contentID - the content ID of the MIME part

extraHeaders - a list of Header objects with additional headers to write to the MIME part

Returns:

an output stream to write the content of the MIME part

Throws:

IOException - if an I/O error occurs when writing to the underlying stream

writePart

public void writePart(DataHandler dataHandler,
                      String contentID,
                      List extraHeaders)
               throws IOException

Write a MIME part. This method delegates to MultipartWriter.writePart(DataHandler, String, String, List), but computes the appropriate content transfer encoding from the OMOutputFormat.

Parameters:

dataHandler - the content of the MIME part to write

contentID - the content ID of the MIME part

extraHeaders - a list of Header objects with additional headers to write to the MIME part

Throws:

IOException - if an I/O error occurs when writing the part to the underlying stream

writePart

public void writePart(DataHandler dataHandler,
                      String contentID)
               throws IOException

Write a MIME part. This method delegates to MultipartWriter.writePart(DataHandler, String, String), but computes the appropriate content transfer encoding from the OMOutputFormat.

Parameters:

dataHandler - the content of the MIME part to write

contentID - the content ID of the MIME part

Throws:

IOException - if an I/O error occurs when writing the part to the underlying stream

complete

public void complete()
              throws IOException

Complete writing of the MIME multipart package. This method delegates to MultipartWriter.complete().

Throws:

IOException - if an I/O error occurs when writing to the underlying stream