blob: e46bd35fc1d3e94a692986541b6531a6cace7f22 [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>UDDIReplicationPortType (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="UDDIReplicationPortType (UDDIv2 and v3 WS Stubs and Schema Bindings Generated from WSDL 3.3.11-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":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/UDDIReplicationPortType.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/UDDIPublicationPortType.html" title="interface in org.uddi.v3_service"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../org/uddi/v3_service/UDDISecurityPortType.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/UDDIReplicationPortType.html" target="_top">Frames</a></li>
<li><a href="UDDIReplicationPortType.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 UDDIReplicationPortType" class="title">Interface UDDIReplicationPortType</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">UDDIReplicationPortType</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 replication operations.
This class was generated by the JAX-WS RI. JAX-WS RI 2.1.5-b03- Generated
source version: 2.1
<p class="MsoBodyText">UDDI Replication defines four APIs. The first two
presented here are used to perform replication and issue notifications. The
latter ancillary APIs provide support for other aspects of UDDI
Replication.</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>get_changeRecords</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>notify_changeRecordsAvailable</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>do_ping</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>get_highWaterMarks</p></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="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/uddi/v3_service/UDDIReplicationPortType.html#doPing-org.uddi.repl_v3.DoPing-">doPing</a></span>(<a href="../../../org/uddi/repl_v3/DoPing.html" title="class in org.uddi.repl_v3">DoPing</a>&nbsp;body)</code>
<div class="block">This UDDI API message provides the means by which the current existence
and replication readiness of a node may be obtained.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../org/uddi/repl_v3/ChangeRecords.html" title="class in org.uddi.repl_v3">ChangeRecords</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/uddi/v3_service/UDDIReplicationPortType.html#getChangeRecords-org.uddi.repl_v3.GetChangeRecords-">getChangeRecords</a></span>(<a href="../../../org/uddi/repl_v3/GetChangeRecords.html" title="class in org.uddi.repl_v3">GetChangeRecords</a>&nbsp;body)</code>
<div class="block">The get_changeRecords message is used to initiate the replication of
change records from one node to another.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../org/uddi/repl_v3/ChangeRecordIDType.html" title="class in org.uddi.repl_v3">ChangeRecordIDType</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/uddi/v3_service/UDDIReplicationPortType.html#getHighWaterMarks--">getHighWaterMarks</a></span>()</code>
<div class="block">This UDDI API message provides a means to obtain a list of highWaterMark
element containing the highest known USN for all nodes in the replication
graph.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/uddi/v3_service/UDDIReplicationPortType.html#notifyChangeRecordsAvailable-org.uddi.repl_v3.NotifyChangeRecordsAvailable-">notifyChangeRecordsAvailable</a></span>(<a href="../../../org/uddi/repl_v3/NotifyChangeRecordsAvailable.html" title="class in org.uddi.repl_v3">NotifyChangeRecordsAvailable</a>&nbsp;body)</code>
<div class="block"><p class="MsoBodyText">Nodes can inform other nodes that they have new
change records available for consumption by replication by using this
message.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/uddi/v3_service/UDDIReplicationPortType.html#transferCustody-org.uddi.repl_v3.TransferCustody-">transferCustody</a></span>(<a href="../../../org/uddi/repl_v3/TransferCustody.html" title="class in org.uddi.repl_v3">TransferCustody</a>&nbsp;body)</code>
<div class="block">Invoked by the target node in a custody transfer operation in response to
transfer_entities, this API is used by the custodial node to ensure that
permission has been granted to transfer custody of the entities that the
target publisher has requested.</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="getChangeRecords-org.uddi.repl_v3.GetChangeRecords-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChangeRecords</h4>
<pre><a href="../../../org/uddi/repl_v3/ChangeRecords.html" title="class in org.uddi.repl_v3">ChangeRecords</a>&nbsp;getChangeRecords(<a href="../../../org/uddi/repl_v3/GetChangeRecords.html" title="class in org.uddi.repl_v3">GetChangeRecords</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">The get_changeRecords message is used to initiate the replication of
change records from one node to another. The caller, who wishes to
receive new change records, provides as part of the message a high water
mark vector. This is used by the replication source node to determine
what change records satisfy the caller’s request. <p
class="MsoBodyText">More specifically, the recipient determines the
particular change records that are returned by comparing the originating
USNs in the caller’s high water mark vector with the originating USNs of
each of the changes the recipient has seen from others or generated by
itself.&nbsp; The recipient SHOULD only return change records that have
originating USNs that are greater than those listed in the
changesAlreadySeen highWaterMarkVector and less than the limit required
by either the responseLimitCount or the responseLimitVector.</p>
<p class="MsoBodyText">In nodes that support pre-bundled replication
responses, the recipient of the get_changeRecords message MAY return more
change records than requested by the caller.&nbsp; In this scenario, the
caller MUST also be prepared to deal with such redundant changes where a
USN is less than the USN specified in the changesAlreadySeen
highWaterMarkVector. </p>
<p class="MsoBodyText">The response to a get_changeRecords message is a
changeRecords element. Under all circumstances, all change records
returned therein by the message recipient MUST be returned sorted in
increasing order according to the recipient’s local USN.</p>
<p><b>A node that is ready to initiate replication of change records held
at another node within the registry uses the get_changeRecords message.
Part of the message is a high water mark vector that contains for each
node of the registry the originating USN of the most recent change record
that has been successfully processed by the invocating node. The effect
of receiving a get_changeRecords message causes a node to return to the
calling node change records it has generated locally and processed from
other nodes constrained by the directives of the high water mark vector
specified. As such, by invoking get_changeRecords a node obtains from its
adjacent node all change records (constrained by the high water mark
vector) the adjacent node has generated locally or successfully processed
from other nodes participating in the replication topology. What
constitutes an adjacent node is governed by the replication communication
graph. Replication topology is controlled via a Replication Configuration
Structure. Amongst other parameters, the Replication Configuration
Structure identifies one unique URL to represent the replication point,
soapReplicationURL, of each of the nodes of the registry.
</b></p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>responseLimitVector</code> - responseLimitCount or responseLimitVector: A
caller MAY place an upper bound on the number of change records he wishes
to receive in response to this message by either providing a integer
responseLimitCount, or, using responseLimitVector, indicating for each
node in the graph the first change originating there that he does not
wish to be returned.</dd>
<dd><code>requestingNode</code> - requestingNode: The requestingNode element provides
the identity of the calling node. This is the unique key for the calling
node and SHOULD be specified within the Replication Configuration
Structure.</dd>
<dd><code>changesAlreadySeen</code> - changesAlreadySeen: The changesAlreadySeen
element, if present, indicates changes from each node that the requestor
has successfully processed, and thus which should not be resent, if
possible.</dd>
<dd><code>responseLimitCount</code> - responseLimitCount or responseLimitVector: A
caller MAY place an upper bound on the number of change records he wishes
to receive in response to this message by either providing a integer
responseLimitCount, or, using responseLimitVector, indicating for each
node in the graph the first change originating there that he does not
wish to be returned.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>returns java.util.List<org.uddi.repl_v3.ChangeRecord> A node will
respond with the corresponding changeRecords.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>DispositionReportFaultMessage,</code> - RemoteException Processing an
inbound replication message may fail due to a server internal error. The
common behavior for all error cases is to return an E_fatalError error
code. Error reporting SHALL be that specified by Section 4.8 – Success
and Error Reporting of this specification.</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>
</dl>
</li>
</ul>
<a name="notifyChangeRecordsAvailable-org.uddi.repl_v3.NotifyChangeRecordsAvailable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>notifyChangeRecordsAvailable</h4>
<pre>void&nbsp;notifyChangeRecordsAvailable(<a href="../../../org/uddi/repl_v3/NotifyChangeRecordsAvailable.html" title="class in org.uddi.repl_v3">NotifyChangeRecordsAvailable</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"><p class="MsoBodyText">Nodes can inform other nodes that they have new
change records available for consumption by replication by using this
message. This provides a proactive means through which replication can be
initiated, potentially reducing the latency of the dissemination of
changes throughout the set of UDDI nodes.&nbsp; The
notify_changeRecordsAvailable message is the predecessor to the
get_changeRecords message.</p>
<p class="MsoBodyText">Each node MUST respond with the message defined
within the Section <a href="#_Ref8980611 ">7.4.2.3</a> <i>Returns</i>
when a valid notify_changeRecordsAvailable message is received.&nbsp;
</p>
<p class="MsoBodyText">At an interval set by policy after the origination
of new change records within its node, a node SHOULD send this message to
each of the other nodes with which it is configured to communicate this
message according to the currently configured communication graph. It
SHOULD ignore any response (errors or otherwise) returned by such
invocations.</p></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>notifyingNode</i></b>: The parameter to this message
indicates that the notifyingNode has available the indicated set of
changes for request via get_changeRecords. </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>changesAvailable</i></b>: When sending the
notify_changeRecordsAvailable message, a node shall provide a high water
mark vector identifying what changes it knows to exist both locally and
on other nodes with which it might have had communications. Typically, no
communication graph restrictions are present for the
notify_changeRecordsAvailable message.&nbsp; In the event that the
sending node does not know the USN for a specific node within the
CommunicationGraph, the changesAvailable element MAY contain a
highWaterMark for that node with an unspecified nodeID element. </p>
<span
style="font-size:10.0pt;font-family:Arial;letter-spacing:-.25pt"></span>
Success reporting SHALL be that specified by Section 4.8 –
Success and Error Reporting of this specification.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>DispositionReportFaultMessage,</code> - RemoteException Processing an
inbound replication message may fail due to a server internal error. The
common behavior for all error cases is to return an E_fatalError error
code. Error reporting SHALL be that specified by Section 4.8 – Success
and Error Reporting of this specification.</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>
</dl>
</li>
</ul>
<a name="doPing-org.uddi.repl_v3.DoPing-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doPing</h4>
<pre><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;doPing(<a href="../../../org/uddi/repl_v3/DoPing.html" title="class in org.uddi.repl_v3">DoPing</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 UDDI API message provides the means by which the current existence
and replication readiness of a node may be obtained.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>body</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>returns java.lang.String The response to this message must
contain the operatorNodeID element of the pinged node.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>DispositionReportFaultMessage,</code> - RemoteException Processing an
inbound replication message may fail due to a server internal error. The
common behavior for all error cases is to return an E_fatalError error
code. Error reporting SHALL be that specified by Section 4.8 – Success
and Error Reporting of this specification.</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>
</dl>
</li>
</ul>
<a name="getHighWaterMarks--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHighWaterMarks</h4>
<pre><a href="https://docs.oracle.com/javase/6/docs/api/javax/xml/ws/RequestWrapper.html?is-external=true" title="class or interface in javax.xml.ws">@RequestWrapper</a>(<a href="https://docs.oracle.com/javase/6/docs/api/javax/xml/ws/RequestWrapper.html?is-external=true#localName--" title="class or interface in javax.xml.ws">localName</a>="get_highWaterMarks",
<a href="https://docs.oracle.com/javase/6/docs/api/javax/xml/ws/RequestWrapper.html?is-external=true#targetNamespace--" title="class or interface in javax.xml.ws">targetNamespace</a>="urn:uddi-org:repl_v3",
<a href="https://docs.oracle.com/javase/6/docs/api/javax/xml/ws/RequestWrapper.html?is-external=true#className--" title="class or interface in javax.xml.ws">className</a>="org.uddi.repl_v3.GetHighWaterMarks")
<a href="https://docs.oracle.com/javase/6/docs/api/javax/xml/ws/ResponseWrapper.html?is-external=true" title="class or interface in javax.xml.ws">@ResponseWrapper</a>(<a href="https://docs.oracle.com/javase/6/docs/api/javax/xml/ws/ResponseWrapper.html?is-external=true#localName--" title="class or interface in javax.xml.ws">localName</a>="highWaterMarks",
<a href="https://docs.oracle.com/javase/6/docs/api/javax/xml/ws/ResponseWrapper.html?is-external=true#targetNamespace--" title="class or interface in javax.xml.ws">targetNamespace</a>="urn:uddi-org:repl_v3",
<a href="https://docs.oracle.com/javase/6/docs/api/javax/xml/ws/ResponseWrapper.html?is-external=true#className--" title="class or interface in javax.xml.ws">className</a>="org.uddi.repl_v3.HighWaterMarkVectorType")
<a href="https://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../org/uddi/repl_v3/ChangeRecordIDType.html" title="class in org.uddi.repl_v3">ChangeRecordIDType</a>&gt;&nbsp;getHighWaterMarks()
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 UDDI API message provides a means to obtain a list of highWaterMark
element containing the highest known USN for all nodes in the replication
graph.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>returns java.util.List<org.uddi.repl_v3.ChangeRecordIDType> <p
class="MsoBodyText">A highWaterMarks element is returned that contains a
list of highWaterMark elements listing the highest known USN for all
nodes in the replication communication graph. See Section <a
href="#_Ref52863431 ">7.2.4</a> <i>High Water Mark Vector</i> for
details.</p>
<p class="MsoBodyText"><img
src="http://uddi.org/pubs/uddi-v3.0.2-20041019_files/image129.gif"
border="0" height="88" width="349"></p>
<p class="MsoBodyText">If the highest originatingUSN for a specific node
within the registry is not known, then the responding node MUST return a
highWaterMark for that node with an originatingUSN of 0 (zero).</p>
<p class="codeSample">&lt;highWaterMark&gt;</p>
<p class="codeSample">&nbsp;&nbsp; &lt;nodeID&gt;…&lt;/nodeID&gt;</p>
<p class="codeSample">&nbsp;&nbsp;
&lt;originatingUSN&gt;<b>0</b>&lt;/originatingUSN&gt;</p>
<p class="codeSample">&lt;/highWaterMark&gt;</p></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>DispositionReportFaultMessage,</code> - RemoteException Processing an
inbound replication message may fail due to a server internal error. The
common behavior for all error cases is to return an E_fatalError error
code. Error reporting SHALL be that specified by Section 4.8 – Success
and Error Reporting of this specification.</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>
</dl>
</li>
</ul>
<a name="transferCustody-org.uddi.repl_v3.TransferCustody-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>transferCustody</h4>
<pre>void&nbsp;transferCustody(<a href="../../../org/uddi/repl_v3/TransferCustody.html" title="class in org.uddi.repl_v3">TransferCustody</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">Invoked by the target node in a custody transfer operation in response to
transfer_entities, this API is used by the custodial node to ensure that
permission has been granted to transfer custody of the entities that the
target publisher has requested. The transfer_custody API is in the
replication namespace since it is sent from one node to another node in a
registry using replication.</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>transferToken</i></b>: Required argument obtained
from the custodial node via a call to get_transferToken by the publisher
requesting a transfer of custody. The transferToken contains an opaque
token, an expiration date, and the identity of the custodial node.&nbsp;
The transferToken represents permission to transfer the entities that
have been identified via a prior call to the get_transferToken API. The
custodial node MUST verify that the transferToken has not expired and
that the businessKey and tModelKey elements that the target publisher has
provided in transfer_entities are allowed to be transferred as captured
in the transfer token’s opaqueToken.</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>keyBag</i></b>: One or more uddiKeys associated with
businessEntity or tModel entities that the target publisher is requesting
ownership of at the target node in the registry. The set of keys must be
the same as the set of keys in the keyBag of the get_transferToken API
call from which the given transferToken was once obtained.</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>transferOperationalInfo</i></b>: Required argument.
The accepting publisher’s authorizedName and the accepting node’s nodeID
are provided on input to the relinquishing custodial node to allow it to
update the operationalInfo associated with the entities whose custody is
being transferred. The authorizedName and nodeID elements are both
required. The accepting node’s nodeID is obtained via the Replication
Configuration structure as described in Section <a href="#_Ref8979701
">7.5.2</a> <i>Configuration of a UDDI Node – operator element</i>. The
authorizedName is obtained from the call to transfer_entities by the
requesting publisher.</p>
<p class="MsoBodyText">The custodial node must verify that it has
granted permission to transfer the entities identified and that this
permission is still valid.&nbsp; This operation is comprised of two
steps:</p>
<p class="MsoBodyText"
style="margin-left:1.0in;text-indent:-.25in">1.<span style="font:7.0pt
&quot;Times New Roman&quot;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</span>Verification that the transferToken was issued by it, that it has
not expired, that it represents the authority to transfer no more and no
less than those entities identified by the businessKey and tModelKey
elements and that all these entities are still valid and not yet
transferred. The transferToken is invalidated if any of these conditions
are not met.</p>
<p class="MsoBodyText"
style="margin-left:1.0in;text-indent:-.25in">2.<span style="font:7.0pt
&quot;Times New Roman&quot;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</span>If the conditions above are met, the custodial node will prevent
any further changes to the entities identified by the businessKey and
tModelKey elements identified. The entity will remain in this state until
the replication stream indicates it has been successfully processed via
the replication stream.&nbsp; </p>
<p class="MsoBodyText">Upon successful verification of the custody
transfer request by the custodial node, an empty message is returned by
it indicating the success of the request and acknowledging the custody
transfer.&nbsp; </p>
<p class="MsoBodyText">Following the issue of the empty message, the
custodial node will submit into the replication stream a
changeRecordNewData providing in the operationalInfo, the nodeID
accepting custody of the datum and the authorizedName of the publisher
accepting ownership. The acknowledgmentRequested attribute of this change
record MUST be set to "true".</p>
<p class="MsoBodyText">Finally, the custodial node invalidates the
transferToken in order to prevent additional calls of the
transfer_entities API.</p></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>DispositionReportFaultMessage,</code> - RemoteException <p
class="MsoBodyText">If an error occurs in processing this API call, a
dispositionReport structure MUST be returned to the caller in a SOAP
Fault. See Section <a href="#_Ref8979747 ">4.8</a> <i>Success and Error
Reporting.&nbsp; </i>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_transferNotAllowed</b>: signifies that the transfer of
one or more entities has been rejected by the custodial node.&nbsp;
Reasons for rejection include expiration of the transferToken and
attempts to transfer a set of entities that does not match the one
represented by the transferToken. The reason for rejecting the custody
transfer SHOULD be clearly indicated in the error text.<a
name="_Toc528997532"></a><a name="_Toc525464292"></a><a
name="_Toc535517200"></a></p>
<p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><a
name="_Toc42047326"><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_invalidKeyPassed</b>: signifies that one of the
<i>uddiKey</i> values passed for entities to be transferred did not match
with any known businessKey or tModelKey values. The key and element or
attribute that caused the problem SHOULD be clearly indicated in the
error text.</a></p>
<h3><a name="_Toc45095949">Security Configuration for
transfer_custody</a></h3>
<p class="MsoBodyText">The use of mutual authentication of UDDI nodes in
conjunction with the transfer_custody API is RECOMMENDED. This MAY be
achieved using mutual X.509v3 certificate-based authentication as
described in the Secure Sockets Layer (SSL) 3.0 protocol.&nbsp; SSL 3.0
with mutual authentication is represented by the tModel
uddi-org:mutualAuthenticatedSSL3 as described within Section <a
href="#_Ref8980795 ">11.3.2</a> <i>Secure Sockets Layer Version 3 with
Mutual Authentication</i>.</p></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>
</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/UDDIReplicationPortType.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/UDDIPublicationPortType.html" title="interface in org.uddi.v3_service"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../org/uddi/v3_service/UDDISecurityPortType.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/UDDIReplicationPortType.html" target="_top">Frames</a></li>
<li><a href="UDDIReplicationPortType.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>