blob: e6a5a5a09c8cb3b2d9712346b0970ab9a5afc42c [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_101) on Mon Sep 19 17:00:15 EDT 2022 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>UDDISubscriptionListenerPortType (UDDIv2 and v3 WS Stubs and Schema Bindings Generated from WSDL 3.3.11-SNAPSHOT API)</title>
<meta name="date" content="2022-09-19">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="UDDISubscriptionListenerPortType (UDDIv2 and v3 WS Stubs and Schema Bindings Generated from WSDL 3.3.11-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/UDDISubscriptionListenerPortType.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/uddi/v3_service/UDDISecurityPortType.html" title="interface in org.uddi.v3_service"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../org/uddi/v3_service/UDDISubscriptionPortType.html" title="interface in org.uddi.v3_service"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/uddi/v3_service/UDDISubscriptionListenerPortType.html" target="_top">Frames</a></li>
<li><a href="UDDISubscriptionListenerPortType.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.uddi.v3_service</div>
<h2 title="Interface UDDISubscriptionListenerPortType" class="title">Interface UDDISubscriptionListenerPortType</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/6/docs/api/java/rmi/Remote.html?is-external=true" title="class or interface in java.rmi">Remote</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">UDDISubscriptionListenerPortType</span>
extends <a href="https://docs.oracle.com/javase/6/docs/api/java/rmi/Remote.html?is-external=true" title="class or interface in java.rmi">Remote</a></pre>
<div class="block">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
<h1>Notes from the jUDDI development team</h1>
To implement a callback for UDDI subscriptions:
<ol><li>Implement your own instance of this class.</li>
<li>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.</li>
<li>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
<pre>
String url = "http://localhost:7777/uddi_subscription_back";
Endpoint ep = Endpoint.publish(url, new ClientSubscriptionCallback(this));
</pre><br>
Where "ClientSubscriptionCallback" is your implementation class for this interface
</li>
</ol>
<h1>Notes from the UDDI Spec</h1>
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.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../org/uddi/api_v3/DispositionReport.html" title="class in org.uddi.api_v3">DispositionReport</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/uddi/v3_service/UDDISubscriptionListenerPortType.html#notifySubscriptionListener-org.uddi.subr_v3.NotifySubscriptionListener-">notifySubscriptionListener</a></span>(<a href="../../../org/uddi/subr_v3/NotifySubscriptionListener.html" title="class in org.uddi.subr_v3">NotifySubscriptionListener</a>&nbsp;body)</code>
<div class="block">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.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="notifySubscriptionListener-org.uddi.subr_v3.NotifySubscriptionListener-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>notifySubscriptionListener</h4>
<pre><a href="../../../org/uddi/api_v3/DispositionReport.html" title="class in org.uddi.api_v3">DispositionReport</a>&nbsp;notifySubscriptionListener(<a href="../../../org/uddi/subr_v3/NotifySubscriptionListener.html" title="class in org.uddi.subr_v3">NotifySubscriptionListener</a>&nbsp;body)
throws <a href="../../../org/uddi/v3_service/DispositionReportFaultMessage.html" title="class in org.uddi.v3_service">DispositionReportFaultMessage</a>,
<a href="https://docs.oracle.com/javase/6/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></pre>
<div class="block">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.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>body</code> - <p class="MsoBodyText"
style="margin-left:1.0in;text-indent:-.25in"><span
style="font-family:Symbol">·<span style="font:7.0pt &quot;Times New
Roman&quot;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</span></span><b><i>authInfo</i></b>:&nbsp; This optional argument is an
element that contains an authentication token.&nbsp; 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.</p>
<p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span
style="font-family:Symbol">·<span style="font:7.0pt &quot;Times New
Roman&quot;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</span></span><b><i>subscriptionResultsList</i></b>:&nbsp; 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.&nbsp; 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 <a href="#_Ref3402225 ">5.5.4</a> <i>Subscription Coverage
Period</i>.&nbsp; 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
<a href="#_Ref42320503 ">5.5.11.3</a> <i>Returns</i> for more information
on the subscriptionResultsList’s content.</p></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>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.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../org/uddi/v3_service/DispositionReportFaultMessage.html" title="class in org.uddi.v3_service">DispositionReportFaultMessage</a></code> - <p class="MsoBodyText">If an error
occurs in processing this API call, a dispositionReport structure is
returned to the caller in a SOAP Fault.&nbsp; In addition to the errors
common to all APIs, the following error information is relevant here:</p>
<p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span
style="font-family:Symbol">·<span style="font:7.0pt &quot;Times New
Roman&quot;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</span></span><b>E_fatalError:&nbsp; </b>signifies the client’s failure
to receive notification data.&nbsp;&nbsp; The node is not obligated to
retry.</p></dd>
<dd><code><a href="https://docs.oracle.com/javase/6/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/UDDISubscriptionListenerPortType.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/uddi/v3_service/UDDISecurityPortType.html" title="interface in org.uddi.v3_service"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../org/uddi/v3_service/UDDISubscriptionPortType.html" title="interface in org.uddi.v3_service"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/uddi/v3_service/UDDISubscriptionListenerPortType.html" target="_top">Frames</a></li>
<li><a href="UDDISubscriptionListenerPortType.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2004&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>