blob: 657c62d08a294f212aa485363dd047581d2bb74e [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 16:59:28 EDT 2022 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>UDDISubscriptionListenerImpl (jUDDI_v3 Parent 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="UDDISubscriptionListenerImpl (jUDDI_v3 Parent 3.3.11-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/UDDISubscriptionListenerImpl.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/apache/juddi/api/impl/UDDISubscriptionImpl.html" title="class in org.apache.juddi.api.impl"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/juddi/api/impl/UDDIv2InquiryImpl.html" title="class in org.apache.juddi.api.impl"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/juddi/api/impl/UDDISubscriptionListenerImpl.html" target="_top">Frames</a></li>
<li><a href="UDDISubscriptionListenerImpl.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><a href="#fields.inherited.from.class.org.apache.juddi.api.impl.AuthenticatedService">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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.apache.juddi.api.impl</div>
<h2 title="Class UDDISubscriptionListenerImpl" class="title">Class UDDISubscriptionListenerImpl</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html" title="class in org.apache.juddi.api.impl">org.apache.juddi.api.impl.AuthenticatedService</a></li>
<li>
<ul class="inheritance">
<li>org.apache.juddi.api.impl.UDDISubscriptionListenerImpl</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</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>, <a href="../../../../../org/uddi/v3_service/UDDISubscriptionListenerPortType.html" title="interface in org.uddi.v3_service">UDDISubscriptionListenerPortType</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">UDDISubscriptionListenerImpl</span>
extends <a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html" title="class in org.apache.juddi.api.impl">AuthenticatedService</a>
implements <a href="../../../../../org/uddi/v3_service/UDDISubscriptionListenerPortType.html" title="interface in org.uddi.v3_service">UDDISubscriptionListenerPortType</a></pre>
<div class="block">This class implements the UDDI v3 Subscription Listener API (server side)
for jUDDI. It is primarily used for server to server subscriptions.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.juddi.api.impl.AuthenticatedService">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.juddi.api.impl.<a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html" title="class in org.apache.juddi.api.impl">AuthenticatedService</a></h3>
<code><a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html#AUTHTOKEN_ACTIVE">AUTHTOKEN_ACTIVE</a>, <a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html#AUTHTOKEN_RETIRED">AUTHTOKEN_RETIRED</a>, <a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html#baseUrl">baseUrl</a>, <a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html#baseUrlSSL">baseUrlSSL</a>, <a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html#ctx">ctx</a>, <a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html#df">df</a>, <a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html#UTF8">UTF8</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/juddi/api/impl/UDDISubscriptionListenerImpl.html#UDDISubscriptionListenerImpl--">UDDISubscriptionListenerImpl</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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/apache/juddi/api/impl/UDDISubscriptionListenerImpl.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>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.juddi.api.impl.AuthenticatedService">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.juddi.api.impl.<a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html" title="class in org.apache.juddi.api.impl">AuthenticatedService</a></h3>
<code><a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html#getEntityPublisher-javax.persistence.EntityManager-java.lang.String-">getEntityPublisher</a>, <a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html#getNode--">getNode</a>, <a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html#getRequestorsIPAddress--">getRequestorsIPAddress</a>, <a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html#setContext-javax.xml.ws.WebServiceContext-">setContext</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="UDDISubscriptionListenerImpl--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>UDDISubscriptionListenerImpl</h4>
<pre>public&nbsp;UDDISubscriptionListenerImpl()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ 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>public&nbsp;<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></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/uddi/v3_service/UDDISubscriptionListenerPortType.html#notifySubscriptionListener-org.uddi.subr_v3.NotifySubscriptionListener-">UDDISubscriptionListenerPortType</a></code></span></div>
<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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/uddi/v3_service/UDDISubscriptionListenerPortType.html#notifySubscriptionListener-org.uddi.subr_v3.NotifySubscriptionListener-">notifySubscriptionListener</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/uddi/v3_service/UDDISubscriptionListenerPortType.html" title="interface in org.uddi.v3_service">UDDISubscriptionListenerPortType</a></code></dd>
<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>
</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/UDDISubscriptionListenerImpl.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/apache/juddi/api/impl/UDDISubscriptionImpl.html" title="class in org.apache.juddi.api.impl"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/juddi/api/impl/UDDIv2InquiryImpl.html" title="class in org.apache.juddi.api.impl"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/juddi/api/impl/UDDISubscriptionListenerImpl.html" target="_top">Frames</a></li>
<li><a href="UDDISubscriptionListenerImpl.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><a href="#fields.inherited.from.class.org.apache.juddi.api.impl.AuthenticatedService">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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>