com.sun.xml.messaging.saaj.packaging.mime.internet

Class BMMimeMultipart

java.lang.Object

com.sun.xml.messaging.saaj.packaging.mime.internet.MimeMultipart

com.sun.xml.messaging.saaj.packaging.mime.internet.BMMimeMultipart

public class BMMimeMultipart
extends MimeMultipart

The MimeMultipart class is an implementation of the abstract Multipart class that uses MIME conventions for the multipart data.

A MimeMultipart is obtained from a MimePart whose primary type is "multipart" (by invoking the part's getContent() method) or it can be created by a client as part of creating a new MimeMessage.

The default multipart subtype is "mixed". The other multipart subtypes, such as "alternative", "related", and so on, can be implemented as subclasses of MimeMultipart with additional methods to implement the additional semantics of that type of multipart content. The intent is that service providers, mail JavaBean writers and mail clients will write many such subclasses and their Command Beans, and will install them into the JavaBeans Activation Framework, so that any JavaMail implementation and its clients can transparently find and use these classes. Thus, a MIME multipart handler is treated just like any other type handler, thereby decoupling the process of providing multipart handlers from the JavaMail API. Lacking these additional MimeMultipart subclasses, all subtypes of MIME multipart data appear as MimeMultipart objects.

An application can directly construct a MIME multipart object of any subtype by using the MimeMultipart(String subtype) constructor. For example, to create a "multipart/alternative" object, use new MimeMultipart("alternative").

Field Summary

Fields inherited from class com.sun.xml.messaging.saaj.packaging.mime.internet.MimeMultipart

contentType, ds, ignoreMissingEndBoundary, parent, parsed, parts

Constructor Summary

Constructors

Constructor and Description
BMMimeMultipart() Default constructor.
BMMimeMultipart(DataSource ds, ContentType ct) Constructs a MimeMultipart object and its bodyparts from the given DataSource.
BMMimeMultipart(String subtype) Construct a MimeMultipart object of the given subtype.

Method Summary

Modifier and Type	Method and Description
boolean	find(InputStream is, byte[] pattern, long[] posVector, ByteOutputStream out, SharedInputStream sin)
boolean	find(InputStream is, byte[] pattern, SharedInputStream sin)
String	getBoundary()
InputStream	getInputStream()
MimeBodyPart	getNextPart(InputStream stream, byte[] pattern, SharedInputStream sin)
InputStream	initStream()
boolean	isEndOfStream()
boolean	lastBodyPartFound()
protected void	parse() Parse the InputStream from our DataSource, constructing the appropriate MimeBodyParts.
boolean	parse(InputStream stream, byte[] pattern, SharedInputStream sin)
int	readNext(InputStream is, byte[] buff, int patternLength, BitSet eof, long[] posVector, SharedInputStream sin)
void	setBoundary(String bnd)
void	setInputStream(InputStream is)
void	setLazyAttachments(boolean flag)
void	writeTo(OutputStream os) Iterates through all the parts and outputs each Mime part separated by a boundary.

Methods inherited from class com.sun.xml.messaging.saaj.packaging.mime.internet.MimeMultipart

addBodyPart, addBodyPart, createInternetHeaders, createMimeBodyPart, createMimeBodyPart, getBodyPart, getBodyPart, getContentType, getCount, removeBodyPart, removeBodyPart, setMultipartDataSource, setSubType, updateHeaders

Methods inherited from class java.lang.Object

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

Constructor Detail

BMMimeMultipart

public BMMimeMultipart()

Default constructor. An empty MimeMultipart object is created. Its content type is set to "multipart/mixed". A unique boundary string is generated and this string is setup as the "boundary" parameter for the contentType field.

MimeBodyParts may be added later.

BMMimeMultipart

public BMMimeMultipart(String subtype)

Construct a MimeMultipart object of the given subtype. A unique boundary string is generated and this string is setup as the "boundary" parameter for the contentType field.

MimeBodyParts may be added later.

Parameters:

subtype - subtype.

BMMimeMultipart

public BMMimeMultipart(DataSource ds,
                       ContentType ct)
                throws MessagingException

Constructs a MimeMultipart object and its bodyparts from the given DataSource.

This constructor handles as a special case the situation where the given DataSource is a MultipartDataSource object. In this case, this method just invokes the superclass (i.e., Multipart) constructor that takes a MultipartDataSource object.

Otherwise, the DataSource is assumed to provide a MIME multipart byte stream. The parsed flag is set to false. When the data for the body parts are needed, the parser extracts the "boundary" parameter from the content type of this DataSource, skips the 'preamble' and reads bytes till the terminating boundary and creates MimeBodyParts for each part of the stream.

Parameters:

ct - content type.

ds - DataSource, can be a MultipartDataSource.

Throws:

MessagingException - in case of error.

Method Detail

initStream

public InputStream initStream()
                       throws MessagingException

Throws:

MessagingException

parse

protected void parse()
              throws MessagingException

Parse the InputStream from our DataSource, constructing the appropriate MimeBodyParts. The parsed flag is set to true, and if true on entry nothing is done. This method is called by all other methods that need data for the body parts, to make sure the data has been parsed.

Overrides:

parse in class MimeMultipart

Throws:

MessagingException - in case of error.

Since:

JavaMail 1.2

lastBodyPartFound

public boolean lastBodyPartFound()

getNextPart

public MimeBodyPart getNextPart(InputStream stream,
                                byte[] pattern,
                                SharedInputStream sin)
                         throws Exception

Throws:

Exception

parse

public boolean parse(InputStream stream,
                     byte[] pattern,
                     SharedInputStream sin)
              throws Exception

Throws:

Exception

readNext

public int readNext(InputStream is,
                    byte[] buff,
                    int patternLength,
                    BitSet eof,
                    long[] posVector,
                    SharedInputStream sin)
             throws Exception

Throws:

Exception

find

public boolean find(InputStream is,
                    byte[] pattern,
                    SharedInputStream sin)
             throws Exception

Throws:

Exception

find

public boolean find(InputStream is,
                    byte[] pattern,
                    long[] posVector,
                    ByteOutputStream out,
                    SharedInputStream sin)
             throws Exception

Throws:

Exception

writeTo

public void writeTo(OutputStream os)
             throws IOException,
                    MessagingException

Iterates through all the parts and outputs each Mime part separated by a boundary.

Overrides:

writeTo in class MimeMultipart

Parameters:

os - output stream.

Throws:

IOException - if an I/O Error occurs.

MessagingException - in case of error.

setInputStream

public void setInputStream(InputStream is)

getInputStream

public InputStream getInputStream()

setBoundary

public void setBoundary(String bnd)

getBoundary

public String getBoundary()

isEndOfStream

public boolean isEndOfStream()

setLazyAttachments

public void setLazyAttachments(boolean flag)