Google Git
Sign in
apache / juddi / refs/heads/asf-site / . / uddi-ws / apidocs / org / uddi / v3_service / UDDICustodyTransferPortType.html
blob: b0ff7d2435424ef1300edc8f606ecac591c8aa5d [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>UDDICustodyTransferPortType (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="UDDICustodyTransferPortType (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};
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/UDDICustodyTransferPortType.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/DispositionReportFaultMessage.html" title="class in org.uddi.v3_service"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../org/uddi/v3_service/UDDIInquiryPortType.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/UDDICustodyTransferPortType.html" target="_top">Frames</a></li>
<li><a href="UDDICustodyTransferPortType.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 UDDICustodyTransferPortType" class="title">Interface UDDICustodyTransferPortType</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">UDDICustodyTransferPortType</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 custody transfer operations. This
section defines the UDDI Custody and Ownership Transfer API Set[28]. Data
custody is introduced in Section 1.5.6 Data Custody. Ownership transfer is
introduced in Section 1.5.7 Transfer of Ownership. By virtue of having
created an entity, a publisher has ownership of the entity and is said to be
the owner of the entity. A custodial node MUST maintain a relationship of
ownership between an entity and its publisher by means of authorization
mechanisms. Every node of a multi-node registry MUST guarantee the integrity
of an entity's custody. As such, a node MUST not permit changes to an entity
unless it has custody of it.
The Custody and Ownership Transfer API Set enables any nodes of a registry to
cooperatively transfer custody of one or more businessEntity or tModel
structures from one node to another, as well as allowing the transfer of
ownership of these structures from one publisher to another. Associated
entities of a businessEntity such as its businessService, bindingTemplate,
and publisherAssertion structures are transferred as part of the custody
transfer of the business entity. * From a custody transfer point of view, the
publishers are always distinct, though it may be the case that the publishers
are the same person. Also, the two nodes may or may not be distinct;
intra-node transfer between two publishers is simply a degenerate case in
which node custody does not change. Thus, in the case of an inter-node
transfer, ownership transfer is implied. In the case of an intra-node
transfer the behavior results in the transfer of ownership between two
publishers.
For example, one UDDI registry, UDDI-1, MAY allow each node in UDDI-1
(composed of nodes 1A, 1B and 1C) to define its own policies for
registration, authentication and authorization. In this case, a "person",
(P1) would need to review the policies of all 3 nodes and decide upon the
node with which it chooses to register with. P1 may choose to register with
more than one node. P1 registers with node1A . Node1A also specifies how P1
is authenticated. If P1 successfully authenticates and publishes a business
entity (BE1) then P1 becomes the "owner" of BE1. Node1A is said to be the
"custodian" of BE1. P1 can also register at node1B. If P1 successfully
authenticates and publishes a business entity (BE2) then P1 becomes the
"owner" of BE2. Node1B is said to be the "custodian" of BE2. There is no
assumption that the registry UDDI-1 or its nodes (node1A and node1B) are
aware that P1 is the same "person". P1 is responsible for maintaining the
appropriate identity and authenticating correctly to each node within a
registry.
Another UDDI registry, UDDI-2, MAY require each of its nodes (node2-1,
node2-2 and node2-3) to use the same registration, authentication and
authorization mechanisms. In this case, the policies are the same across all
nodes. The relationship of registration, publication and ownership remains
the same. If P1 wants to register with different nodes in UDDI-2, then it
needs to differentiate its registration with the different nodes, since an
attempt to register at node2-2 after registering at node2-1, would fail as
"already registered" (since by policy the nodes all share the same
registration, authentication and authorization).
5.4.1 Overview There are a number of scenarios where a publisher may choose
to transfer custodianship or ownership of one or more entities. These are
described in this section.
5.4.1.1 Intra-Node Ownership Transfer Intra-node ownership transfer involves
transferring entity ownership from one publisher to another within the same
UDDI node. Usage scenarios for this type of transfer include the following:
· Businesses or organizational merges: Multiple organizations need to be
consolidated under the control of a single publisher.
· Domain key generators: One use of ownership transfer is the transfer of
ownership of a derived key generator from one publisher to another to enable
her or him to publish entities using keys in that domain.
The save_xx APIs can also be used to move entities between parent entities
that are owned by the same publisher. The save_service API, for example, can
be used to move services (and binding templates) between one business entity
and another as described in Section 5.2.17.3 Behavior of the save_service
API. Changing the parent relationship in this way causes two businessEntity
structures to be changed. Doing so enables the following scenarios:
· Divestitures: An organization needs to reassign the control of a set of
services to two or more publishers.
· Consolidation of registry entities: There are multiple entities for a given
business that are to be consolidated under a single publisher.
5.4.1.2 Inter-Node Custody Transfer Inter-node custody transfer involves the
custody transfer of a set of entities across nodes of a UDDI registry. A
transfer of ownership ensues as a consequence of this custody transfer. In
addition to the intra-node scenarios described above, inter-node custody
transfer may be used to address the following use cases:
· Unsatisfactory service level: The functionality or service level provided
by a given node operator is insufficient, and the publisher wishes to move
their UDDI data to another node.
· Change in availability for a UDDI node: A node is no longer providing UDDI
services, and all publishers need to be migrated to one or more nodes of the
registry.
· Organizational Mergers, Divestitures or Consolidations: Changes in
organizational structure may result in the need to make changes to the set of
publishers used to manage the entities at various nodes of a registry.
For any of these intra and inter-node scenarios, a mechanism is specified to
facilitate the transfer the custody of businessEntity and tModel entities
between nodes whether the entity is being transferred within a single node or
whether a custody transfer occurs between nodes of a registry.
5.4.2 Custody Transfer Considerations When a businessEntity is transferred,
all related businessService and bindingTemplate elements are transferred as
well. In addition, any publisherAssertion elements that reference the
businessEntity element’s businessKey that are owned by the publisher are also
transferred.
Note that the relinquishing publisher is not required to transfer all of its
UDDI entities (i.e. businessEntity and/or tModel entities) in a single
custody transfer request, nor is it required to transfer all of its entities
to the same target publisher or target node. Any combination or subset of
UDDI registry entities may be transferred to any number of target publishers
or nodes.
5.4.3 Transfer Execution The Custody and Ownership Transfer API Set enables
two publishers P1 and P2 and two nodes, N1 and N2, in a registry to
cooperatively transfer custody of one or more existing businessEntity or
tModel structures, E1…En, from N1 to N2 and, and by extension to transfer
ownership of the entities from P1 to P2. Related businessService,
bindingTemplate, and publisherAssertion structures are transferred with their
related businessEntities. From the registry’s point of view, the publishers
are always distinct, though it may be the case that P1 and P2 are the same
party. The two nodes may or may not be distinct; intra-node transfer of
ownership from P1 to P2 is simply a degenerate case in which node custody
does not change.
The Custody and Ownership Transfer API Set is divided into two parts, a set
of two client APIs and a single inter-node API. These client APIs are
get_transferToken and transfer_entities; in short, this constitutes the
Ownership Transfer API portion of this API set. The inter-node-API is
transfer_ custody which when combined with replication makes up the Custody
Transfer API portion of this API set. * The overall flow of custody and
ownership transfer is as follows:
Publisher P1 invokes get_transferToken on N1, specifying the keys K1…Kn of
the entities E1…En that are to be transferred. If P1 is authorized to do this
(i.e., if P1 has ownership of E1…En), N1 returns a structure T, called a
transfer token, that represents authority to transfer the entities, including
all of the naturally contained children and publisher assertions related to
business entities involved in the transfer that are owned by P1. The
transferToken is a structure that consists of an opaque string that is
meaningful only to the node that issued it, an expiration time, and a node
identifier.
P1 then gives T to P2 (typically by some secure means since T is valuable).
The publisher obtaining the custody information needs to have previously
obtained a publishers account on the node accepting custody of the entity
before he/she can complete the custody transfer. P2 then invokes
transfer_entities on N2, passing K1…Kn and T. If transfer_entities completes
successfully, the entities E1…En and their related structures
(businessService, bindingTemplate, and publisherAssertion) are in the custody
of N2 and are owned by P2. If the operation fails, nothing happens to the
entities. The actual transfer proceeds as follows, in the processing of
transfer_entities.
If N1 and N2 are not distinct nodes, the ownership transfer from P1 to P2 is
an operation that is purely internal to the node – how it happens is up to
the implementation. If N1 and N2 are distinct, the following protocol occurs
while processing the transfer_entities request on N2.
Upon receipt of a transfer_entities request, N2 checks that K1…Kn are valid
keys. There is the possibility that P1 might transfer more data than P2 can
accept due to policy-based restrictions on the limit of entities allowed to
be owned by P2 at N2. As is described below, replication is used to complete
the custody transfer process. A question that arises is at the time of
accepting the datum related to the transfer, could N2 throw a replication
error because the data being transferred exceeds the limits of user P2? Such
limits can not be enforced during replication because they are node-local
policy decisions from the perspective of enforcement. Thus, it is therefore
possible that as a result of a custody transfer a publisher may be caused to
hold more data that he/she would have been able to publish. Should this
situation occur, P2 MUST not be allowed to publish any additional data unless
P2 first reduces the number of entries it owns to an allowable limit.
If all is well, N2 invokes the inter-node API transfer_custody on N1,
presenting the keys of top-level entities to be transferred, K1…Kn, P2’s
identity (using the publisher’s authorizedName), N2’s node identifier (as
known in the Replication Configuration structure, see Section 7.5.2
Configuration of a UDDI Node – operator element), and T. The transferToken,
T, implies permission to transfer the entire content of the entities it
identifies, including all of the contained entities and related
publisherAssertions, if any. N1 checks to see whether T is a valid
transferToken that it issued and that T represents the authority to transfer
E1…En. If the validation is successful, N1 prevents further changes to
entities E1…En. N1 then updates the authorizedName and nodeID of the
operationalInfo of E1…En and related entities so that they are shown to be in
the custody of N2 and owned by P2. Finally, N1 responds to N2 which triggers
N2 to respond to the transfer_entities caller. This completes the processing
for the transfer_entities request.
In the case that the datum being transferred is a key generator tModel, N1
will disallow further generation of keys associated with this key partition
at its node.
Following the issue of the empty message by N1 to the transfer_custody call,
N1 will submit into the replication stream a changeRecordNewData providing in
the operationalInfo, N2’s nodeID identifying it as the node where the datum
is being transferred to, and the authorizedName of P2. The
acknowledgmentRequested attribute of this change record MUST be set to
"true".
The last modified date timestamp in the operationalInfo must change to
reflect the custody transfer. Figure 2 depicts the flow of a custody transfer
between P1 and P2. This class was generated by the JAX-WS RI. JAX-WS RI
2.1.5-b03- Generated source version: 2.1</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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/uddi/v3_service/UDDICustodyTransferPortType.html#discardTransferToken-org.uddi.custody_v3.DiscardTransferToken-">discardTransferToken</a></span>(<a href="../../../org/uddi/custody_v3/DiscardTransferToken.html" title="class in org.uddi.custody_v3">DiscardTransferToken</a>&nbsp;body)</code>
<div class="block">The discard_transferToken API is a client API used to discard a
transferToken obtained through the get_transferToken API at the same
node.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/uddi/v3_service/UDDICustodyTransferPortType.html#getTransferToken-java.lang.String-org.uddi.custody_v3.KeyBag-javax.xml.ws.Holder-javax.xml.ws.Holder-javax.xml.ws.Holder-">getTransferToken</a></span>(<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;authInfo,
<a href="../../../org/uddi/custody_v3/KeyBag.html" title="class in org.uddi.custody_v3">KeyBag</a>&nbsp;keyBag,
<a href="https://docs.oracle.com/javase/6/docs/api/javax/xml/ws/Holder.html?is-external=true" title="class or interface in javax.xml.ws">Holder</a>&lt;<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>&gt;&nbsp;nodeID,
<a href="https://docs.oracle.com/javase/6/docs/api/javax/xml/ws/Holder.html?is-external=true" title="class or interface in javax.xml.ws">Holder</a>&lt;<a href="https://docs.oracle.com/javase/6/docs/api/javax/xml/datatype/XMLGregorianCalendar.html?is-external=true" title="class or interface in javax.xml.datatype">XMLGregorianCalendar</a>&gt;&nbsp;expirationTime,
<a href="https://docs.oracle.com/javase/6/docs/api/javax/xml/ws/Holder.html?is-external=true" title="class or interface in javax.xml.ws">Holder</a>&lt;byte[]&gt;&nbsp;opaqueToken)</code>
<div class="block">The get_transferToken API is a client API used to initiate the transfer
of custody of one or more businessEntity or tModel entities from one node
to another.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/uddi/v3_service/UDDICustodyTransferPortType.html#transferEntities-org.uddi.custody_v3.TransferEntities-">transferEntities</a></span>(<a href="../../../org/uddi/custody_v3/TransferEntities.html" title="class in org.uddi.custody_v3">TransferEntities</a>&nbsp;body)</code>
<div class="block">The transfer_entities API is used by publishers to whom custody is being
transferred to actually perform the transfer.</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="discardTransferToken-org.uddi.custody_v3.DiscardTransferToken-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>discardTransferToken</h4>
<pre>void&nbsp;discardTransferToken(<a href="../../../org/uddi/custody_v3/DiscardTransferToken.html" title="class in org.uddi.custody_v3">DiscardTransferToken</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 discard_transferToken API is a client API used to discard a
transferToken obtained through the get_transferToken API at the same
node. This API accepts either a transferToken or a keyBag as parameters
to remove the permission to transfer data associated with a particular
transferToken. If a keyBag is provided, all tokens corresponding to the
keys in the keyBag will be discarded and will no longer be valid for
custody or ownership transfer after the discard_transferToken is
processed, irrespective of whether the keys match any known business or
tmodelKey values. In the event that the keyBag represents a subset of the
keyBag for one or more transferToken elements, the transferToken is
discarded and will no longer be valid for transferring any entity. If the
token passed in the transferToken argument does not match an existing
token known to the system, no action is taken and success is reported.
Keys in the keyBag argument that do not have a corresponding token are
ignored.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>body</code> - <p class="MsoBodyText"
style="margin-left:1.0in;text-indent:-.25in"><span
style="font-family:Symbol">·<span style="font:7.0pt &quot;Times New
Roman&quot;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</span></span><b><i>authInfo</i></b>: This OPTIONAL argument is an
element that contains an authentication token.&nbsp; Authentication
tokens are obtained using the get_authToken API call or through some
other means external to this specification, and represent the identity of
the publisher at a UDDI node.</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>transferToken</i></b>: This is a known transferToken
obtained by a publisher at the node where the get_transferToken API was
invoked.</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
either with businessEntity or tModel entities owned by the publisher that
were to be transferred to some other publisher and/or node in the
registry as the result of invocation of get_transferToken.&nbsp; At least
one businessKey or tModelKey must be provided in a keyBag.</p>
<Br>
Upon successful completion, an empty message is returned. See
section 4.8 Success and Error Reporting.
No error will be reported if the transferToken provided in the call does
not match an existing token. No error will be reported if a token is not
found for a particular key in the keyBag.</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></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> - <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="#_Ref8979716
">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><span
style="font-size:7.0pt;font-family: &quot;Times New
Roman&quot;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</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.&nbsp; The key and element
or attribute that caused the problem SHOULD be clearly indicated in the
error text.</p></dd>
</dl>
</li>
</ul>
<a name="getTransferToken-java.lang.String-org.uddi.custody_v3.KeyBag-javax.xml.ws.Holder-javax.xml.ws.Holder-javax.xml.ws.Holder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTransferToken</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_transferToken",
<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:custody_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.custody_v3.GetTransferToken")
<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>="transferToken",
<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:custody_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.custody_v3.TransferToken")
void&nbsp;getTransferToken(<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;authInfo,
<a href="../../../org/uddi/custody_v3/KeyBag.html" title="class in org.uddi.custody_v3">KeyBag</a>&nbsp;keyBag,
<a href="https://docs.oracle.com/javase/6/docs/api/javax/xml/ws/Holder.html?is-external=true" title="class or interface in javax.xml.ws">Holder</a>&lt;<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>&gt;&nbsp;nodeID,
<a href="https://docs.oracle.com/javase/6/docs/api/javax/xml/ws/Holder.html?is-external=true" title="class or interface in javax.xml.ws">Holder</a>&lt;<a href="https://docs.oracle.com/javase/6/docs/api/javax/xml/datatype/XMLGregorianCalendar.html?is-external=true" title="class or interface in javax.xml.datatype">XMLGregorianCalendar</a>&gt;&nbsp;expirationTime,
<a href="https://docs.oracle.com/javase/6/docs/api/javax/xml/ws/Holder.html?is-external=true" title="class or interface in javax.xml.ws">Holder</a>&lt;byte[]&gt;&nbsp;opaqueToken)
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_transferToken API is a client API used to initiate the transfer
of custody of one or more businessEntity or tModel entities from one node
to another. As previously stated, the two nodes may or may not be
distinct; intra-node transfer between two publishers is simply a
degenerate case in which node custody does not change. No actual transfer
takes place with the invocation of this API. Instead, this API obtains
permission from the custodial node, in the form of a transferToken, to
perform the transfer. The publisher who will be recipient of the
transferToken returned by this API must invoke the transfer_entities API
on the target custodial node to actually transfer the entities.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>authInfo</code> - · authInfo: This OPTIONAL argument is an element that
contains an authentication token. Authentication tokens are obtained
using the get_authToken API call or through some other means external to
this specification and represent the identity of the publisher at a UDDI
node.</dd>
<dd><code>keyBag</code> - keyBag: One or more key (of type uddi:uddiKey) associated
either with businessEntity or tModel entities owned by the publisher that
are to be transferred to some other publisher and/or node in the
registry. At least one businessKey or tModelKey must be provided.</dd>
<dd><code>nodeID</code> - this is a return value. The transfer token consists of a
nodeID, an expirationTime and an opaqueToken. The nodeID is used during
the transfer_entities API by the recipient node to confirm with the
relinquishing custodial node that the custody transfer is authorized and
still valid. The nodeID of the transferToken is the value of the nodeID
element of the Replication Configuration Structure. Refer to Section
7.5.2 Configuration of a UDDI Node – operator Element.</dd>
<dd><code>expirationTime</code> - this is a return value. The expirationTime, defined
as xsd:dateTime, represents the time at which the transfer token is no
longer valid.</dd>
<dd><code>opaqueToken</code> - this is a return value. The opaqueToken is only
meaningful to the node that issues it. The opaqueToken is defined as
xsd:base64Binary to allow for a RECOMMENDED encryption of the token under
the relinquishing custody node’s own encryption key.</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></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> - <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="#_Ref8979716
">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_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.&nbsp; The key and element
or attribute that caused the problem SHOULD be clearly indicated in the
error text.</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_tokenAlreadyExists</b>: signifies that one or more of
the businessKey or tModelKey elements that identify entities to be
transferred are associated with a transferToken that is still valid and
has not been discarded, used or expired.&nbsp; The error text SHOULD
clearly indicate which entity keys caused the error.</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_userMismatch</b>: signifies that one or more of the
businessKey or tModelKey elements that identify entities to be
transferred are not owned by the publisher identified by the
<i>authInfo</i> element.&nbsp; The error text SHOULD clearly indicate
which entity keys caused the error</p></dd>
</dl>
</li>
</ul>
<a name="transferEntities-org.uddi.custody_v3.TransferEntities-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>transferEntities</h4>
<pre>void&nbsp;transferEntities(<a href="../../../org/uddi/custody_v3/TransferEntities.html" title="class in org.uddi.custody_v3">TransferEntities</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 transfer_entities API is used by publishers to whom custody is being
transferred to actually perform the transfer. The recipient publisher
must have an unexpired transferToken that was issued by the custodial
node for the entities being transferred.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>body</code> - authInfo: This OPTIONAL argument is an element that contains
an authentication token. Authentication tokens are obtained using the
get_authToken API call or through some other means external to this
specification, and represent the identity of the publisher at a UDDI
node, in this case, the new owner of the entities being transferred.
· transferToken: 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. The transferToken represents
permission to transfer the entities that have been identified via a prior
call to the get_transferToken API.
· keyBag: One or more uddiKeys associated with businessEntity or tModel
entities that are to be transferred to this publisher 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.
<br>
<p class="MsoBodyText">The target node responds to this API by
performing the transfer operation.&nbsp; This operation is comprised of
four steps:</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>Verification that the entity keys are valid.</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>Verification that ownership of the entities by the
recipient publisher is allowed and would not violate any policies at the
target node related to publisher limits.</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>Verification with the custodial node that the transfer of
the designated entities is allowed.&nbsp; This is accomplished by
invoking transfer_custody on the custodial node that is identified by the
nodeID element in the transferToken.&nbsp; Any errors returned by the
custodial node cause this API to fail and are propagated to the
caller.</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>Changing custody and ownership of the designated entities
and entering these changes into the replication stream.</p>
<p class="MsoBodyText">Upon successful completion, an empty message is
returned indicating the success of the transfer operation. In the case of
an inter-node custody transfer, while the transfer is in process, the
entities being transferred are not available for modification. To
determine the state of the data, UDDI clients can use the
get_operationalInfo API to determine when custody and ownership transfer
has taken place. A change in the nodeID of the operationalInfo provides
such an indication.</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="#_Ref8979732 ">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_accountLimitExceeded</b>: signifies that the target
node has determined that the transfer of custody of the identified
entities would result in the target publisher exceeding policy limits for
the number of owned entities.&nbsp; The error text SHOULD clearly
indicate which entities cause the publishers limits to be exceeded. It is
possible for a publisher to come into possession of more data than the
target node’s policy allows. The condition and node behavior under these
circumstances are described in Section <a href="#_Ref11680087
">5.4.3</a><i>Transfer Execution.</i></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_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.&nbsp; The key and element
or attribute that caused the problem SHOULD be clearly indicated in the
error text.</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 target node or the
custodial node.&nbsp; Reasons for rejection include expiration of the
transferToken, use of an invalid 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.</p>
<span
style="font-size:10.0pt;font-family:Arial;letter-spacing:-.25pt"></span></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/UDDICustodyTransferPortType.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/DispositionReportFaultMessage.html" title="class in org.uddi.v3_service"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../org/uddi/v3_service/UDDIInquiryPortType.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/UDDICustodyTransferPortType.html" target="_top">Frames</a></li>
<li><a href="UDDICustodyTransferPortType.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>