uk.ac.ed.epcc.webapp.editors.mail

Interface MessageProvider

All Known Implementing Classes:

AbstractMessageHandlerFactory.Provider, MessageData, MessageDataObject

public interface MessageProvider

This interface indicates an object that stores a MimeMessage In addition to get/set methods for the MimeMessage there are also accessor functions for top-level metadata like subject. This is to allow a 2-level implementation with a lightweight top level object only containing the metadata and a larger underlying object that is only accessed if the full message is required. The use of an interface also makes it easier to re-use code for different storage locations.

Method Summary

Modifier and Type	Method and Description
boolean	commit() persist message to database
MimeMessage	getMessage() get the MimeMessage
int	getMessageHash() get a hash for the message
java.lang.String	getRecipients()
java.lang.String	getSender()
java.lang.String	getSubject()
void	setMessage(MimeMessage m) set the MimeMessage to store

Method Detail

setMessage

void setMessage(MimeMessage m)

set the MimeMessage to store

Parameters:

m -

getMessage

MimeMessage getMessage()
                throws DataFault,
                       MessagingException

get the MimeMessage

Returns:

Throws:

DataFault

MessagingException

getMessageHash

int getMessageHash()

get a hash for the message

Returns:

getSubject

java.lang.String getSubject()

getRecipients

java.lang.String getRecipients()

getSender

java.lang.String getSender()

commit

boolean commit()
        throws DataFault

persist message to database

Returns:

true if changed

Throws:

DataFault