org.apache.axiom.om.impl

Class OMMultipartWriter

java.lang.Object

org.apache.axiom.om.impl.OMMultipartWriter

public class OMMultipartWriter
extends java.lang.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.

Field Summary

Fields

Modifier and Type	Field and Description
private OMOutputFormat	format
private java.lang.String	rootPartContentType
private boolean	useCTEBase64
private MultipartWriter	writer

Constructor Summary

Constructors

Constructor and Description
OMMultipartWriter(java.io.OutputStream out, OMOutputFormat format)

Method Summary

Modifier and Type	Method and Description
void	complete() Complete writing of the MIME multipart package.
private java.lang.String	getContentTransferEncoding(java.lang.String contentType)
java.lang.String	getRootPartContentType() Get the content type of the root part, as determined by the OMOutputFormat passed to the constructor of this object.
void	writePart(javax.activation.DataHandler dataHandler, java.lang.String contentID) Write a MIME part.
void	writePart(javax.activation.DataHandler dataHandler, java.lang.String contentID, java.util.List extraHeaders) Write a MIME part.
java.io.OutputStream	writePart(java.lang.String contentType, java.lang.String contentID) Start writing an attachment part of the MIME package.
java.io.OutputStream	writePart(java.lang.String contentType, java.lang.String contentID, java.util.List extraHeaders) Start writing an attachment part of the MIME package.
java.io.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

Field Detail

format

private final OMOutputFormat format

writer

private final MultipartWriter writer

useCTEBase64

private final boolean useCTEBase64

rootPartContentType

private final java.lang.String rootPartContentType

Constructor Detail

OMMultipartWriter

public OMMultipartWriter(java.io.OutputStream out,
                         OMOutputFormat format)

Method Detail

getContentTransferEncoding

private java.lang.String getContentTransferEncoding(java.lang.String contentType)

getRootPartContentType

public java.lang.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 java.io.OutputStream writeRootPart()
                                   throws java.io.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:

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

writePart

public java.io.OutputStream writePart(java.lang.String contentType,
                                      java.lang.String contentID)
                               throws java.io.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:

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

writePart

public java.io.OutputStream writePart(java.lang.String contentType,
                                      java.lang.String contentID,
                                      java.util.List extraHeaders)
                               throws java.io.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:

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

writePart

public void writePart(javax.activation.DataHandler dataHandler,
                      java.lang.String contentID,
                      java.util.List extraHeaders)
               throws java.io.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:

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

writePart

public void writePart(javax.activation.DataHandler dataHandler,
                      java.lang.String contentID)
               throws java.io.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:

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

complete

public void complete()
              throws java.io.IOException

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

Throws:

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