org.apache.james.mailbox.jpa.mail.model.openjpa

Class AbstractJPAMessage

java.lang.Object

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

org.apache.james.mailbox.jpa.mail.model.openjpa.AbstractJPAMessage

All Implemented Interfaces:

Comparable<Message<Long>>, Message<Long>

Direct Known Subclasses:

JPAEncryptedMessage, JPAMessage, JPAStreamingMessage

@MappedSuperclass
public abstract class AbstractJPAMessage
extends AbstractMessage<Long>

Abstract base class for JPA based implementations of AbstractMessage

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractJPAMessage.MailboxIdUidKey Identifies composite key

Constructor Summary

Constructors

Constructor and Description
AbstractJPAMessage() Deprecated.
AbstractJPAMessage(JPAMailbox mailbox, Date internalDate, javax.mail.Flags flags, long contentOctets, int bodyStartOctet, PropertyBuilder propertyBuilder)
AbstractJPAMessage(JPAMailbox mailbox, long uid, long modSeq, Message<?> original) Constructs a copy of the given message.

Method Summary

Methods

Modifier and Type	Method and Description
protected String[]	createUserFlags() This implementation supports user flags
boolean	equals(Object obj)
protected int	getBodyStartOctet() Return the start octet of the body
long	getFullContentOctets() The number of octets contained in the full content of this document.
Date	getInternalDate()
JPAMailbox	getMailbox() Utility getter on Mailbox.
Long	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	setMailbox(JPAMailbox mailbox) Utility setter on Mailbox.
void	setModSeq(long modSeq) Set the mod-sequence for the message.
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

Methods inherited from interface org.apache.james.mailbox.store.mail.model.Message

getBodyContent, getHeaderContent

Constructor Detail

AbstractJPAMessage

@Deprecated
public AbstractJPAMessage()

Deprecated.

AbstractJPAMessage

public AbstractJPAMessage(JPAMailbox mailbox,
                  Date internalDate,
                  javax.mail.Flags flags,
                  long contentOctets,
                  int bodyStartOctet,
                  PropertyBuilder propertyBuilder)

AbstractJPAMessage

public AbstractJPAMessage(JPAMailbox mailbox,
                  long uid,
                  long modSeq,
                  Message<?> original)
                   throws MailboxException

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

Parameters:

mailbox - new mailbox

uid - new UID

modSeq - new modSeq

original - message to be copied, not null

Throws:

IOException

MailboxException

Method Detail

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

See Also:

Message.getModSeq()

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.

See Also:

Message.setModSeq(long)

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

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

See Also:

Message.getFullContentOctets()

getBodyStartOctet

protected int getBodyStartOctet()

Description copied from class: AbstractMessage

Return the start octet of the body

Specified by:

getBodyStartOctet in class AbstractMessage<Long>

Returns:

startOctet

getInternalDate

public Date getInternalDate()

See Also:

Message.getInternalDate()

getMailboxId

public Long 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 void setFlags(javax.mail.Flags flags)

Description copied from interface: Message

Set the Flags

See Also:

Message.setFlags(javax.mail.Flags)

getMailbox

public JPAMailbox getMailbox()

Utility getter on Mailbox.

createUserFlags

protected String[] createUserFlags()

This implementation supports user flags

Overrides:

createUserFlags in class AbstractMessage<Long>

Returns:

userFlags

setMailbox

public void setMailbox(JPAMailbox mailbox)

Utility setter on Mailbox.

toString

public String toString()

Overrides:

toString in class Object