com.openexchange.mail.cache

Interface IMailAccessCache

All Known Implementing Classes:

EnqueueingMailAccessCache, SingletonMailAccessCache

public interface IMailAccessCache

IMailAccessCache - A very volatile cache for already connected instances of MailAccess.

Author:

Thorben Betten

Method Summary

Methods

Modifier and Type	Method and Description
void	clearUserEntries(com.openexchange.session.Session session) Clears the cache entries kept for specified user.
void	close() Closes this cache.
boolean	containsMailAccess(com.openexchange.session.Session session, int accountId) Checks if cache already holds a user-bound mail access for specified account.
int	numberOfMailAccesses(com.openexchange.session.Session session, int accountId) Gets the number of cached, user-bound mail accesses for specified account.
boolean	putMailAccess(com.openexchange.session.Session session, int accountId, MailAccess<? extends IMailFolderStorage,? extends IMailMessageStorage> mailAccess) Puts given mail access into cache if none user-bound connection is already contained in cache.
MailAccess<? extends IMailFolderStorage,? extends IMailMessageStorage>	removeMailAccess(com.openexchange.session.Session session, int accountId) Removes and returns a mail access from cache.

Method Detail

removeMailAccess

MailAccess<? extends IMailFolderStorage,? extends IMailMessageStorage> removeMailAccess(com.openexchange.session.Session session,
                                                                                      int accountId)

Removes and returns a mail access from cache.

Parameters:

session - The session

accountId - The account ID

Returns:

An active instance of MailAccess or null

putMailAccess

boolean putMailAccess(com.openexchange.session.Session session,
                    int accountId,
                    MailAccess<? extends IMailFolderStorage,? extends IMailMessageStorage> mailAccess)

Puts given mail access into cache if none user-bound connection is already contained in cache.

Parameters:

session - The session

accountId - The account ID

mailAccess - The mail access to put into cache

Returns:

true if mail access could be successfully cached; otherwise false

containsMailAccess

boolean containsMailAccess(com.openexchange.session.Session session,
                         int accountId)

Checks if cache already holds a user-bound mail access for specified account.

Parameters:

session - The session

accountId - The account ID

Returns:

true if a user-bound mail access is already present in cache; otherwise false

clearUserEntries

void clearUserEntries(com.openexchange.session.Session session)
                      throws com.openexchange.exception.OXException

Clears the cache entries kept for specified user.

Parameters:

session - The session

Throws:

com.openexchange.exception.OXException - If clearing user entries fails

numberOfMailAccesses

int numberOfMailAccesses(com.openexchange.session.Session session,
                       int accountId)
                         throws com.openexchange.exception.OXException

Gets the number of cached, user-bound mail accesses for specified account.

Parameters:

session - The session

accountId - The account ID

Returns:

The number of cached, user-bound mail accesses for specified account

Throws:

com.openexchange.exception.OXException

close

void close()

Closes this cache.