blob: 2d9a0f408fc4ca00fc09e6b579f4bae2d0a1afba [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:27 EDT 2022 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SubscriptionCallbackListener (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="SubscriptionCallbackListener (jUDDI_v3 Parent 3.3.11-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":10,"i3":9,"i4":9,"i5":10,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/SubscriptionCallbackListener.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/v3/client/subscription/ServiceAlreadyStartedException.html" title="class in org.apache.juddi.v3.client.subscription"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/juddi/v3/client/subscription/SubscriptionCallbackListener.SignatureBehavior.html" title="enum in org.apache.juddi.v3.client.subscription"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/juddi/v3/client/subscription/SubscriptionCallbackListener.html" target="_top">Frames</a></li>
<li><a href="SubscriptionCallbackListener.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">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><a href="#field.detail">Field</a>&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.v3.client.subscription</div>
<h2 title="Class SubscriptionCallbackListener" class="title">Class SubscriptionCallbackListener</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>org.apache.juddi.v3.client.subscription.SubscriptionCallbackListener</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/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a>, <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">SubscriptionCallbackListener</span>
extends <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>
implements <a href="../../../../../../org/uddi/v3_service/UDDISubscriptionListenerPortType.html" title="interface in org.uddi.v3_service">UDDISubscriptionListenerPortType</a>, <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a></pre>
<div class="block">WebService which implements the UDDI v3 SubscriptionListener API. This
service will be called by the UDDI registry when any change to a Service or
BindingTemplate call in to it.
<h1>Usage scenario</h1>
Use this call for when you need to be notified from a UDDI server that either
a UDDI entity was created, changed, or deleted via the UDDI Subscription web
service. This class will start up an embedded Jetty server (built into the
JRE). You can then register your code to be notified of any inbound messages
received from the UDDI server asynchronously. Here's some sample code.
<pre>
UDDIClient c = new UDDIClient("META-INF/uddiclient.xml");
UDDIClerk clerk = c.getClerk("default");
TModel createKeyGenator = UDDIClerk.createKeyGenator("uddi:org.apache.juddi:test:keygenerator", "Test domain", "en");
clerk.register(createKeyGenator);
BindingTemplate start = SubscriptionCallbackListener.start(c, "default");
//keep alive
while(running)
Thread.sleep(1000);
SubscriptionCallbackListener.stop(c, "default", start.getBindingKey());
</pre></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.2</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd><a href="mailto:alexoree@apache.org">Alex O'Ree</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/juddi/v3/client/subscription/SubscriptionCallbackListener.SignatureBehavior.html" title="enum in org.apache.juddi.v3.client.subscription">SubscriptionCallbackListener.SignatureBehavior</a></span></code>
<div class="block">This defines how the automatic subscription binding template is
suppose to behave</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/juddi/v3/client/subscription/SubscriptionCallbackListener.html#PROPERTY_AUTOREG_BT">PROPERTY_AUTOREG_BT</a></span></code>
<div class="block">config parameter true/false</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/juddi/v3/client/subscription/SubscriptionCallbackListener.html#PROPERTY_AUTOREG_SERVICE_KEY">PROPERTY_AUTOREG_SERVICE_KEY</a></span></code>
<div class="block">config parameter business key</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/juddi/v3/client/subscription/SubscriptionCallbackListener.html#PROPERTY_KEYDOMAIN">PROPERTY_KEYDOMAIN</a></span></code>
<div class="block">config parameter</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/juddi/v3/client/subscription/SubscriptionCallbackListener.html#PROPERTY_LISTENURL">PROPERTY_LISTENURL</a></span></code>
<div class="block">config parameter</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/juddi/v3/client/subscription/SubscriptionCallbackListener.html#PROPERTY_NODE">PROPERTY_NODE</a></span></code>
<div class="block">config parameter, if not defined, default will be used</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/juddi/v3/client/subscription/SubscriptionCallbackListener.html#PROPERTY_SIGNATURE_BEHAVIOR">PROPERTY_SIGNATURE_BEHAVIOR</a></span></code>
<div class="block">config parameter</div>
</td>
</tr>
</table>
</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/v3/client/subscription/SubscriptionCallbackListener.html#SubscriptionCallbackListener--">SubscriptionCallbackListener</a></span>()</code>
<div class="block">adds a shutdown hook to trap and warn about leaving the server
running on exit</div>
</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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>static <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/juddi/v3/client/subscription/SubscriptionCallbackListener.html#getCallbackURL--">getCallbackURL</a></span>()</code>
<div class="block">gets the current callback url, may be null if the endpoint isn't
started yet</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected static <a href="../../../../../../org/apache/juddi/v3/client/subscription/SubscriptionCallbackListener.html" title="class in org.apache.juddi.v3.client.subscription">SubscriptionCallbackListener</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/juddi/v3/client/subscription/SubscriptionCallbackListener.html#getInstance--">getInstance</a></span>()</code>
<div class="block">used for unit tests, may return null if the endpoint isn't started
yet</div>
</td>
</tr>
<tr id="i2" 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/v3/client/subscription/SubscriptionCallbackListener.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>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../org/uddi/api_v3/BindingTemplate.html" title="class in org.uddi.api_v3">BindingTemplate</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/juddi/v3/client/subscription/SubscriptionCallbackListener.html#registerBinding-org.apache.juddi.v3.client.config.UDDIClient-java.lang.String-org.uddi.api_v3.BindingTemplate-org.apache.juddi.v3.client.subscription.SubscriptionCallbackListener.SignatureBehavior-">registerBinding</a></span>(<a href="../../../../../../org/apache/juddi/v3/client/config/UDDIClient.html" title="class in org.apache.juddi.v3.client.config">UDDIClient</a>&nbsp;client,
<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;cfg_node_name,
<a href="../../../../../../org/uddi/api_v3/BindingTemplate.html" title="class in org.uddi.api_v3">BindingTemplate</a>&nbsp;bt,
<a href="../../../../../../org/apache/juddi/v3/client/subscription/SubscriptionCallbackListener.SignatureBehavior.html" title="enum in org.apache.juddi.v3.client.subscription">SubscriptionCallbackListener.SignatureBehavior</a>&nbsp;behavior)</code>
<div class="block">Registers a UDDI binding template that represents the subscription
callback endpoint</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/juddi/v3/client/subscription/SubscriptionCallbackListener.html#registerCallback-org.apache.juddi.v3.client.subscription.ISubscriptionCallback-">registerCallback</a></span>(<a href="../../../../../../org/apache/juddi/v3/client/subscription/ISubscriptionCallback.html" title="interface in org.apache.juddi.v3.client.subscription">ISubscriptionCallback</a>&nbsp;callback)</code>
<div class="block">Registers an implementation of ISubscriptionCallback for subscription
callbacks from a UDDI server.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/juddi/v3/client/subscription/SubscriptionCallbackListener.html#run--">run</a></span>()</code>
<div class="block">shutdown hook</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../org/uddi/api_v3/BindingTemplate.html" title="class in org.uddi.api_v3">BindingTemplate</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/juddi/v3/client/subscription/SubscriptionCallbackListener.html#start-org.apache.juddi.v3.client.config.UDDIClient-">start</a></span>(<a href="../../../../../../org/apache/juddi/v3/client/config/UDDIClient.html" title="class in org.apache.juddi.v3.client.config">UDDIClient</a>&nbsp;client)</code>
<div class="block">Starts a subscription callback service using the juddi client config
file's settings.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../org/uddi/api_v3/BindingTemplate.html" title="class in org.uddi.api_v3">BindingTemplate</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/juddi/v3/client/subscription/SubscriptionCallbackListener.html#start-org.apache.juddi.v3.client.config.UDDIClient-java.lang.String-">start</a></span>(<a href="../../../../../../org/apache/juddi/v3/client/config/UDDIClient.html" title="class in org.apache.juddi.v3.client.config">UDDIClient</a>&nbsp;client,
<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;cfg_node_name)</code>
<div class="block">Starts a subscription callback service using the juddi client config
file's settings.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../org/uddi/api_v3/BindingTemplate.html" title="class in org.uddi.api_v3">BindingTemplate</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/juddi/v3/client/subscription/SubscriptionCallbackListener.html#start-org.apache.juddi.v3.client.config.UDDIClient-java.lang.String-java.lang.String-java.lang.String-boolean-java.lang.String-org.apache.juddi.v3.client.subscription.SubscriptionCallbackListener.SignatureBehavior-">start</a></span>(<a href="../../../../../../org/apache/juddi/v3/client/config/UDDIClient.html" title="class in org.apache.juddi.v3.client.config">UDDIClient</a>&nbsp;client,
<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;cfg_node_name,
<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;endpoint,
<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;keydomain,
boolean&nbsp;autoregister,
<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;serviceKey,
<a href="../../../../../../org/apache/juddi/v3/client/subscription/SubscriptionCallbackListener.SignatureBehavior.html" title="enum in org.apache.juddi.v3.client.subscription">SubscriptionCallbackListener.SignatureBehavior</a>&nbsp;behavior)</code>
<div class="block">Starts a embedded Jetty web server (comes with the JDK) using the
Endpoint API.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/juddi/v3/client/subscription/SubscriptionCallbackListener.html#stop-org.apache.juddi.v3.client.config.UDDIClient-java.lang.String-java.lang.String-">stop</a></span>(<a href="../../../../../../org/apache/juddi/v3/client/config/UDDIClient.html" title="class in org.apache.juddi.v3.client.config">UDDIClient</a>&nbsp;client,
<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;cfg_node_name,
<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;bindingKey)</code>
<div class="block">This effectively stops the endpoint address and notifies all
ISubscriptionCallback clients that the endpoint as been stopped.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>protected static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/juddi/v3/client/subscription/SubscriptionCallbackListener.html#unregisterAllCallbacks--">unregisterAllCallbacks</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/juddi/v3/client/subscription/SubscriptionCallbackListener.html#unRegisterCallback-org.apache.juddi.v3.client.subscription.ISubscriptionCallback-">unRegisterCallback</a></span>(<a href="../../../../../../org/apache/juddi/v3/client/subscription/ISubscriptionCallback.html" title="interface in org.apache.juddi.v3.client.subscription">ISubscriptionCallback</a>&nbsp;callback)</code>
<div class="block">unregisters a ISubscriptionCallback for callbacks</div>
</td>
</tr>
</table>
<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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="PROPERTY_LISTENURL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PROPERTY_LISTENURL</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> PROPERTY_LISTENURL</pre>
<div class="block">config parameter</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.apache.juddi.v3.client.subscription.SubscriptionCallbackListener.PROPERTY_LISTENURL">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="PROPERTY_NODE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PROPERTY_NODE</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> PROPERTY_NODE</pre>
<div class="block">config parameter, if not defined, default will be used</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.apache.juddi.v3.client.subscription.SubscriptionCallbackListener.PROPERTY_NODE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="PROPERTY_KEYDOMAIN">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PROPERTY_KEYDOMAIN</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> PROPERTY_KEYDOMAIN</pre>
<div class="block">config parameter</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.apache.juddi.v3.client.subscription.SubscriptionCallbackListener.PROPERTY_KEYDOMAIN">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="PROPERTY_AUTOREG_BT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PROPERTY_AUTOREG_BT</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> PROPERTY_AUTOREG_BT</pre>
<div class="block">config parameter true/false</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.apache.juddi.v3.client.subscription.SubscriptionCallbackListener.PROPERTY_AUTOREG_BT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="PROPERTY_AUTOREG_SERVICE_KEY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PROPERTY_AUTOREG_SERVICE_KEY</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> PROPERTY_AUTOREG_SERVICE_KEY</pre>
<div class="block">config parameter business key</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.apache.juddi.v3.client.subscription.SubscriptionCallbackListener.PROPERTY_AUTOREG_SERVICE_KEY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="PROPERTY_SIGNATURE_BEHAVIOR">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PROPERTY_SIGNATURE_BEHAVIOR</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> PROPERTY_SIGNATURE_BEHAVIOR</pre>
<div class="block">config parameter</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../org/apache/juddi/v3/client/subscription/SubscriptionCallbackListener.SignatureBehavior.html" title="enum in org.apache.juddi.v3.client.subscription"><code>SubscriptionCallbackListener.SignatureBehavior</code></a>,
<a href="../../../../../../constant-values.html#org.apache.juddi.v3.client.subscription.SubscriptionCallbackListener.PROPERTY_SIGNATURE_BEHAVIOR">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="SubscriptionCallbackListener--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SubscriptionCallbackListener</h4>
<pre>public&nbsp;SubscriptionCallbackListener()</pre>
<div class="block">adds a shutdown hook to trap and warn about leaving the server
running on exit</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getInstance--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInstance</h4>
<pre>protected static&nbsp;<a href="../../../../../../org/apache/juddi/v3/client/subscription/SubscriptionCallbackListener.html" title="class in org.apache.juddi.v3.client.subscription">SubscriptionCallbackListener</a>&nbsp;getInstance()</pre>
<div class="block">used for unit tests, may return null if the endpoint isn't started
yet</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>gets an instance</dd>
</dl>
</li>
</ul>
<a name="start-org.apache.juddi.v3.client.config.UDDIClient-java.lang.String-java.lang.String-java.lang.String-boolean-java.lang.String-org.apache.juddi.v3.client.subscription.SubscriptionCallbackListener.SignatureBehavior-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>start</h4>
<pre>public static&nbsp;<a href="../../../../../../org/uddi/api_v3/BindingTemplate.html" title="class in org.uddi.api_v3">BindingTemplate</a>&nbsp;start(<a href="../../../../../../org/apache/juddi/v3/client/config/UDDIClient.html" title="class in org.apache.juddi.v3.client.config">UDDIClient</a>&nbsp;client,
<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;cfg_node_name,
<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;endpoint,
<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;keydomain,
boolean&nbsp;autoregister,
<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;serviceKey,
<a href="../../../../../../org/apache/juddi/v3/client/subscription/SubscriptionCallbackListener.SignatureBehavior.html" title="enum in org.apache.juddi.v3.client.subscription">SubscriptionCallbackListener.SignatureBehavior</a>&nbsp;behavior)
throws <a href="../../../../../../org/apache/juddi/v3/client/subscription/ServiceAlreadyStartedException.html" title="class in org.apache.juddi.v3.client.subscription">ServiceAlreadyStartedException</a>,
<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang">SecurityException</a>,
org.apache.commons.configuration.ConfigurationException,
<a href="../../../../../../org/apache/juddi/v3/client/transport/TransportException.html" title="class in org.apache.juddi.v3.client.transport">TransportException</a>,
<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>,
<a href="https://docs.oracle.com/javase/6/docs/api/java/rmi/UnexpectedException.html?is-external=true" title="class or interface in java.rmi">UnexpectedException</a>,
<a href="../../../../../../org/apache/juddi/v3/client/subscription/RegistrationAbortedException.html" title="class in org.apache.juddi.v3.client.subscription">RegistrationAbortedException</a>,
<a href="../../../../../../org/apache/juddi/v3/client/subscription/UnableToSignException.html" title="class in org.apache.juddi.v3.client.subscription">UnableToSignException</a>,
<a href="https://docs.oracle.com/javase/6/docs/api/java/net/MalformedURLException.html?is-external=true" title="class or interface in java.net">MalformedURLException</a></pre>
<div class="block">Starts a embedded Jetty web server (comes with the JDK) using the
Endpoint API.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>client</code> - </dd>
<dd><code>cfg_node_name</code> - </dd>
<dd><code>endpoint</code> - this is the url that a UDDI server would use to
connect to the client's subscription listener service Recommend
specifying a port that is firewall friendly</dd>
<dd><code>keydomain</code> - </dd>
<dd><code>autoregister</code> - </dd>
<dd><code>behavior</code> - </dd>
<dd><code>serviceKey</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>null, if and only if callbackBusinessService was null,
otherwise the modified callbackBusinessService is returned. Clients
can then use it to continue the registration process.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/juddi/v3/client/subscription/ServiceAlreadyStartedException.html" title="class in org.apache.juddi.v3.client.subscription">ServiceAlreadyStartedException</a></code></dd>
<dd><code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang">SecurityException</a></code></dd>
<dd><code>org.apache.commons.configuration.ConfigurationException</code></dd>
<dd><code><a href="../../../../../../org/apache/juddi/v3/client/transport/TransportException.html" title="class in org.apache.juddi.v3.client.transport">TransportException</a></code></dd>
<dd><code><a href="../../../../../../org/uddi/v3_service/DispositionReportFaultMessage.html" title="class in org.uddi.v3_service">DispositionReportFaultMessage</a></code></dd>
<dd><code><a href="https://docs.oracle.com/javase/6/docs/api/java/rmi/UnexpectedException.html?is-external=true" title="class or interface in java.rmi">UnexpectedException</a></code></dd>
<dd><code><a href="../../../../../../org/apache/juddi/v3/client/subscription/RegistrationAbortedException.html" title="class in org.apache.juddi.v3.client.subscription">RegistrationAbortedException</a></code></dd>
<dd><code><a href="https://docs.oracle.com/javase/6/docs/api/java/net/MalformedURLException.html?is-external=true" title="class or interface in java.net">MalformedURLException</a></code></dd>
<dd><code><a href="../../../../../../org/apache/juddi/v3/client/subscription/UnableToSignException.html" title="class in org.apache.juddi.v3.client.subscription">UnableToSignException</a></code></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>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="https://docs.oracle.com/javase/6/docs/api/javax/xml/ws/Endpoint.html?is-external=true" title="class or interface in javax.xml.ws"><code>Endpoint</code></a></dd>
</dl>
</li>
</ul>
<a name="start-org.apache.juddi.v3.client.config.UDDIClient-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>start</h4>
<pre>public static&nbsp;<a href="../../../../../../org/uddi/api_v3/BindingTemplate.html" title="class in org.uddi.api_v3">BindingTemplate</a>&nbsp;start(<a href="../../../../../../org/apache/juddi/v3/client/config/UDDIClient.html" title="class in org.apache.juddi.v3.client.config">UDDIClient</a>&nbsp;client)
throws <a href="../../../../../../org/apache/juddi/v3/client/subscription/ServiceAlreadyStartedException.html" title="class in org.apache.juddi.v3.client.subscription">ServiceAlreadyStartedException</a>,
<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang">SecurityException</a>,
org.apache.commons.configuration.ConfigurationException,
<a href="../../../../../../org/apache/juddi/v3/client/transport/TransportException.html" title="class in org.apache.juddi.v3.client.transport">TransportException</a>,
<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/UnexpectedException.html?is-external=true" title="class or interface in java.rmi">UnexpectedException</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>,
<a href="../../../../../../org/apache/juddi/v3/client/subscription/RegistrationAbortedException.html" title="class in org.apache.juddi.v3.client.subscription">RegistrationAbortedException</a>,
<a href="../../../../../../org/apache/juddi/v3/client/subscription/UnableToSignException.html" title="class in org.apache.juddi.v3.client.subscription">UnableToSignException</a>,
<a href="https://docs.oracle.com/javase/6/docs/api/java/net/MalformedURLException.html?is-external=true" title="class or interface in java.net">MalformedURLException</a></pre>
<div class="block">Starts a subscription callback service using the juddi client config
file's settings. This will use the config setting PROPERTY_NODE, or
default if not defined</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>client</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a bindingtemplate populated with the relevant information for
most UDDI servers for asynchronous callbacks.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/juddi/v3/client/subscription/ServiceAlreadyStartedException.html" title="class in org.apache.juddi.v3.client.subscription">ServiceAlreadyStartedException</a></code></dd>
<dd><code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang">SecurityException</a></code></dd>
<dd><code>org.apache.commons.configuration.ConfigurationException</code></dd>
<dd><code><a href="../../../../../../org/apache/juddi/v3/client/transport/TransportException.html" title="class in org.apache.juddi.v3.client.transport">TransportException</a></code></dd>
<dd><code><a href="../../../../../../org/uddi/v3_service/DispositionReportFaultMessage.html" title="class in org.uddi.v3_service">DispositionReportFaultMessage</a></code></dd>
<dd><code><a href="https://docs.oracle.com/javase/6/docs/api/java/rmi/UnexpectedException.html?is-external=true" title="class or interface in java.rmi">UnexpectedException</a></code></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>
<dd><code><a href="../../../../../../org/apache/juddi/v3/client/subscription/RegistrationAbortedException.html" title="class in org.apache.juddi.v3.client.subscription">RegistrationAbortedException</a></code></dd>
<dd><code><a href="../../../../../../org/apache/juddi/v3/client/subscription/UnableToSignException.html" title="class in org.apache.juddi.v3.client.subscription">UnableToSignException</a></code></dd>
<dd><code><a href="https://docs.oracle.com/javase/6/docs/api/java/net/MalformedURLException.html?is-external=true" title="class or interface in java.net">MalformedURLException</a></code></dd>
</dl>
</li>
</ul>
<a name="start-org.apache.juddi.v3.client.config.UDDIClient-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>start</h4>
<pre>public static&nbsp;<a href="../../../../../../org/uddi/api_v3/BindingTemplate.html" title="class in org.uddi.api_v3">BindingTemplate</a>&nbsp;start(<a href="../../../../../../org/apache/juddi/v3/client/config/UDDIClient.html" title="class in org.apache.juddi.v3.client.config">UDDIClient</a>&nbsp;client,
<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;cfg_node_name)
throws <a href="../../../../../../org/apache/juddi/v3/client/subscription/ServiceAlreadyStartedException.html" title="class in org.apache.juddi.v3.client.subscription">ServiceAlreadyStartedException</a>,
<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang">SecurityException</a>,
org.apache.commons.configuration.ConfigurationException,
<a href="../../../../../../org/apache/juddi/v3/client/transport/TransportException.html" title="class in org.apache.juddi.v3.client.transport">TransportException</a>,
<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/UnexpectedException.html?is-external=true" title="class or interface in java.rmi">UnexpectedException</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>,
<a href="../../../../../../org/apache/juddi/v3/client/subscription/RegistrationAbortedException.html" title="class in org.apache.juddi.v3.client.subscription">RegistrationAbortedException</a>,
<a href="../../../../../../org/apache/juddi/v3/client/subscription/UnableToSignException.html" title="class in org.apache.juddi.v3.client.subscription">UnableToSignException</a>,
<a href="https://docs.oracle.com/javase/6/docs/api/java/net/MalformedURLException.html?is-external=true" title="class or interface in java.net">MalformedURLException</a></pre>
<div class="block">Starts a subscription callback service using the juddi client config
file's settings. This will use the specified node</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>client</code> - </dd>
<dd><code>cfg_node_name</code> - the node to connect to and perform all
operations on</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a bindingtemplate populated with the relevant information for
most UDDI servers for asynchronous callbacks.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/juddi/v3/client/subscription/ServiceAlreadyStartedException.html" title="class in org.apache.juddi.v3.client.subscription">ServiceAlreadyStartedException</a></code></dd>
<dd><code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang">SecurityException</a></code></dd>
<dd><code>org.apache.commons.configuration.ConfigurationException</code></dd>
<dd><code><a href="../../../../../../org/apache/juddi/v3/client/transport/TransportException.html" title="class in org.apache.juddi.v3.client.transport">TransportException</a></code></dd>
<dd><code><a href="../../../../../../org/uddi/v3_service/DispositionReportFaultMessage.html" title="class in org.uddi.v3_service">DispositionReportFaultMessage</a></code></dd>
<dd><code><a href="https://docs.oracle.com/javase/6/docs/api/java/rmi/UnexpectedException.html?is-external=true" title="class or interface in java.rmi">UnexpectedException</a></code></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>
<dd><code><a href="../../../../../../org/apache/juddi/v3/client/subscription/RegistrationAbortedException.html" title="class in org.apache.juddi.v3.client.subscription">RegistrationAbortedException</a></code></dd>
<dd><code><a href="../../../../../../org/apache/juddi/v3/client/subscription/UnableToSignException.html" title="class in org.apache.juddi.v3.client.subscription">UnableToSignException</a></code></dd>
<dd><code><a href="https://docs.oracle.com/javase/6/docs/api/java/net/MalformedURLException.html?is-external=true" title="class or interface in java.net">MalformedURLException</a></code></dd>
</dl>
</li>
</ul>
<a name="getCallbackURL--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCallbackURL</h4>
<pre>public static&nbsp;<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getCallbackURL()</pre>
<div class="block">gets the current callback url, may be null if the endpoint isn't
started yet</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the current callback url or null</dd>
</dl>
</li>
</ul>
<a name="registerCallback-org.apache.juddi.v3.client.subscription.ISubscriptionCallback-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>registerCallback</h4>
<pre>public static&nbsp;void&nbsp;registerCallback(<a href="../../../../../../org/apache/juddi/v3/client/subscription/ISubscriptionCallback.html" title="interface in org.apache.juddi.v3.client.subscription">ISubscriptionCallback</a>&nbsp;callback)</pre>
<div class="block">Registers an implementation of ISubscriptionCallback for subscription
callbacks from a UDDI server.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>callback</code> - if null, no action is taken</dd>
</dl>
</li>
</ul>
<a name="unRegisterCallback-org.apache.juddi.v3.client.subscription.ISubscriptionCallback-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unRegisterCallback</h4>
<pre>public static&nbsp;void&nbsp;unRegisterCallback(<a href="../../../../../../org/apache/juddi/v3/client/subscription/ISubscriptionCallback.html" title="interface in org.apache.juddi.v3.client.subscription">ISubscriptionCallback</a>&nbsp;callback)</pre>
<div class="block">unregisters a ISubscriptionCallback for callbacks</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>callback</code> - if null, no action is taken</dd>
</dl>
</li>
</ul>
<a name="run--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>run</h4>
<pre>public&nbsp;void&nbsp;run()</pre>
<div class="block">shutdown hook</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Runnable.html?is-external=true#run--" title="class or interface in java.lang">run</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a></code></dd>
</dl>
</li>
</ul>
<a name="registerBinding-org.apache.juddi.v3.client.config.UDDIClient-java.lang.String-org.uddi.api_v3.BindingTemplate-org.apache.juddi.v3.client.subscription.SubscriptionCallbackListener.SignatureBehavior-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>registerBinding</h4>
<pre>public static&nbsp;<a href="../../../../../../org/uddi/api_v3/BindingTemplate.html" title="class in org.uddi.api_v3">BindingTemplate</a>&nbsp;registerBinding(<a href="../../../../../../org/apache/juddi/v3/client/config/UDDIClient.html" title="class in org.apache.juddi.v3.client.config">UDDIClient</a>&nbsp;client,
<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;cfg_node_name,
<a href="../../../../../../org/uddi/api_v3/BindingTemplate.html" title="class in org.uddi.api_v3">BindingTemplate</a>&nbsp;bt,
<a href="../../../../../../org/apache/juddi/v3/client/subscription/SubscriptionCallbackListener.SignatureBehavior.html" title="enum in org.apache.juddi.v3.client.subscription">SubscriptionCallbackListener.SignatureBehavior</a>&nbsp;behavior)
throws <a href="../../../../../../org/apache/juddi/v3/client/subscription/ServiceAlreadyStartedException.html" title="class in org.apache.juddi.v3.client.subscription">ServiceAlreadyStartedException</a>,
<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang">SecurityException</a>,
org.apache.commons.configuration.ConfigurationException,
<a href="../../../../../../org/apache/juddi/v3/client/transport/TransportException.html" title="class in org.apache.juddi.v3.client.transport">TransportException</a>,
<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>,
<a href="https://docs.oracle.com/javase/6/docs/api/java/rmi/UnexpectedException.html?is-external=true" title="class or interface in java.rmi">UnexpectedException</a>,
<a href="../../../../../../org/apache/juddi/v3/client/subscription/RegistrationAbortedException.html" title="class in org.apache.juddi.v3.client.subscription">RegistrationAbortedException</a>,
<a href="../../../../../../org/apache/juddi/v3/client/subscription/UnableToSignException.html" title="class in org.apache.juddi.v3.client.subscription">UnableToSignException</a></pre>
<div class="block">Registers a UDDI binding template that represents the subscription
callback endpoint</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>client</code> - </dd>
<dd><code>cfg_node_name</code> - </dd>
<dd><code>bt</code> - - Binding Template</dd>
<dd><code>behavior</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a binding template</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/juddi/v3/client/subscription/ServiceAlreadyStartedException.html" title="class in org.apache.juddi.v3.client.subscription">ServiceAlreadyStartedException</a></code></dd>
<dd><code><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang">SecurityException</a></code></dd>
<dd><code>org.apache.commons.configuration.ConfigurationException</code></dd>
<dd><code><a href="../../../../../../org/apache/juddi/v3/client/transport/TransportException.html" title="class in org.apache.juddi.v3.client.transport">TransportException</a></code></dd>
<dd><code><a href="../../../../../../org/uddi/v3_service/DispositionReportFaultMessage.html" title="class in org.uddi.v3_service">DispositionReportFaultMessage</a></code></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>
<dd><code><a href="https://docs.oracle.com/javase/6/docs/api/java/rmi/UnexpectedException.html?is-external=true" title="class or interface in java.rmi">UnexpectedException</a></code></dd>
<dd><code><a href="../../../../../../org/apache/juddi/v3/client/subscription/RegistrationAbortedException.html" title="class in org.apache.juddi.v3.client.subscription">RegistrationAbortedException</a></code></dd>
<dd><code><a href="../../../../../../org/apache/juddi/v3/client/subscription/UnableToSignException.html" title="class in org.apache.juddi.v3.client.subscription">UnableToSignException</a></code></dd>
</dl>
</li>
</ul>
<a name="unregisterAllCallbacks--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unregisterAllCallbacks</h4>
<pre>protected static&nbsp;void&nbsp;unregisterAllCallbacks()</pre>
</li>
</ul>
<a name="stop-org.apache.juddi.v3.client.config.UDDIClient-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stop</h4>
<pre>public static&nbsp;void&nbsp;stop(<a href="../../../../../../org/apache/juddi/v3/client/config/UDDIClient.html" title="class in org.apache.juddi.v3.client.config">UDDIClient</a>&nbsp;client,
<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;cfg_node_name,
<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;bindingKey)
throws org.apache.commons.configuration.ConfigurationException</pre>
<div class="block">This effectively stops the endpoint address and notifies all
ISubscriptionCallback clients that the endpoint as been stopped.
After it has been stopped, all ISubscriptionCallback are removed from
the callback list. If the configuration file is set to automatically
register binding templates, the binding template will be unregistered
from the UDDI server</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>client</code> - </dd>
<dd><code>cfg_node_name</code> - </dd>
<dd><code>bindingKey</code> - </dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.commons.configuration.ConfigurationException</code></dd>
</dl>
</li>
</ul>
<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>,
<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"><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>
<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/SubscriptionCallbackListener.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/v3/client/subscription/ServiceAlreadyStartedException.html" title="class in org.apache.juddi.v3.client.subscription"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/juddi/v3/client/subscription/SubscriptionCallbackListener.SignatureBehavior.html" title="enum in org.apache.juddi.v3.client.subscription"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/juddi/v3/client/subscription/SubscriptionCallbackListener.html" target="_top">Frames</a></li>
<li><a href="SubscriptionCallbackListener.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">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><a href="#field.detail">Field</a>&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>