org.uddi.v3_service
Interface UDDISubscriptionListenerPortType

All Superinterfaces:

Remote

All Known Implementing Classes:

UDDIClientSubscriptionListenerImpl, UDDISubscriptionListenerImpl, UDDISubscriptionListenerImpl, UDDISubscriptionListenerService

public interface UDDISubscriptionListenerPortType
extends Remote

This portType defines all of the UDDI subscriptionListener operations. This class was generated by the JAX-WS RI. JAX-WS RI 2.1.5-b03- Generated source version: 2.1

Notes from the jUDDI development team

To implement a callback for UDDI subscriptions:

1. Implement your own instance of this class.
2. Decide whether or not you want to host your implementation within a web servlet container. If the answer is yes, follow standard procedures for doing so.
3. If you're hosting it yourself, try out the following code. You'll need either JDK 1.6+ or Apache CXF with the Jetty libraries within your classpath

        String url = "http://localhost:7777/uddi_subscription_back";
        Endpoint ep = Endpoint.publish(url, new ClientSubscriptionCallback(this));
   

   
   Where "ClientSubscriptionCallback" is your implementation class for this interface

Notes from the UDDI Spec

This API, when implemented by a subscriber and specified in a subscription, enables the node to deliver notifications to subscription listeners by invoking a Web service. New, modified, and deleted data that matches the subscription is passed to notify_subscriptionListener. If the brief attribute of the subscription is "true", then only the relevant keys will be sent; full details of the changed data can be accomplished via the standard get_xx API’s if required. If a particular item that matches the subscription criteria is deleted during the notificationInterval, or is changed in such a way that it no longer matches the criterion defined for the subscription, then these entities are included in a keyBag containing a deleted element with a value of "true". To allow subscribers to determine whether a notification has been lost, the coverage period of the notification is included. A date/time indicating the date/time values corresponding to the start and end points of this is provided. The start date/time used in this call SHOULD align with the end date/time of the previous call and so fourth. * If the maxEntities option was specified in the save_subscription call, the response supplied via this call is limited to that number of entities. If the node cannot send all of the results in a single notify_subscriptionListener call, then the node repeatedly invokes the notify_subscriptionListener service until all information has been transmitted. In no case will the data sent to notify_subscriptionListener exceed the maximum message size per the policy of the node.

Method Summary

DispositionReport

notifySubscriptionListener(NotifySubscriptionListener body) This API, when implemented by a subscriber and specified in a subscription, enables the node to deliver notifications to subscription listeners by invoking a Web service.

Method Detail

notifySubscriptionListener

DispositionReport notifySubscriptionListener(NotifySubscriptionListener body)
                                             throws DispositionReportFaultMessage,
                                                    RemoteException

This API, when implemented by a subscriber and specified in a subscription, enables the node to deliver notifications to subscription listeners by invoking a Web service. New, modified, and deleted data that matches the subscription is passed to notify_subscriptionListener. If the brief attribute of the subscription is "true", then only the relevant keys will be sent; full details of the changed data can be accomplished via the standard get_xx API’s if required. If a particular item that matches the subscription criteria is deleted during the notificationInterval, or is changed in such a way that it no longer matches the criterion defined for the subscription, then these entities are included in a keyBag containing a deleted element with a value of "true". To allow subscribers to determine whether a notification has been lost, the coverage period of the notification is included. A date/time indicating the date/time values corresponding to the start and end points of this is provided. The start date/time used in this call SHOULD align with the end date/time of the previous call and so fourth. * If the maxEntities option was specified in the save_subscription call, the response supplied via this call is limited to that number of entities. If the node cannot send all of the results in a single notify_subscriptionListener call, then the node repeatedly invokes the notify_subscriptionListener service until all information has been transmitted. In no case will the data sent to notify_subscriptionListener exceed the maximum message size per the policy of the node.

Parameters:

body -

· authInfo: This optional argument is an element that contains an authentication token. Subscription listener services that wish to restrict who can transmit subscription data MAY require authInfo for this call, though this is a matter of client policy.

· subscriptionResultsList: This list contains the results for this notification, which consist of the result structures which are normally returned for standard find_xx or get_xx APIs, based upon the criteria saved in the subscriptionFilter for the subscription which is generating this notification. Note that the chunkToken is not returned with this structure for this API. The subscriptionResultsList also contains a coveragePeriod structure which defines the time period over which the node data is compared with the subscription criterion in order to produce the result set. It provides the start and end date/time information according to the format described in Section 5.5.4 Subscription Coverage Period. The "current" state of registry entries pertaining to the subscription referenced by the subscriptionKey provided are returned if they were last changed during the specified time period. See Section 5.5.11.3 Returns for more information on the subscriptionResultsList’s content.

Returns:

returns org.uddi.api_v3.DispositionReport Upon successful completion, notify_subscriptionListener returns an empty message. Note that this is being returned by the client supported API.

Throws:

DispositionReportFaultMessage -

If an error occurs in processing this API call, a dispositionReport structure is returned to the caller in a SOAP Fault. In addition to the errors common to all APIs, the following error information is relevant here:

· E_fatalError: signifies the client’s failure to receive notification data. The node is not obligated to retry.

RemoteException