com.openexchange.mail.cache

Class EnqueueingMailAccessCache

java.lang.Object

com.openexchange.mail.cache.EnqueueingMailAccessCache

All Implemented Interfaces:

IMailAccessCache

public final class EnqueueingMailAccessCache
extends java.lang.Object
implements IMailAccessCache

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

A bounded Queue is used to store MailAccess instances to improve subsequent mail requests.

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.
static EnqueueingMailAccessCache	getInstance(int queueCapacity) Gets the singleton instance.
static EnqueueingMailAccessCache	newInstance(int queueCapacity) Creates a new EnqueueingMailAccessCache
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.
static void	releaseInstance() Releases the singleton instance.
MailAccess<? extends IMailFolderStorage,? extends IMailMessageStorage>	removeMailAccess(com.openexchange.session.Session session, int accountId) Removes and returns a mail access from cache.

Methods inherited from class java.lang.Object

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

Method Detail

newInstance

public static EnqueueingMailAccessCache newInstance(int queueCapacity)
                                             throws com.openexchange.exception.OXException

Creates a new EnqueueingMailAccessCache

Returns:

A new EnqueueingMailAccessCache

Throws:

com.openexchange.exception.OXException - If initialization fails

getInstance

public static EnqueueingMailAccessCache getInstance(int queueCapacity)
                                             throws com.openexchange.exception.OXException

Gets the singleton instance.

Returns:

The singleton instance

Throws:

com.openexchange.exception.OXException - If instance initialization fails

releaseInstance

public static void releaseInstance()

Releases the singleton instance.

numberOfMailAccesses

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

Description copied from interface: IMailAccessCache

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

Specified by:

numberOfMailAccesses in interface IMailAccessCache

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

removeMailAccess

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

Removes and returns a mail access from cache.

Specified by:

removeMailAccess in interface IMailAccessCache

Parameters:

session - The session

accountId - The account ID

Returns:

An active instance of MailAccess or null

putMailAccess

public 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.

Specified by:

putMailAccess in interface IMailAccessCache

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

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

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

Specified by:

containsMailAccess in interface IMailAccessCache

Parameters:

session - The session

accountId - The account ID

Returns:

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

close

public void close()

Description copied from interface: IMailAccessCache

Closes this cache.

Specified by:

close in interface IMailAccessCache

clearUserEntries

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

Clears the cache entries kept for specified user.

Specified by:

clearUserEntries in interface IMailAccessCache

Parameters:

session - The session

Throws:

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