|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.sun.xml.messaging.saaj.packaging.mime.internet.MimeMultipart
com.sun.xml.messaging.saaj.packaging.mime.internet.BMMimeMultipart
public class BMMimeMultipart
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, parent, parsed, parts |
Constructor Summary | |
---|---|
BMMimeMultipart()
Default constructor. |
|
BMMimeMultipart(javax.activation.DataSource ds,
ContentType ct)
Constructs a MimeMultipart object and its bodyparts from the given DataSource. |
|
BMMimeMultipart(java.lang.String subtype)
Construct a MimeMultipart object of the given subtype. |
Method Summary | |
---|---|
boolean |
find(java.io.InputStream is,
byte[] pattern,
long[] posVector,
ByteOutputStream out,
SharedInputStream sin)
|
boolean |
find(java.io.InputStream is,
byte[] pattern,
SharedInputStream sin)
|
java.lang.String |
getBoundary()
|
java.io.InputStream |
getInputStream()
|
MimeBodyPart |
getNextPart(java.io.InputStream stream,
byte[] pattern,
SharedInputStream sin)
|
java.io.InputStream |
initStream()
|
boolean |
isEndOfStream()
|
boolean |
lastBodyPartFound()
|
protected void |
parse()
Parse the InputStream from our DataSource, constructing the appropriate MimeBodyParts. |
boolean |
parse(java.io.InputStream stream,
byte[] pattern,
SharedInputStream sin)
|
int |
readNext(java.io.InputStream is,
byte[] buff,
int patternLength,
java.util.BitSet eof,
long[] posVector,
SharedInputStream sin)
|
void |
setBoundary(java.lang.String bnd)
|
void |
setInputStream(java.io.InputStream is)
|
void |
setLazyAttachments(boolean flag)
|
void |
writeTo(java.io.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 |
---|
public BMMimeMultipart()
contentType
field. MimeBodyParts may be added later.
public BMMimeMultipart(java.lang.String subtype)
contentType
field. MimeBodyParts may be added later.
public BMMimeMultipart(javax.activation.DataSource ds, ContentType ct) throws MessagingException
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.
ds
- DataSource, can be a MultipartDataSource
MessagingException
Method Detail |
---|
public java.io.InputStream initStream() throws MessagingException
MessagingException
protected void parse() throws MessagingException
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.
parse
in class MimeMultipart
MessagingException
public boolean lastBodyPartFound()
public MimeBodyPart getNextPart(java.io.InputStream stream, byte[] pattern, SharedInputStream sin) throws java.lang.Exception
java.lang.Exception
public boolean parse(java.io.InputStream stream, byte[] pattern, SharedInputStream sin) throws java.lang.Exception
java.lang.Exception
public int readNext(java.io.InputStream is, byte[] buff, int patternLength, java.util.BitSet eof, long[] posVector, SharedInputStream sin) throws java.lang.Exception
java.lang.Exception
public boolean find(java.io.InputStream is, byte[] pattern, SharedInputStream sin) throws java.lang.Exception
java.lang.Exception
public boolean find(java.io.InputStream is, byte[] pattern, long[] posVector, ByteOutputStream out, SharedInputStream sin) throws java.lang.Exception
java.lang.Exception
public void writeTo(java.io.OutputStream os) throws java.io.IOException, MessagingException
MimeMultipart
writeTo
in class MimeMultipart
java.io.IOException
MessagingException
public void setInputStream(java.io.InputStream is)
public java.io.InputStream getInputStream()
public void setBoundary(java.lang.String bnd)
public java.lang.String getBoundary()
public boolean isEndOfStream()
public void setLazyAttachments(boolean flag)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |