org.codice.ddf.catalog.subscriptionstore.common

Class SubscriptionPersistor

java.lang.Object

org.codice.ddf.catalog.subscriptionstore.common.SubscriptionPersistor

public class SubscriptionPersistor
extends Object

A common persistence layer for all subscriptions targeting the PersistentStore.

The SubscriptionPersistor serves as the data-access object for all Subscriptions across any endpoint. The object that actually gets stored is a SubscriptionMetadata, but combined with a SubscriptionFactory, the original Subscription object can be re-created and registered with the OSGi framework.

SubscriptionPersistor knows how to marshall and unmarshall between SubscriptionMetadata and PersistentItem, effectively hiding the persistence details of subscriptions from the rest of the service.

Constructor Summary

Constructors

Constructor and Description
SubscriptionPersistor(PersistentStore persistentStore)

Method Summary

Modifier and Type	Method and Description
void	delete(String subscriptionId) Remove the subscription metadata from the persistent store that corresponds to the given id.
Map<String,SubscriptionMetadata>	getSubscriptions() Get all the subscription metadata objects in the persistent store, regardless of type.
void	insert(SubscriptionMetadata metadata) Add the subscription metadata to the persistent store using its id for the document key.

Methods inherited from class java.lang.Object

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

Constructor Detail

SubscriptionPersistor

public SubscriptionPersistor(PersistentStore persistentStore)

Method Detail

getSubscriptions

public Map<String,SubscriptionMetadata> getSubscriptions()

Get all the subscription metadata objects in the persistent store, regardless of type.

Returns:

a map of subscription ids to their accompanying metadata.

Throws:

SubscriptionStoreException - if a problem occurs during the read.

insert

public void insert(SubscriptionMetadata metadata)

Add the subscription metadata to the persistent store using its id for the document key.

Insertion operations with the same key overwrite the previous value, which means a duplicate being added is a no-op, minus the network overhead.

Parameters:

metadata - the subscription metadata to add to the persistent store.

Throws:

SubscriptionStoreException - if a problem occurs during insert.

delete

public void delete(String subscriptionId)

Remove the subscription metadata from the persistent store that corresponds to the given id.

Redundant deletes are valid as a no-op to support javax.cache events propogating* write-through processing to other cache nodes.

Parameters:

subscriptionId - the unique id of the subscription to delete.

Throws:

SubscriptionStoreException - if a problem occurs during delete.