org.jasig.portlet.emailpreview.dao

Class EmailAccountService

java.lang.Object

org.jasig.portlet.emailpreview.dao.EmailAccountService

All Implemented Interfaces:

IEmailAccountService

public class EmailAccountService
extends Object
implements IEmailAccountService

Implements the email account service, handling caching of data for efficiency.

Author:

James Wennmacher, jwennmacher@unicon.net

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	log

Constructor Summary

Constructors

Constructor and Description
EmailAccountService()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	deleteMessages(javax.portlet.PortletRequest req, String[] messageIds) Delete and expunge the specified massages from the store.
AccountSummary	getAccountSummary(javax.portlet.PortletRequest req, int start, int max, boolean refresh, String folder) Obtains the AccountSummary object from the data store itself, or possibly from cache.
List<javax.mail.Folder>	getAllUserInboxFolders(javax.portlet.PortletRequest req)
EmailMessage	getMessage(javax.portlet.PortletRequest req, String messageId) Retrieve an individual message from the mail store.
void	setAccountSummaryCacheKeyGenerator(IAccountSummaryCacheKeyGenerator accountSummaryCacheKeyGenerator)
void	setCredentialsService(ICredentialsProvider credentialsService)
void	setDao(IMailAccountDao dao)
void	setFolderCache(net.sf.ehcache.Cache folderCache)
void	setFolderCacheKeyGenerator(IMailAccountCacheKeyGenerator folderCacheKeyGenerator)
void	setFolderCacheKeyPrefix(String folderCacheKeyPrefix)
void	setInboxCache(net.sf.ehcache.Cache inboxCache)
boolean	setSeenFlag(javax.portlet.PortletRequest req, String[] messageIds, boolean read) Switch the value of the SEEN flag for the specified messages.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final org.slf4j.Logger log

Constructor Detail

EmailAccountService

public EmailAccountService()

Method Detail

setInboxCache

public void setInboxCache(net.sf.ehcache.Cache inboxCache)

setAccountSummaryCacheKeyGenerator

public void setAccountSummaryCacheKeyGenerator(IAccountSummaryCacheKeyGenerator accountSummaryCacheKeyGenerator)

setFolderCache

public void setFolderCache(net.sf.ehcache.Cache folderCache)

setFolderCacheKeyGenerator

public void setFolderCacheKeyGenerator(IMailAccountCacheKeyGenerator folderCacheKeyGenerator)

setFolderCacheKeyPrefix

public void setFolderCacheKeyPrefix(String folderCacheKeyPrefix)

setDao

public void setDao(IMailAccountDao dao)

setCredentialsService

public void setCredentialsService(ICredentialsProvider credentialsService)

getAccountSummary

public AccountSummary getAccountSummary(javax.portlet.PortletRequest req,
                               int start,
                               int max,
                               boolean refresh,
                               String folder)

Description copied from interface: IEmailAccountService

Obtains the AccountSummary object from the data store itself, or possibly from cache.

Specified by:

getAccountSummary in interface IEmailAccountService

Parameters:

req - The current PortletRequest

max - The maximum number of messages (header info) that may be returned with the summary

refresh - True if the concrete service implementation must not return cached data; otherwise false

Returns:

getMessage

public EmailMessage getMessage(javax.portlet.PortletRequest req,
                      String messageId)

Description copied from interface: IEmailAccountService

Retrieve an individual message from the mail store.

Specified by:

getMessage in interface IEmailAccountService

Parameters:

req - The current PortletRequest

messageId - messageId

Returns:

deleteMessages

public boolean deleteMessages(javax.portlet.PortletRequest req,
                     String[] messageIds)

Description copied from interface: IEmailAccountService

Delete and expunge the specified massages from the store. Supported for implementations that provide UIDs (e.g. UIDFolder) only.

Specified by:

deleteMessages in interface IEmailAccountService

Parameters:

req - The current PortletRequest

messageIds - List of messageIds to delete

Returns:

Success or failure

setSeenFlag

public boolean setSeenFlag(javax.portlet.PortletRequest req,
                  String[] messageIds,
                  boolean read)

Description copied from interface: IEmailAccountService

Switch the value of the SEEN flag for the specified messages. Supported for implementations that provide UIDs (e.g. UIDFolder) only.

Specified by:

setSeenFlag in interface IEmailAccountService

Parameters:

req - The current PortletRequest

read - The new value of the seen flag

Returns:

Success or failure

getAllUserInboxFolders

public List<javax.mail.Folder> getAllUserInboxFolders(javax.portlet.PortletRequest req)

Specified by:

getAllUserInboxFolders in interface IEmailAccountService