org.apache.james.mailbox.hbase.mail

Class HBaseMessage

java.lang.Object

org.apache.james.mailbox.store.mail.model.AbstractMessage<UUID>

org.apache.james.mailbox.hbase.mail.HBaseMessage

All Implemented Interfaces:

Comparable<Message<UUID>>, Message<UUID>

public class HBaseMessage
extends AbstractMessage<UUID>

Concrete HBaseMessage implementation. This implementation does not store any message content. The message content is retrieved using a ChunkedInputStream directly from HBase.

Constructor Summary

Constructors

Constructor and Description
HBaseMessage(org.apache.hadoop.conf.Configuration conf, UUID mailboxId, Date internalDate, javax.mail.Flags flags, long contentOctets, int bodyStartOctet, PropertyBuilder propertyBuilder) Create a copy of the given message.
HBaseMessage(org.apache.hadoop.conf.Configuration conf, UUID mailboxId, long uid, long modSeq, Message<?> original) Create a copy of the given message.

Method Summary

Methods

Modifier and Type	Method and Description
String[]	createUserFlags() This implementation supports user flags
boolean	equals(Object obj)
InputStream	getBodyContent() Gets the body content of the document.
protected int	getBodyStartOctet() Return the start octet of the body
long	getFullContentOctets() The number of octets contained in the full content of this document.
InputStream	getHeaderContent() Gets the header as InputStream.
Date	getInternalDate()
UUID	getMailboxId() Return the mailbox id of the linked mailbox
String	getMediaType() Gets the top level MIME content media type.
long	getModSeq() Return the mod-sequence for the message
List<Property>	getProperties() Gets a read-only list of meta-data properties.
String	getSubType() Gets the MIME content subtype.
Long	getTextualLineCount() Gets the number of CRLF in a textual document.
long	getUid() Return the uid
int	hashCode()
boolean	isAnswered() Return if it was marked as answered
boolean	isDeleted() Return if it was mark as deleted
boolean	isDraft() Return if it was mark as draft
boolean	isFlagged() Return if it was flagged
boolean	isRecent() Return if it was marked as recent
boolean	isSeen() Return if it was marked as seen
void	setFlags(javax.mail.Flags flags) Set the Flags
void	setModSeq(long modSeq) Set the mod-sequence for the message.
void	setTextualLineCount(Long textualLineCount)
void	setUid(long uid) Set the uid for the message.
String	toString()

Methods inherited from class org.apache.james.mailbox.store.mail.model.AbstractMessage

compareTo, createFlags, getBodyOctets, getFullContent

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HBaseMessage

public HBaseMessage(org.apache.hadoop.conf.Configuration conf,
            UUID mailboxId,
            long uid,
            long modSeq,
            Message<?> original)
             throws MailboxException

Create a copy of the given message. All properties are cloned except mailbox and UID.

Parameters:

mailboxId -

uid -

modSeq -

original -

Throws:

MailboxException

HBaseMessage

public HBaseMessage(org.apache.hadoop.conf.Configuration conf,
            UUID mailboxId,
            Date internalDate,
            javax.mail.Flags flags,
            long contentOctets,
            int bodyStartOctet,
            PropertyBuilder propertyBuilder)

Create a copy of the given message.

Parameters:

mailboxId -

internalDate -

flags -

contentOctets -

bodyStartOctet -

propertyBuilder -

Method Detail

getBodyContent

public InputStream getBodyContent()
                           throws IOException

Description copied from interface: Message

Gets the body content of the document. Headers are excluded. Be aware that this method need to return a new fresh InputStream on every call, which basicly means it need to start at position 0

Returns:

body, not null

Throws:

IOException

getHeaderContent

public InputStream getHeaderContent()
                             throws IOException

Description copied from interface: Message

Gets the header as InputStream. This MUST INCLUDE the CRLF terminator Be aware that this method need to return a new fresh InputStream on every call

Returns:

header

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getModSeq

public long getModSeq()

Description copied from interface: Message

Return the mod-sequence for the message

Returns:

message

setModSeq

public void setModSeq(long modSeq)

Description copied from interface: Message

Set the mod-sequence for the message. This must be called before the message is added to the store or any flags are changed. This must be unique / sequential.

getMediaType

public String getMediaType()

Gets the top level MIME content media type.

Returns:

top level MIME content media type, or null if default

getSubType

public String getSubType()

Gets the MIME content subtype.

Returns:

the MIME content subtype, or null if default

getProperties

public List<Property> getProperties()

Gets a read-only list of meta-data properties. For properties with multiple values, this list will contain several enteries with the same namespace and local name.

Returns:

unmodifiable list of meta-data, not null

getTextualLineCount

public Long getTextualLineCount()

Gets the number of CRLF in a textual document.

Returns:

CRLF count when document is textual, null otherwise

setTextualLineCount

public void setTextualLineCount(Long textualLineCount)

getFullContentOctets

public long getFullContentOctets()

Description copied from interface: Message

The number of octets contained in the full content of this document.

Returns:

number of octets

getBodyStartOctet

protected int getBodyStartOctet()

Description copied from class: AbstractMessage

Return the start octet of the body

Specified by:

getBodyStartOctet in class AbstractMessage<UUID>

Returns:

startOctet

getInternalDate

public Date getInternalDate()

See Also:

Message.getInternalDate()

getMailboxId

public UUID getMailboxId()

Description copied from interface: Message

Return the mailbox id of the linked mailbox

Returns:

mailboxId

See Also:

Message.getMailboxId()

getUid

public long getUid()

Description copied from interface: Message

Return the uid

Returns:

uid

See Also:

Message.getUid()

isAnswered

public boolean isAnswered()

Description copied from interface: Message

Return if it was marked as answered

Returns:

answered

See Also:

Message.isAnswered()

isDeleted

public boolean isDeleted()

Description copied from interface: Message

Return if it was mark as deleted

Returns:

deleted

See Also:

Message.isDeleted()

isDraft

public boolean isDraft()

Description copied from interface: Message

Return if it was mark as draft

Returns:

draft

See Also:

Message.isDraft()

isFlagged

public boolean isFlagged()

Description copied from interface: Message

Return if it was flagged

Returns:

flagged

See Also:

Message.isFlagged()

isRecent

public boolean isRecent()

Description copied from interface: Message

Return if it was marked as recent

Returns:

recent

See Also:

Message.isRecent()

isSeen

public boolean isSeen()

Description copied from interface: Message

Return if it was marked as seen

Returns:

seen

See Also:

Message.isSeen()

setUid

public void setUid(long uid)

Description copied from interface: Message

Set the uid for the message. This must be called before the message is added to the store and must be unique / sequential.

setFlags

public final void setFlags(javax.mail.Flags flags)

Description copied from interface: Message

Set the Flags

See Also:

Message.setFlags(javax.mail.Flags)

createUserFlags

public String[] createUserFlags()

This implementation supports user flags

Overrides:

createUserFlags in class AbstractMessage<UUID>

Returns:

userFlags

toString

public String toString()

Overrides:

toString in class Object