org.sensorhub.impl.service.wsn

Interface ISubscriptionDB

All Known Implementing Classes:

InMemorySubscriptionDB

public interface ISubscriptionDB

Interface for a WSN subscription database

Since:

Dec 12, 2014

Author:

Alex Robin

Method Summary

Methods

Modifier and Type	Method and Description
void	checkSubscription(SubscriptionInfo sub) Checks that the suscription is valid for the particular application For example if a topic is specified it should be one of the topics advertised by the notification service
String	generateNewSubscriptionID() Generates a new unique ID for a new subscription
SubscriptionInfo	get(String id) Retrieves subscription by ID from database
Collection<SubscriptionInfo>	getAllSubscriptions() Gets all subscriptions in this database
List<SubscriptionInfo>	getUserSubscriptions(String userID) Retrieves the list of all subscriptions associated to a given user ID
void	put(SubscriptionInfo sub) Adds the subscription to the database
SubscriptionInfo	remove(String id) Removed subscription with given ID from database

Method Detail

get

SubscriptionInfo get(String id)

Retrieves subscription by ID from database

Parameters:

id - ID of subscription to retrieve

Returns:

subscription with specified ID or null if none was found with given ID

put

void put(SubscriptionInfo sub)

Adds the subscription to the database

Parameters:

sub - new subscription

remove

SubscriptionInfo remove(String id)

Removed subscription with given ID from database

Parameters:

id - ID of subscription to remove

Returns:

removed subscription or null if none was found with given ID

getAllSubscriptions

Collection<SubscriptionInfo> getAllSubscriptions()

Gets all subscriptions in this database

Returns:

all subscriptions as a collection

getUserSubscriptions

List<SubscriptionInfo> getUserSubscriptions(String userID)

Retrieves the list of all subscriptions associated to a given user ID

Parameters:

userID -

Returns:

subscription list, empty list if the user has no subscriptions attached or null if user ID does not exist

checkSubscription

void checkSubscription(SubscriptionInfo sub)
                       throws IllegalArgumentException

Checks that the suscription is valid for the particular application For example if a topic is specified it should be one of the topics advertised by the notification service

Parameters:

sub -

Throws:

IllegalArgumentException - thrown if the subscription is not valid with the appropriate message

generateNewSubscriptionID

String generateNewSubscriptionID()

Generates a new unique ID for a new subscription

Returns:

generated ID