cgl.narada.wsinfra.messaging.interactions
Interface SubscriberWithSubscriptionManager

All Superinterfaces:
FrameworkIndicator, SubscriberInteraction
All Known Subinterfaces:
WseSubscriberWithSubscriptionManager, WsnSubscriberWithSubscriptionManager
All Known Implementing Classes:
WSESubscriberWithSubscriptionManager

public interface SubscriberWithSubscriptionManager
extends SubscriberInteraction


Method Summary
 EnvelopeDocument createRenew(String subscriptionIdentifier, Calendar renewUntil)
          This method is responsible for creating a Renew request taregeted to the appropriate SubscriptionManager.
 EnvelopeDocument createUnsubscribe(String subscriptionIdentifier)
          This method is responsible for creating an Unsubscribe request taregeted to the appropriate SubscriptionManager.
 void renew(String subscriptionIdentifier, Calendar renewUntil)
          This method is responsible for issuing an Renew request to the Subscription Manager associated with the subscription
 void unsubscribe(String subscriptionIdentifier)
          This method is responsible for issuing an unsubscribe request to the Subscription Manager associated with the subscription
 
Methods inherited from interface cgl.narada.wsinfra.messaging.interactions.SubscriberInteraction
issueExchange
 
Methods inherited from interface cgl.narada.wsinfra.messaging.FrameworkIndicator
getProvider, getSpecVersion, isEventing, isNotification
 

Method Detail

unsubscribe

void unsubscribe(String subscriptionIdentifier)
                 throws ProcessingException,
                        MessageFlowException
This method is responsible for issuing an unsubscribe request to the Subscription Manager associated with the subscription

Parameters:
subscriptionIdentifier - The subscription for which the unsubscribe operation will be performed.
Throws:
ProcessingException - If there are problems with the subscription Identifier or in the creation of the Unsubscribe request.
MessageFlowException - If there are problems in routing the Unsubscribe request to the Subscription Manager.

createUnsubscribe

EnvelopeDocument createUnsubscribe(String subscriptionIdentifier)
                                   throws ProcessingException
This method is responsible for creating an Unsubscribe request taregeted to the appropriate SubscriptionManager.

Parameters:
subscriptionIdentifier - The subscription for which the unsubscribe request is being created.
Throws:
ProcessingException - If there are problems with the subscription Identifier or in the creation of the Unsubscribe request.

renew

void renew(String subscriptionIdentifier,
           Calendar renewUntil)
           throws ProcessingException,
                  MessageFlowException
This method is responsible for issuing an Renew request to the Subscription Manager associated with the subscription

Parameters:
subscriptionIdentifier - The ID of the subscription for which this renew operation will be performed.
renewUntil - The time until which this subscription should be renewed
Throws:
ProcessingException - If there are problems with the subscription Identifier or in the creation of the Renew request.
MessageFlowException - If there are problems in routing the Renew request to the Subscription Manager.

createRenew

EnvelopeDocument createRenew(String subscriptionIdentifier,
                             Calendar renewUntil)
                             throws ProcessingException
This method is responsible for creating a Renew request taregeted to the appropriate SubscriptionManager.

Parameters:
subscriptionIdentifier - The subscription for which the renew request is being created.
Throws:
ProcessingException - If there are problems with the subscription Identifier or in the creation of the Renew request.


For comments and suggestions please send e-mail to The NaradaBrokering Project