org.apache.james.mailbox.jcr.mail.model

Class JCRMessage

java.lang.Object

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

org.apache.james.mailbox.jcr.mail.model.JCRMessage

All Implemented Interfaces:

Comparable<Message<String>>, JCRImapConstants, Persistent, Message<String>

public class JCRMessage
extends AbstractMessage<String>
implements JCRImapConstants, Persistent

JCR implementation of Message

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANSWERED_PROPERTY
static String	BODY_START_OCTET_PROPERTY
static String	DELETED_PROPERTY
static String	DRAFT_PROPERTY
static String	FLAGGED_PROPERTY
static String	HEADER_NODE_TYPE
static String	INTERNAL_DATE_PROPERTY
static String	MAILBOX_UUID_PROPERTY
static String	MODSEQ_PROPERTY
static String	PROPERTY_NODE_TYPE
static String	RECENT_PROPERTY
static String	SEEN_PROPERTY
static String	SIZE_PROPERTY
static String	SUBTYPE_PROPERTY
static String	TEXTUAL_LINE_COUNT_PROPERTY
static String	UID_PROPERTY
static String	USERFLAGS_PROPERTY

Fields inherited from interface org.apache.james.mailbox.jcr.JCRImapConstants

NODE_DELIMITER

Constructor Summary

Constructors

Constructor and Description
JCRMessage(javax.jcr.Node node, org.slf4j.Logger logger)
JCRMessage(String mailboxUUID, Date internalDate, int size, javax.mail.Flags flags, javax.mail.internet.SharedInputStream content, int bodyStartOctet, PropertyBuilder propertyBuilder, org.slf4j.Logger logger)
JCRMessage(String mailboxUUID, long uid, long modSeq, JCRMessage message, org.slf4j.Logger logger) Create a copy of the given message

Method Summary

Methods

Modifier and Type	Method and Description
protected String[]	createUserFlags() Return all stored user flags or null if none are stored.
boolean	equals(Object obj)
InputStream	getBodyContent() Gets the body content of the document.
protected int	getBodyStartOctet() Return the start octet of the body
InputStream	getFullContent() This implementation just concat Message.getHeaderContent() and Message.getBodyContent().
long	getFullContentOctets() The number of octets contained in the full content of this document.
InputStream	getHeaderContent() Gets the header as InputStream.
String	getId()
Date	getInternalDate()
String	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
javax.jcr.Node	getNode() Return underlying Node
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
String	getUUID()
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	isPersistent() Return if the object is persistent
boolean	isRecent() Return if it was marked as recent
boolean	isSeen() Return if it was marked as seen
void	merge(javax.jcr.Node node) Merge the object with the node
void	setFlags(javax.mail.Flags flags) Set the Flags
void	setModSeq(long modSeq) Set the mod-sequence for the message.
void	setUid(long uid) Set the uid for the message.
String	toString()
void	unsetRecent()

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

compareTo, createFlags, getBodyOctets

Methods inherited from class java.lang.Object

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

Field Detail

MAILBOX_UUID_PROPERTY

public static final String MAILBOX_UUID_PROPERTY

See Also:

Constant Field Values

UID_PROPERTY

public static final String UID_PROPERTY

See Also:

Constant Field Values

SIZE_PROPERTY

public static final String SIZE_PROPERTY

See Also:

Constant Field Values

ANSWERED_PROPERTY

public static final String ANSWERED_PROPERTY

See Also:

Constant Field Values

DELETED_PROPERTY

public static final String DELETED_PROPERTY

See Also:

Constant Field Values

DRAFT_PROPERTY

public static final String DRAFT_PROPERTY

See Also:

Constant Field Values

FLAGGED_PROPERTY

public static final String FLAGGED_PROPERTY

See Also:

Constant Field Values

USERFLAGS_PROPERTY

public static final String USERFLAGS_PROPERTY

See Also:

Constant Field Values

RECENT_PROPERTY

public static final String RECENT_PROPERTY

See Also:

Constant Field Values

SEEN_PROPERTY

public static final String SEEN_PROPERTY

See Also:

Constant Field Values

INTERNAL_DATE_PROPERTY

public static final String INTERNAL_DATE_PROPERTY

See Also:

Constant Field Values

BODY_START_OCTET_PROPERTY

public static final String BODY_START_OCTET_PROPERTY

See Also:

Constant Field Values

HEADER_NODE_TYPE

public static final String HEADER_NODE_TYPE

See Also:

Constant Field Values

PROPERTY_NODE_TYPE

public static final String PROPERTY_NODE_TYPE

See Also:

Constant Field Values

TEXTUAL_LINE_COUNT_PROPERTY

public static final String TEXTUAL_LINE_COUNT_PROPERTY

See Also:

Constant Field Values

SUBTYPE_PROPERTY

public static final String SUBTYPE_PROPERTY

See Also:

Constant Field Values

MODSEQ_PROPERTY

public static final String MODSEQ_PROPERTY

See Also:

Constant Field Values

Constructor Detail

JCRMessage

public JCRMessage(javax.jcr.Node node,
          org.slf4j.Logger logger)

JCRMessage

