oracle.ifs.protocols.email.beans

Class BodyPart

java.lang.Object

oracle.ifs.protocols.email.beans.BodyPart

All Implemented Interfaces:

Serializable, BodyPartInterface

public class BodyPart
extends Object
implements Serializable, BodyPartInterface

The BodyPart class is used to organize information about the body parts of an e-mail. It is used to store the data needed to retrieve and process the body part that it represents from the ContentObject that stores the whole e-mail. This class does not have a database table associated with it, but rather all instances of it relating to a given e-mail are stored in a document, that is then refered to by an Attribute of the e-mail that the BodyPart instances describe.

Version:

1.0

Author:

Scott Harrison

See Also:

Serialized Form

(Published)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BodyPart.OffsetInputStream The OffsetInputStream class is used to select a range of bytes from an RACI and deliver those and only those bytes.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLASS_NAME This class name for this class.

Constructor Summary

Constructors

Constructor and Description
BodyPart() Constructs a BodyPart object.

Method Summary

Modifier and Type	Method and Description
void	addChild(BodyPart child) Adds a child to this body part.
void	addEncodedHeader(String name, String value) Adds a header to the body part.
void	addHeader(String name, String value) Adds a header to the body part.
void	contextIndex(boolean flag)
void	dump(String indent) Dumps a formatted version of the body part to stdout.
InputStream	getBodyStream() Get an InputStream containing the body of this body part.
long	getByteCount() Get the number of bytes in this body part.
Reader	getCleartextBodyReader() Get a Reader containing the decoded body of this body part.
Reader	getCleartextBodyReader(RandomAccessContentInterface raci) Get a Reader containing the decoded body of this body part.
InputStream	getCleartextBodyStream() Get an InputStream containing the decoded body of this body part.
InputStream	getCleartextBodyStream(RandomAccessContentInterface raci) Get an InputStream containing the decoded body of this body part.
InputStream	getContentStream() Get an InputStream containing this body part.
String	getContentType() Get the MIME content type/subtype
boolean	getContextIndex()
Dictionary	getEncodedHeaderDictionary() Get a Dictionary containing the headers of this body part indexed by header name.
String	getEncoding() Get the content transfer encoding of this body part
Dictionary	getHeaderDictionary() Get a Dictionary containing the headers of this body part indexed by header name.
InputStream	getHeaderStream() Get an InputStream containing the header of this body part.
void	getIndexableReaders(Vector readerVector, RandomAccessContentInterface raci)
InputStream	getInputStream() Get an InputStream containing this body part.
long	getLineCount() Get the number of lines in this body part.
String	getName() Get the name of this body part.
OutputStream	getOutputStream() Throws an exception.
PublicObjectInterface	getPublicObject() Get a PublicObject representing the content of this BodyPart
Vector	getSubParts() Get a Vector containing the child body parts of this body part.
void	setBodyOffset(long offset) Store the offset in the message of the body of this BodyPart
void	setByteCount(long byteCount) Store the number of bytes in this BodyPart
void	setCharset(String charSet) Set the character set of this body part.
void	setContentSubtype(String contentSubtype) Store the content subtype of this body part
void	setContentType(String contentType) Store the content type of this body part
void	setEncoding(String encoding) Set the content transfer encoding of this body part.
void	setEndOffset(long offset) Store the offset in the message of the end of this BodyPart
void	setHeaderOffset(long offset) Store the offset in the message of the header of this BodyPart
void	setLineCount(long lineCount) Store the number of lines in this BodyPart
void	setMsg(Document msg)
void	updateByteCount()

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_NAME

public static final String CLASS_NAME

This class name for this class. Useful for methods that take a class name argument.

See Also:

Constant Field Values

(Published)

Constructor Detail

BodyPart

public BodyPart()

Constructs a BodyPart object. This is used to create any subsiduary BodyPart objects in a multipart e-mail.

Method Detail

addHeader

public void addHeader(String name,
                      String value)

Adds a header to the body part. The value of the header is decoded via ImapEncodedWord.decode().

Parameters:

name - the name of the header

value - the value of the header

(Unpublished)

addEncodedHeader

public void addEncodedHeader(String name,
                             String value)

Adds a header to the body part. The value of the header is the original encoded value.

Parameters:

name - the name of the header

value - the value of the header is the original encoded value

(Unpublished)

addChild

public void addChild(BodyPart child)

Adds a child to this body part. Implies that this body part has a content type of multipart.

Parameters:

child - The child BodyPart to be added.

(Published)

setMsg

public void setMsg(Document msg)

setHeaderOffset

public void setHeaderOffset(long offset)

Store the offset in the message of the header of this BodyPart

Parameters:

offset - The offset in the message of the header of this BodyPart

(Unpublished)

setBodyOffset

public void setBodyOffset(long offset)

Store the offset in the message of the body of this BodyPart

Parameters:

offset - The offset in the message of the body of this BodyPart

(Unpublished)

setEndOffset

public void setEndOffset(long offset)

Store the offset in the message of the end of this BodyPart

Parameters:

offset - The offset in the message of the end of this BodyPart

(Unpublished)

setByteCount

public void setByteCount(long byteCount)

Store the number of bytes in this BodyPart

Parameters:

byteCount - The number of bytes in this BodyPart

(Unpublished)

setLineCount

public void setLineCount(long lineCount)

Store the number of lines in this BodyPart

Parameters:

lineCount - The number of lines in this BodyPart

(Unpublished)

setContentType

public void setContentType(String contentType)

Store the content type of this body part

Parameters:

contentType - The MIME content type of this body part.

(Unpublished)

setContentSubtype

public void setContentSubtype(String contentSubtype)

