com.google.api.client.googleapis.subscriptions

Interface SubscriptionStore

All Known Implementing Classes:

MemorySubscriptionStore

public interface SubscriptionStore

Stores and manages registered subscriptions and their handlers.

Implementation should be thread-safe.

Since:

1.14

Author:

Matthias Linder (mlinder)

Method Summary

Methods

Modifier and Type	Method and Description
StoredSubscription	getSubscription(String subscriptionId) Retrieves a known subscription or null if not found.
Collection<StoredSubscription>	listSubscriptions() Returns all known/registered subscriptions.
void	removeSubscription(StoredSubscription subscription) Removes a registered subscription from the store.
void	storeSubscription(StoredSubscription subscription) Stores the subscription in the applications data store, replacing any existing subscription with the same id.

Method Detail

listSubscriptions

Collection<StoredSubscription> listSubscriptions()
                                                 throws IOException

Returns all known/registered subscriptions.

Throws:

IOException

getSubscription

StoredSubscription getSubscription(String subscriptionId)
                                   throws IOException

Retrieves a known subscription or null if not found.

Parameters:

subscriptionId - ID of the subscription to retrieve

Throws:

IOException

storeSubscription

void storeSubscription(StoredSubscription subscription)
                       throws IOException

Stores the subscription in the applications data store, replacing any existing subscription with the same id.

Parameters:

subscription - New or existing StoredSubscription to store/update

Throws:

IOException

removeSubscription

void removeSubscription(StoredSubscription subscription)
                        throws IOException

Removes a registered subscription from the store.

Parameters:

subscription - StoredSubscription to remove or null to ignore

Throws:

IOException