net.kwfgrid.gwes.uiproxy
Interface SubscriptionHandler

public interface SubscriptionHandler

Interface for a subscription handler. This allows to use the UIProxy for different event systems.

Method Summary

void	cancel(String subscriptionid) Cancel a subscription.
String	subscribe(Consumer subscriber, String subscription) Handle a subscription request.

Method Detail

subscribe

String subscribe(Consumer subscriber,
                 String subscription)
                 throws SubscriptionFailed

Handle a subscription request. If this method returns normally the subscription must have been successful.

Parameters:

subscriber - The consumer.

subscription - The specification of the generic subscription.

Returns:

The subscription ID needed to cancel the subscription.

Throws:

SubscriptionFailed - If the subscription could not be made.

cancel

void cancel(String subscriptionid)

Cancel a subscription.

Parameters:

subscriptionid - The ID of the subscription to cancel.