org.apache.james.mailbox.store.user

Interface SubscriptionMapper

All Superinterfaces:

Mapper

All Known Implementing Classes:

HBaseSubscriptionMapper, InMemorySubscriptionMapper, JCRSubscriptionMapper, JPASubscriptionMapper, MaildirSubscriptionMapper

public interface SubscriptionMapper
extends Mapper

Mapper for Subscription

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.james.mailbox.store.transaction.Mapper

Mapper.Transaction<T>, Mapper.VoidTransaction

Method Summary

Methods

Modifier and Type	Method and Description
void	delete(Subscription subscription) Deletes the given subscription.
Subscription	findMailboxSubscriptionForUser(String user, String mailbox) Finds any subscriptions for a given user to the given mailbox.
List<Subscription>	findSubscriptionsForUser(String user) Finds subscriptions for the given user.
void	save(Subscription subscription) Saves the given subscription.

Methods inherited from interface org.apache.james.mailbox.store.transaction.Mapper

endRequest, execute

Method Detail

findMailboxSubscriptionForUser

Subscription findMailboxSubscriptionForUser(String user,
                                          String mailbox)
                                            throws SubscriptionException

Finds any subscriptions for a given user to the given mailbox.

Parameters:

user - not null

mailbox - not null

Returns:

Subscription, or null when the user is not subscribed to the given mailbox

Throws:

SubscriptionException

save

void save(Subscription subscription)
          throws SubscriptionException

Saves the given subscription.

Parameters:

subscription - not null

Throws:

SubscriptionException

findSubscriptionsForUser

List<Subscription> findSubscriptionsForUser(String user)
                                            throws SubscriptionException

Finds subscriptions for the given user.

Parameters:

user - not null

Returns:

not null

Throws:

SubscriptionException

delete

void delete(Subscription subscription)
            throws SubscriptionException

Deletes the given subscription.

Parameters:

subscription - not null

Throws:

SubscriptionException