org.apache.james.mailbox.store

Class StoreSubscriptionManager

java.lang.Object

org.apache.james.mailbox.store.StoreSubscriptionManager

All Implemented Interfaces:

RequestAware, SubscriptionManager

Direct Known Subclasses:

JCRSubscriptionManager, JPASubscriptionManager

public class StoreSubscriptionManager
extends Object
implements SubscriptionManager

Manages subscriptions for Users and Mailboxes.

Field Summary

Fields

Modifier and Type	Field and Description
protected SubscriptionMapperFactory	mapperFactory

Constructor Summary

Constructors

Constructor and Description
StoreSubscriptionManager(SubscriptionMapperFactory mapperFactory)

Method Summary

Methods

Modifier and Type	Method and Description
protected Subscription	createSubscription(MailboxSession session, String mailbox) Create Subscription for the given user and mailbox.
void	endProcessingRequest(MailboxSession session) End the processing of a request for the given MailboxSession.
void	startProcessingRequest(MailboxSession session) Do nothing, Sub classes should override this if needed
void	subscribe(MailboxSession session, String mailbox) Subscribes the user in the session to the given mailbox.
Collection<String>	subscriptions(MailboxSession session) Finds all subscriptions for the user in the session.
void	unsubscribe(MailboxSession session, String mailbox) Unsubscribes the user in the session from the given mailbox.

Methods inherited from class java.lang.Object

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

Field Detail

mapperFactory

protected SubscriptionMapperFactory mapperFactory

Constructor Detail

StoreSubscriptionManager

public StoreSubscriptionManager(SubscriptionMapperFactory mapperFactory)

Method Detail

subscribe

public void subscribe(MailboxSession session,
             String mailbox)
               throws SubscriptionException

Description copied from interface: SubscriptionManager

Subscribes the user in the session to the given mailbox.

Specified by:

subscribe in interface SubscriptionManager

Parameters:

session - not null

mailbox - not null

Throws:

SubscriptionException - when subscription fails

See Also:

SubscriptionManager.subscribe(org.apache.james.mailbox.MailboxSession, java.lang.String)

createSubscription

protected Subscription createSubscription(MailboxSession session,
                              String mailbox)

Create Subscription for the given user and mailbox. By default a SimpleSubscription will get returned. If you need something more special just override this method

Parameters:

session -

mailbox -

Returns:

subscription

subscriptions

public Collection<String> subscriptions(MailboxSession session)
                                 throws SubscriptionException

Description copied from interface: SubscriptionManager

Finds all subscriptions for the user in the session.

Specified by:

subscriptions in interface SubscriptionManager

Parameters:

session - not null

Returns:

not null

Throws:

SubscriptionException - when subscriptions cannot be read

See Also:

SubscriptionManager.subscriptions(org.apache.james.mailbox.MailboxSession)

unsubscribe

public void unsubscribe(MailboxSession session,
               String mailbox)
                 throws SubscriptionException

Description copied from interface: SubscriptionManager

Unsubscribes the user in the session from the given mailbox.

Specified by:

unsubscribe in interface SubscriptionManager

Parameters:

session - not null

mailbox - not null

Throws:

SubscriptionException - when subscriptions cannot be read

See Also:

SubscriptionManager.unsubscribe(org.apache.james.mailbox.MailboxSession, java.lang.String)

endProcessingRequest

public void endProcessingRequest(MailboxSession session)

Description copied from interface: RequestAware

End the processing of a request for the given MailboxSession. If the user is not logged in already then the MailboxSession will be null

Specified by:

endProcessingRequest in interface RequestAware

See Also:

RequestAware.endProcessingRequest(org.apache.james.mailbox.MailboxSession)

startProcessingRequest

public void startProcessingRequest(MailboxSession session)

Do nothing, Sub classes should override this if needed

Specified by:

startProcessingRequest in interface RequestAware