cgl.narada.wsinfra.messaging.interactions.wse
Class WSESubscriberWithSubscriptionManager

java.lang.Object
  extended by cgl.narada.wsinfra.messaging.wse.WseFrameworkIndicator
      extended by cgl.narada.wsinfra.messaging.interactions.wse.WSESubscriberInteraction
          extended by cgl.narada.wsinfra.messaging.interactions.wse.WSESubscriberWithSubscriptionManager
All Implemented Interfaces:
FrameworkIndicator, SubscriberInteraction, SubscriberWithSubscriptionManager, WseSubscriberWithSubscriptionManager

public class WSESubscriberWithSubscriptionManager
extends WSESubscriberInteraction
implements WseSubscriberWithSubscriptionManager


Constructor Summary
WSESubscriberWithSubscriptionManager(WseSinkProcessor wseSinkProcessor)
           
 
Method Summary
 EnvelopeDocument createGetStatus(String subscriptionIdentifier)
          Create a WSE GetStatus Request based on the specified subscription identifier
 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 getStatus(String subscriptionIdentifier)
          Issue a WSE GetStatus Request based on the specified subscription identifier
 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 class cgl.narada.wsinfra.messaging.interactions.wse.WSESubscriberInteraction
issueExchange
 
Methods inherited from class cgl.narada.wsinfra.messaging.wse.WseFrameworkIndicator
getProvider, getSpecVersion, isEventing, isNotification
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface cgl.narada.wsinfra.messaging.interactions.SubscriberInteraction
issueExchange
 
Methods inherited from interface cgl.narada.wsinfra.messaging.FrameworkIndicator
getProvider, getSpecVersion, isEventing, isNotification
 

Constructor Detail

WSESubscriberWithSubscriptionManager

public WSESubscriberWithSubscriptionManager(WseSinkProcessor wseSinkProcessor)
Method Detail

getStatus

public void getStatus(String subscriptionIdentifier)
               throws ProcessingException,
                      MessageFlowException
Description copied from interface: WseSubscriberWithSubscriptionManager
Issue a WSE GetStatus Request based on the specified subscription identifier

Specified by:
getStatus in interface WseSubscriberWithSubscriptionManager
Parameters:
subscriptionIdentifier - The ID for which a GetStatus request is being issued.
Throws:
ProcessingException - If there are problems with the subscription Identifier or in the creation of the GetStatus request.
MessageFlowException - If there are problems in routing the GetStatus to the Subscription Manager).
See Also:
WseSubscriberWithSubscriptionManager.getStatus(java.lang.String)

createGetStatus

public EnvelopeDocument createGetStatus(String subscriptionIdentifier)
                                 throws ProcessingException
Description copied from interface: WseSubscriberWithSubscriptionManager
Create a WSE GetStatus Request based on the specified subscription identifier

Specified by:
createGetStatus in interface WseSubscriberWithSubscriptionManager
Parameters:
subscriptionIdentifier - he ID for which a GetStatus request is being created.
Returns:
The EnevelopeDocument containing the request.
Throws:
ProcessingException - If there are problems with the subscription Identifier or in the creation of the GetStatus request.
See Also:
WseSubscriberWithSubscriptionManager.createGetStatus(java.lang.String)

unsubscribe

public void unsubscribe(String subscriptionIdentifier)
                 throws ProcessingException,
                        MessageFlowException
Description copied from interface: SubscriberWithSubscriptionManager
This method is responsible for issuing an unsubscribe request to the Subscription Manager associated with the subscription

Specified by:
unsubscribe in interface SubscriberWithSubscriptionManager
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.
See Also:
SubscriberWithSubscriptionManager.unsubscribe(java.lang.String)

createUnsubscribe

public EnvelopeDocument createUnsubscribe(String subscriptionIdentifier)
                                   throws ProcessingException
Description copied from interface: SubscriberWithSubscriptionManager
This method is responsible for creating an Unsubscribe request taregeted to the appropriate SubscriptionManager.

Specified by:
createUnsubscribe in interface SubscriberWithSubscriptionManager
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.
See Also:
SubscriberWithSubscriptionManager.createUnsubscribe(java.lang.String)

renew

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

Specified by:
renew in interface SubscriberWithSubscriptionManager
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.
See Also:
SubscriberWithSubscriptionManager.renew(java.lang.String, java.util.Calendar)

createRenew

public EnvelopeDocument createRenew(String subscriptionIdentifier,
                                    Calendar renewUntil)
                             throws ProcessingException
Description copied from interface: SubscriberWithSubscriptionManager
This method is responsible for creating a Renew request taregeted to the appropriate SubscriptionManager.

Specified by:
createRenew in interface SubscriberWithSubscriptionManager
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.
See Also:
SubscriberWithSubscriptionManager.createRenew(java.lang.String, java.util.Calendar)


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