Store the content subtype of this body part

Parameters:

contentSubtype - The MIME content subtype of this body part.

(Unpublished)

setEncoding

public void setEncoding(String encoding)

Set the content transfer encoding of this body part.

Parameters:

encoding -

(Unpublished)

setCharset

public void setCharset(String charSet)

Set the character set of this body part.

Parameters:

charSet -

(Unpublished)

getHeaderDictionary

public Dictionary getHeaderDictionary()

Get a Dictionary containing the headers of this body part indexed by header name.

Specified by:

getHeaderDictionary in interface BodyPartInterface

Returns:

a Dictionary containing all the headers of this body part.

(Published)

getEncodedHeaderDictionary

public Dictionary getEncodedHeaderDictionary()

Get a Dictionary containing the headers of this body part indexed by header name. The values of the headers are the original encoded values.

Returns:

a Dictionary containing all the headers of this body part.

(Unpublished)

getLineCount

public long getLineCount()

Get the number of lines in this body part.

Specified by:

getLineCount in interface BodyPartInterface

Returns:

count of lines in this body part

(Published)

getByteCount

public long getByteCount()

Get the number of bytes in this body part.

Specified by:

getByteCount in interface BodyPartInterface

Returns:

count of bytes in this body part

(Published)

getCleartextBodyStream

public InputStream getCleartextBodyStream(RandomAccessContentInterface raci)
                                   throws IOException,
                                          IfsException

Get an InputStream containing the decoded body of this body part. That is the body after having any content transfer encoding reversed.

Returns:

InputStream containing decoded body of body part

Throws:

IOException

IfsException

(Published)

getCleartextBodyStream

public InputStream getCleartextBodyStream()
                                   throws IOException,
                                          IfsException

Get an InputStream containing the decoded body of this body part. That is the body after having any content transfer encoding reversed.

Specified by:

getCleartextBodyStream in interface BodyPartInterface

Returns:

InputStream containing decoded body of body part

Throws:

IOException

IfsException

(Published)

getCleartextBodyReader

public Reader getCleartextBodyReader(RandomAccessContentInterface raci)
                              throws IOException,
                                     IfsException,
                                     UnsupportedEncodingException

Get a Reader containing the decoded body of this body part. That is the body after having any content transfer encoding reversed.

Returns:

Reader containing decoded body of body part

Throws:

IOException

IfsException

UnsupportedEncodingException

(Published)

getCleartextBodyReader

public Reader getCleartextBodyReader()
                              throws IOException,
                                     IfsException,
                                     UnsupportedEncodingException

Get a Reader containing the decoded body of this body part. That is the body after having any content transfer encoding reversed.

Returns:

Reader containing decoded body of body part

Throws:

IOException

IfsException

UnsupportedEncodingException

(Published)

getSubParts

public Vector getSubParts()

Get a Vector containing the child body parts of this body part.

Specified by:

getSubParts in interface BodyPartInterface

Returns:

Vector containing the child body parts of this body part.

(Published)

getEncoding

public String getEncoding()

Get the content transfer encoding of this body part

Specified by:

getEncoding in interface BodyPartInterface

Returns:

a String containing the content transfer encoding of this body part.

(Published)

getContentType

public String getContentType()

Get the MIME content type/subtype

Specified by:

getContentType in interface BodyPartInterface

Returns:

a String containing the MIME content type/subtype pair.

(Published)

getBodyStream

public InputStream getBodyStream()
                          throws IOException,
                                 IfsException

Get an InputStream containing the body of this body part.

Specified by:

getBodyStream in interface BodyPartInterface

Returns:

an InputStream containing the body of this body part.

Throws:

IOException

IfsException

(Published)

updateByteCount

public void updateByteCount()
                     throws IOException,
                            IfsException

Throws:

IOException

IfsException

getHeaderStream

public InputStream getHeaderStream()
                            throws IOException,
                                   IfsException

Get an InputStream containing the header of this body part.

Specified by:

getHeaderStream in interface BodyPartInterface

Returns:

an InputStream containing the header of this body part.

Throws:

IOException

IfsException

(Published)

getInputStream

public InputStream getInputStream()
                           throws IOException

Get an InputStream containing this body part. This is the same as getBodyStream, but is here for the DataSource interface.

Returns:

an InputStream containing this body part.

Throws:

IOException

(Published)

getOutputStream

public OutputStream getOutputStream()
                             throws IOException

Throws an exception. This is here for the DataSource interface

Returns:

an OutputStream to modify the body part

Throws:

IOException

(Published)

getName

public String getName()

Get the name of this body part. This is here for the DataSource interface.

Returns:

a String containing the name of the body part.

(Published)

getContentStream

public InputStream getContentStream()
                             throws IOException,
                                    IfsException

Get an InputStream containing this body part.

Specified by:

getContentStream in interface BodyPartInterface

Returns:

an InputStream containing this body part.

Throws:

IOException

IfsException

(Published)

contextIndex

public void contextIndex(boolean flag)

getContextIndex

public boolean getContextIndex()

getPublicObject

public PublicObjectInterface getPublicObject()
                                      throws IfsException

Get a PublicObject representing the content of this BodyPart

Returns:

a PublicObject containing the content of this BodyPart

Throws:

IfsException

(Published)

dump

public void dump(String indent)
          throws IOException,
                 IfsException

Dumps a formatted version of the body part to stdout.

Parameters:

indent - The string to print before each line of the formatted output.

Throws:

IOException

IfsException

(Unpublished)

getIndexableReaders

public void getIndexableReaders(Vector readerVector,
                                RandomAccessContentInterface raci)
                         throws IOException,
                                IfsException

Throws:

IOException

IfsException