org.atmosphere.stomp

Class Subscriptions

java.lang.Object

org.atmosphere.stomp.Subscriptions

public class Subscriptions
extends Object

An AtmosphereResource can subscribes to many destination. The STOMP protocol allow to subscribe many times to the same destination. This class can provide subscriptions to a destination or the destination for a subscription ID.

Since:

0.1

Version:

1.0

Author:

Guillaume DROUET

Constructor Summary

Constructors

Constructor and Description
Subscriptions() Builds a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	addSubscription(String id, String destination) Adds a subscription to the set of subscriptions.
Set<String>	getAllDestinations() Gets all the destinations this client has subscribed to.
String	getDestinationForId(String id) Gets the destination for the given subscription ID.
static Subscriptions	getFromSession(org.atmosphere.cpr.AtmosphereResourceSession session) Gets a Subscriptions object from the given session.
List<String>	getSubscriptionsForDestination(String destination) Gets the subscriptions for the given destination.
void	removeSubscription(String id) Removes the subscription identified by the given ID.

Methods inherited from class java.lang.Object

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

Constructor Detail

Subscriptions

public Subscriptions()

Builds a new instance.

Method Detail

getFromSession

public static Subscriptions getFromSession(org.atmosphere.cpr.AtmosphereResourceSession session)

Gets a Subscriptions object from the given session. If no subscription is bound to the session, a new one is created and then returned.

Parameters:

session - the session

Returns:

the subscriptions

getAllDestinations

public Set<String> getAllDestinations()

Gets all the destinations this client has subscribed to.

Returns:

the destinations set

addSubscription

public void addSubscription(String id,
                   String destination)

Adds a subscription to the set of subscriptions.

Parameters:

id - the subscription ID

destination - the subscribed destination

getSubscriptionsForDestination

public List<String> getSubscriptionsForDestination(String destination)

Gets the subscriptions for the given destination.

Parameters:

destination - the destination

Returns:

all the IDs mapped to the destination

getDestinationForId

public String getDestinationForId(String id)

Gets the destination for the given subscription ID.

Parameters:

id - the ID

Returns:

the destination the ID subscribes to

removeSubscription

public void removeSubscription(String id)

Removes the subscription identified by the given ID.

Parameters:

id - the Id