public JCRMessage(String mailboxUUID,
          Date internalDate,
          int size,
          javax.mail.Flags flags,
          javax.mail.internet.SharedInputStream content,
          int bodyStartOctet,
          PropertyBuilder propertyBuilder,
          org.slf4j.Logger logger)

JCRMessage

public JCRMessage(String mailboxUUID,
          long uid,
          long modSeq,
          JCRMessage message,
          org.slf4j.Logger logger)
           throws MailboxException

Create a copy of the given message

Parameters:

message -

Throws:

IOException

MailboxException

Method Detail

getFullContentOctets

public long getFullContentOctets()

Description copied from interface: Message

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

Specified by:

getFullContentOctets in interface Message<String>

Returns:

number of octets

getMediaType

public String getMediaType()

Description copied from interface: Message

Gets the top level MIME content media type.

Specified by:

getMediaType in interface Message<String>

Returns:

top level MIME content media type, or null if default

getProperties

public List<Property> getProperties()

Description copied from interface: Message

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.

Specified by:

getProperties in interface Message<String>

Returns:

unmodifiable list of meta-data, not null

getSubType

public String getSubType()

Description copied from interface: Message

Gets the MIME content subtype.

Specified by:

getSubType in interface Message<String>

Returns:

the MIME content subtype, or null if default

getTextualLineCount

public Long getTextualLineCount()

Description copied from interface: Message

Gets the number of CRLF in a textual document.

Specified by:

getTextualLineCount in interface Message<String>

Returns:

CRLF count when document is textual, null otherwise

getNode

public javax.jcr.Node getNode()

Description copied from interface: Persistent

Return underlying Node

Specified by:

getNode in interface Persistent

Returns:

node

isPersistent

public boolean isPersistent()

Description copied from interface: Persistent

Return if the object is persistent

Specified by:

isPersistent in interface Persistent

Returns:

true if object is persistent else false

getUUID

public String getUUID()

merge

public void merge(javax.jcr.Node node)
           throws javax.jcr.RepositoryException,
                  IOException

Description copied from interface: Persistent

Merge the object with the node

Specified by:

merge in interface Persistent

Throws:

javax.jcr.RepositoryException

IOException

createUserFlags

protected String[] createUserFlags()

Description copied from class: AbstractMessage

Return all stored user flags or null if none are stored. By default this return null as no user flags are stored permanent. This method SHOULD get overridden, If the implementation supports to store user flags.

Overrides:

createUserFlags in class AbstractMessage<String>

Returns:

userFlags

getBodyStartOctet

protected int getBodyStartOctet()

Description copied from class: AbstractMessage

Return the start octet of the body

Specified by:

getBodyStartOctet in class AbstractMessage<String>

Returns:

startOctet

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getInternalDate

public Date getInternalDate()

Specified by:

getInternalDate in interface Message<String>

getMailboxId

public String getMailboxId()

Description copied from interface: Message

Return the mailbox id of the linked mailbox

Specified by:

getMailboxId in interface Message<String>

Returns:

mailboxId

getUid

public long getUid()

Description copied from interface: Message

Return the uid

Specified by:

getUid in interface Message<String>

Returns:

uid

isAnswered

public boolean isAnswered()

Description copied from interface: Message

Return if it was marked as answered

Specified by:

isAnswered in interface Message<String>

Returns:

answered

isDeleted

public boolean isDeleted()

Description copied from interface: Message

Return if it was mark as deleted

Specified by:

isDeleted in interface Message<String>

Returns:

deleted

isDraft

public boolean isDraft()

Description copied from interface: Message

Return if it was mark as draft

Specified by:

isDraft in interface Message<String>

Returns:

draft

isFlagged

public boolean isFlagged()

Description copied from interface: Message

Return if it was flagged

Specified by:

isFlagged in interface Message<String>

Returns:

flagged

isRecent

public boolean isRecent()

Description copied from interface: Message

Return if it was marked as recent

Specified by:

isRecent in interface Message<String>

Returns:

recent

isSeen

public boolean isSeen()

Description copied from interface: Message

Return if it was marked as seen

Specified by:

isSeen in interface Message<String>

Returns:

seen

setFlags

public void setFlags(javax.mail.Flags flags)

Description copied from interface: Message

Set the Flags

Specified by:

setFlags in interface Message<String>

unsetRecent

public void unsetRecent()

getId

public String getId()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getFullContent

public InputStream getFullContent()
                           throws IOException

Description copied from class: AbstractMessage

This implementation just concat Message.getHeaderContent() and Message.getBodyContent(). Implementation should override this if they can provide a more performant solution

Specified by:

getFullContent in interface Message<String>

Overrides:

getFullContent in class AbstractMessage<String>

Returns:

content

Throws:

IOException

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

Specified by:

getBodyContent in interface Message<String>

Returns:

body, not null

Throws:

IOException

getModSeq

public long getModSeq()

Description copied from interface: Message

Return the mod-sequence for the message

Specified by:

getModSeq in interface Message<String>

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.

Specified by:

setModSeq in interface Message<String>

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.

Specified by:

setUid in interface Message<String>

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

Specified by:

getHeaderContent in interface Message<String>

Returns:

header

Throws:

IOException