cgl.narada.wsinfra.messaging.entity
Interface Publisher

All Superinterfaces:
FrameworkIndicator, MessagingEntity
All Known Implementing Classes:
WsePublisher

public interface Publisher
extends MessagingEntity


Method Summary
 void addTopicInfo(EnvelopeDocument envelopeDocument, String topic)
          Adds Topic information to a notification message.
 void addTopicInfo(SOAPMessage soapMessage, String topic)
          Adds Topic information to a notification message.
 Enumeration getListOfSubscriptionIdentifiers()
          Retrieve the list of subscriptions registered at a Publisher.
 PublisherDefaults getPublisherDefaults()
          Retrieve defaults associated with this publisher.
 PublisherWithSubscriber getSubscriberInteractions()
          Retrieves the SubscriberInteractions which allows a publisher to communicate with a specific Subscriber.
 Subscription getSubscription(String subscriptionIdentifier)
          Retrieve the subscription associated with a subscription identifier.
 EndpointReferenceType getSubscriptionManagerEPR()
          Retrieve the EPR associated with the Subscription Manager.
 void publish(EnvelopeDocument envelopeDocument)
          This method is used to publish an EnvelopeDocument.
 void publish(SOAPMessage soapMessage)
          This method is used to publish a SOAP message.
 
Methods inherited from interface cgl.narada.wsinfra.messaging.entity.MessagingEntity
getEndpointReference
 
Methods inherited from interface cgl.narada.wsinfra.messaging.FrameworkIndicator
getProvider, getSpecVersion, isEventing, isNotification
 

Method Detail

publish

void publish(SOAPMessage soapMessage)
             throws ProcessingException,
                    MessageFlowException
This method is used to publish a SOAP message. The destination is retrieved by parsing for the element.

Parameters:
soapMessage - The SOAPMessage that is being published.
Throws:
ProcessingException - If there are problems with this SOAPMessage.
MessageFlowException - If there are networking problems which prevent this message from being routed.

publish

void publish(EnvelopeDocument envelopeDocument)
             throws ProcessingException,
                    MessageFlowException
This method is used to publish an EnvelopeDocument. The destination is retrieved by parsing for the element.

Parameters:
envelopeDocument - The EnvelopeDocument that is being published.
Throws:
ProcessingException - If there are problems with this EnvelopeDocument
MessageFlowException - If there are networking problems which prevent this message from being routed.

addTopicInfo

void addTopicInfo(EnvelopeDocument envelopeDocument,
                  String topic)
                  throws ProcessingException
Adds Topic information to a notification message.

Parameters:
envelopeDocument - The EnvelopeDocument that is being published.
topic - The Topic associated with the notification.
Throws:
ProcessingException - If there are problems with this EnvelopeDocument

addTopicInfo

void addTopicInfo(SOAPMessage soapMessage,
                  String topic)
                  throws ProcessingException
Adds Topic information to a notification message.

Parameters:
soapMessage - The SOAPMessage that is being published.
topic - The Topic associated with the notification.
Throws:
ProcessingException - If there are problems with this EnvelopeDocument

getSubscriberInteractions

PublisherWithSubscriber getSubscriberInteractions()
Retrieves the SubscriberInteractions which allows a publisher to communicate with a specific Subscriber.

Returns:
SubscriberInteractions

getPublisherDefaults

PublisherDefaults getPublisherDefaults()
Retrieve defaults associated with this publisher.

Returns:
PublisherDefaults

getListOfSubscriptionIdentifiers

Enumeration getListOfSubscriptionIdentifiers()
Retrieve the list of subscriptions registered at a Publisher.

Returns:
Enumeration of the list of subscription identifiers

getSubscription

Subscription getSubscription(String subscriptionIdentifier)
                             throws ProcessingException
Retrieve the subscription associated with a subscription identifier.

Parameters:
subscriptionIdentifier - The ID of subscription in question
Returns:
The Subscription widget which snapshots the subscription
Throws:
ProcessingException - If there are problems with the specified subscriptionIdentifier.

getSubscriptionManagerEPR

EndpointReferenceType getSubscriptionManagerEPR()
Retrieve the EPR associated with the Subscription Manager.

Returns:
subscriptionManagerEPR


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