org.apache.james.mailbox.store

Class MimeDescriptorImpl

java.lang.Object

org.apache.james.mailbox.store.MimeDescriptorImpl

All Implemented Interfaces:

Content, Headers, MimeDescriptor

public class MimeDescriptorImpl
extends Object
implements MimeDescriptor

Constructor Summary

Constructors

Constructor and Description

MimeDescriptorImpl(long bodyOctets, String contentDescription, String contentId, long lines, String subType, String type, String transferEncoding, Collection<MessageResult.Header> headers, Map<String,String> contentTypeParameters, List<String> languages, String disposition, Map<String,String> dispositionParams, MimeDescriptor embeddedMessage, Collection<MimeDescriptor> parts, String location, String md5)

Method Summary

Methods

Modifier and Type	Method and Description
static MimeDescriptorImpl	build(InputStream stream)
Map<String,String>	contentTypeParameters() Gets MIME body parameters parsed from Content-Type.
MimeDescriptor	embeddedMessage() Gets embedded message.
long	getBodyOctets() The number of octets contained in the body of this part.
String	getContentDescription() Gets MIME Content-Description header value.
String	getContentID() Gets the MIME Content-ID header value.
String	getContentLocation() Gets MIME Content-Location header value.
String	getContentMD5() Gets MIME Content-MD5 header value.
String	getDisposition() Gets MIME Content-Disposition.
Map<String,String>	getDispositionParams() Gets MIME Content-Disposition parameters.
InputStream	getInputStream() Return the content as InputStream
List<String>	getLanguages() Gets the languages, From the MIME Content-Language header value.
long	getLines() Gets the number of lines of text in a part of type TEXT when transfer encoded.
String	getMimeSubType() Gets the MIME content subtype.
String	getMimeType() Gets the top level MIME content media type.
String	getTransferContentEncoding() Gets the MIME content transfer encoding.
Iterator<MessageResult.Header>	headers() Gets headers for the message.
static boolean	isComposite(String mediaType) Is this a composite media type (as per RFC2045)? TODO: Move to Mime4j
Iterator<MimeDescriptor>	parts() Gets parts.
long	size() Size (in octets) of the content.

Methods inherited from class java.lang.Object

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

Constructor Detail

MimeDescriptorImpl

public MimeDescriptorImpl(long bodyOctets,
                  String contentDescription,
                  String contentId,
                  long lines,
                  String subType,
                  String type,
                  String transferEncoding,
                  Collection<MessageResult.Header> headers,
                  Map<String,String> contentTypeParameters,
                  List<String> languages,
                  String disposition,
                  Map<String,String> dispositionParams,
                  MimeDescriptor embeddedMessage,
                  Collection<MimeDescriptor> parts,
                  String location,
                  String md5)

Method Detail

isComposite

public static boolean isComposite(String mediaType)

Is this a composite media type (as per RFC2045)? TODO: Move to Mime4j

Parameters:

mediaType - possibly null

Returns:

true when the type is composite, false otherwise

build

public static MimeDescriptorImpl build(InputStream stream)
                                throws IOException,
                                       org.apache.james.mime4j.MimeException

Throws:

IOException

org.apache.james.mime4j.MimeException

contentTypeParameters

public Map<String,String> contentTypeParameters()

Description copied from interface: MimeDescriptor

Gets MIME body parameters parsed from Content-Type.

Specified by:

contentTypeParameters in interface MimeDescriptor

Returns:

Header Iterator, not null

embeddedMessage

public MimeDescriptor embeddedMessage()

Description copied from interface: MimeDescriptor

Gets embedded message.

Specified by:

embeddedMessage in interface MimeDescriptor

Returns:

MimeDescriptor when top level MIME type is message, null otherwise

getBodyOctets

public long getBodyOctets()

Description copied from interface: MimeDescriptor

The number of octets contained in the body of this part.

Specified by:

getBodyOctets in interface MimeDescriptor

Returns:

number of octets

getContentDescription

public String getContentDescription()

Description copied from interface: MimeDescriptor

Gets MIME Content-Description header value.

Specified by:

getContentDescription in interface MimeDescriptor

Returns:

MIME Content-Description, possibly null

getContentID

public String getContentID()

Description copied from interface: MimeDescriptor

Gets the MIME Content-ID header value.

Specified by:

getContentID in interface MimeDescriptor

Returns:

MIME Content-ID, possibly null

getLines

public long getLines()

Description copied from interface: MimeDescriptor

Gets the number of lines of text in a part of type TEXT when transfer encoded.

Specified by:

getLines in interface MimeDescriptor

Returns:

CRLF count when a TEXT type, otherwise -1

getMimeSubType

public String getMimeSubType()

Description copied from interface: MimeDescriptor

Gets the MIME content subtype.

Specified by:

getMimeSubType in interface MimeDescriptor

Returns:

the MIME content subtype, or null if default

getMimeType

public String getMimeType()

Description copied from interface: MimeDescriptor

Gets the top level MIME content media type.

Specified by:

getMimeType in interface MimeDescriptor

Returns:

top level MIME content media type, or null if default

getTransferContentEncoding

public String getTransferContentEncoding()

Description copied from interface: MimeDescriptor

Gets the MIME content transfer encoding.

Specified by:

getTransferContentEncoding in interface MimeDescriptor

Returns:

MIME Content-Transfer-Encoding, possibly null

headers

public Iterator<MessageResult.Header> headers()

Description copied from interface: Headers

Gets headers for the message.

Specified by:

headers in interface Headers

Returns:

Header Iterator, or null if MessageResult.FetchGroup.HEADERS was not fetched

parts

public Iterator<MimeDescriptor> parts()

Description copied from interface: MimeDescriptor

Gets parts.

Specified by:

parts in interface MimeDescriptor

Returns:

MimeDescriptor Iterator when a composite top level MIME media type, null otherwise

getLanguages

public List<String> getLanguages()

Description copied from interface: MimeDescriptor

Gets the languages, From the MIME Content-Language header value.

Specified by:

getLanguages in interface MimeDescriptor

Returns:

List of String names

getDisposition

public String getDisposition()

Description copied from interface: MimeDescriptor

Gets MIME Content-Disposition.

Specified by:

getDisposition in interface MimeDescriptor

Returns:

Content-Disposition, or null if no disposition header exists

getDispositionParams

public Map<String,String> getDispositionParams()

Description copied from interface: MimeDescriptor

Gets MIME Content-Disposition parameters.

Specified by:

getDispositionParams in interface MimeDescriptor

Returns:

Content-Disposition values indexed by names

getContentLocation

public String getContentLocation()

Description copied from interface: MimeDescriptor

Gets MIME Content-Location header value.

Specified by:

getContentLocation in interface MimeDescriptor

Returns:

parsed MIME Content-Location, possibly null

getContentMD5

public String getContentMD5()

Description copied from interface: MimeDescriptor

Gets MIME Content-MD5 header value.

Specified by:

getContentMD5 in interface MimeDescriptor

Returns:

parsed MIME Content-MD5, possibly null

getInputStream

public InputStream getInputStream()
                           throws IOException

Description copied from interface: Content

Return the content as InputStream

Specified by:

getInputStream in interface Content

Returns:

content

Throws:

IOException

size

public long size()
          throws MailboxException

Description copied from interface: Content

Size (in octets) of the content.

Specified by:

size in interface Content

Returns:

number of octets to be written

Throws:

MailboxException