org.apache.axiom.mime.impl.axiom

Class MultipartWriterImpl

java.lang.Object

org.apache.axiom.mime.impl.axiom.MultipartWriterImpl

All Implemented Interfaces:

MultipartWriter

class MultipartWriterImpl
extends java.lang.Object
implements MultipartWriter

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	MultipartWriterImpl.PartOutputStream

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	boundary
private byte[]	buffer
private java.io.OutputStream	out

Constructor Summary

Constructors

Constructor and Description
MultipartWriterImpl(java.io.OutputStream out, java.lang.String boundary)

Method Summary

Modifier and Type	Method and Description
void	complete() Complete writing of the MIME multipart package.
(package private) void	writeAscii(java.lang.String s)
void	writePart(javax.activation.DataHandler dataHandler, java.lang.String contentTransferEncoding, java.lang.String contentID) Write a MIME part.
void	writePart(javax.activation.DataHandler dataHandler, java.lang.String contentTransferEncoding, java.lang.String contentID, java.util.List extraHeaders) Write a MIME part.
java.io.OutputStream	writePart(java.lang.String contentType, java.lang.String contentTransferEncoding, java.lang.String contentID) Start writing a MIME part.
java.io.OutputStream	writePart(java.lang.String contentType, java.lang.String contentTransferEncoding, java.lang.String contentID, java.util.List extraHeaders) Start writing a MIME part.

Methods inherited from class java.lang.Object

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

Field Detail

out

private final java.io.OutputStream out

boundary

private final java.lang.String boundary

buffer

private final byte[] buffer

Constructor Detail

MultipartWriterImpl

public MultipartWriterImpl(java.io.OutputStream out,
                           java.lang.String boundary)

Method Detail

writeAscii

void writeAscii(java.lang.String s)
         throws java.io.IOException

Throws:

java.io.IOException

writePart

public java.io.OutputStream writePart(java.lang.String contentType,
                                      java.lang.String contentTransferEncoding,
                                      java.lang.String contentID,
                                      java.util.List extraHeaders)
                               throws java.io.IOException

Description copied from interface: MultipartWriter

Start writing a MIME part. The method is similar to MultipartWriter.writePart(String, String, String) but accepts a list of additional headers for the MIME part.

Specified by:

writePart in interface MultipartWriter

Parameters:

contentType - the value of the Content-Type header of the MIME part

contentTransferEncoding - the content transfer encoding to be used (see above); must not be null

contentID - the content ID of the MIME part (see above)

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

Description copied from interface: MultipartWriter

Start writing a MIME part. The methods returns an OutputStream that the caller can use to write the content of the MIME part. After writing the content, OutputStream.close() must be called to complete the writing of the MIME part.

Specified by:

writePart in interface MultipartWriter

Parameters:

contentType - the value of the Content-Type header of the MIME part

contentTransferEncoding - the content transfer encoding to be used (see above); must not be null

contentID - the content ID of the MIME part (see above)

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 contentTransferEncoding,
                      java.lang.String contentID,
                      java.util.List extraHeaders)
               throws java.io.IOException

Description copied from interface: MultipartWriter

Write a MIME part. The content is provided by a DataHandler object, which also specifies the content type of the part. The method is similar to MultipartWriter.writePart(DataHandler, String, String) but accepts a list of additional headers for the MIME part.

Specified by:

writePart in interface MultipartWriter

Parameters:

dataHandler - the content of the MIME part to write

contentTransferEncoding - the content transfer encoding to be used (see above); must not be null

contentID - the content ID of the MIME part (see above)

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 contentTransferEncoding,
                      java.lang.String contentID)
               throws java.io.IOException

Description copied from interface: MultipartWriter

Write a MIME part. The content is provided by a DataHandler object, which also specifies the content type of the part.

Specified by:

writePart in interface MultipartWriter

Parameters:

dataHandler - the content of the MIME part to write

contentTransferEncoding - the content transfer encoding to be used (see above); must not be null

contentID - the content ID of the MIME part (see above)

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

Description copied from interface: MultipartWriter

Complete writing of the MIME multipart package. This method does not close the underlying stream.

Specified by:

complete in interface MultipartWriter

Throws:

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