| <!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 Tue Aug 18 22:21:57 EDT 2020 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>UDDICustodyTransferService (jUDDI_v3 Parent 3.3.9 API)</title> |
| <meta name="date" content="2020-08-18"> |
| <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="UDDICustodyTransferService (jUDDI_v3 Parent 3.3.9 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/UDDICustodyTransferService.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/rmi/RMIRegistration.html" title="class in org.apache.juddi.rmi"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/juddi/rmi/UDDIInquiryService.html" title="class in org.apache.juddi.rmi"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/juddi/rmi/UDDICustodyTransferService.html" target="_top">Frames</a></li> |
| <li><a href="UDDICustodyTransferService.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li><a href="#fields.inherited.from.class.java.rmi.server.RemoteObject">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.rmi</div> |
| <h2 title="Class UDDICustodyTransferService" class="title">Class UDDICustodyTransferService</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/7/docs/api/java/rmi/server/RemoteObject.html?is-external=true" title="class or interface in java.rmi.server">java.rmi.server.RemoteObject</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/7/docs/api/java/rmi/server/RemoteServer.html?is-external=true" title="class or interface in java.rmi.server">java.rmi.server.RemoteServer</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/7/docs/api/java/rmi/server/UnicastRemoteObject.html?is-external=true" title="class or interface in java.rmi.server">java.rmi.server.UnicastRemoteObject</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.juddi.rmi.UDDICustodyTransferService</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/rmi/Remote.html?is-external=true" title="class or interface in java.rmi">Remote</a>, <a href="../../../../org/uddi/v3_service/UDDICustodyTransferPortType.html" title="interface in org.uddi.v3_service">UDDICustodyTransferPortType</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">UDDICustodyTransferService</span> |
| extends <a href="https://docs.oracle.com/javase/7/docs/api/java/rmi/server/UnicastRemoteObject.html?is-external=true" title="class or interface in java.rmi.server">UnicastRemoteObject</a> |
| implements <a href="../../../../org/uddi/v3_service/UDDICustodyTransferPortType.html" title="interface in org.uddi.v3_service">UDDICustodyTransferPortType</a></pre> |
| <div class="block">UDDISecurityPortType wrapper so it can be exposed as a service over RMI.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd><a href="mailto:kstam@apache.org">Kurt T Stam</a></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../serialized-form.html#org.apache.juddi.rmi.UDDICustodyTransferService">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.java.rmi.server.RemoteObject"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class java.rmi.server.<a href="https://docs.oracle.com/javase/7/docs/api/java/rmi/server/RemoteObject.html?is-external=true" title="class or interface in java.rmi.server">RemoteObject</a></h3> |
| <code><a href="https://docs.oracle.com/javase/7/docs/api/java/rmi/server/RemoteObject.html?is-external=true#ref" title="class or interface in java.rmi.server">ref</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier</th> |
| <th class="colLast" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juddi/rmi/UDDICustodyTransferService.html#UDDICustodyTransferService-int-">UDDICustodyTransferService</a></span>(int port)</code> </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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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/apache/juddi/rmi/UDDICustodyTransferService.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> 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/apache/juddi/rmi/UDDICustodyTransferService.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/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> authInfo, |
| <a href="../../../../org/uddi/custody_v3/KeyBag.html" title="class in org.uddi.custody_v3">KeyBag</a> keyBag, |
| <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/Holder.html?is-external=true" title="class or interface in javax.xml.ws">Holder</a><<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> nodeID, |
| <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/Holder.html?is-external=true" title="class or interface in javax.xml.ws">Holder</a><<a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/datatype/XMLGregorianCalendar.html?is-external=true" title="class or interface in javax.xml.datatype">XMLGregorianCalendar</a>> expirationTime, |
| <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/Holder.html?is-external=true" title="class or interface in javax.xml.ws">Holder</a><byte[]> 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/apache/juddi/rmi/UDDICustodyTransferService.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> 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> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.rmi.server.UnicastRemoteObject"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.rmi.server.<a href="https://docs.oracle.com/javase/7/docs/api/java/rmi/server/UnicastRemoteObject.html?is-external=true" title="class or interface in java.rmi.server">UnicastRemoteObject</a></h3> |
| <code><a href="https://docs.oracle.com/javase/7/docs/api/java/rmi/server/UnicastRemoteObject.html?is-external=true#clone--" title="class or interface in java.rmi.server">clone</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/rmi/server/UnicastRemoteObject.html?is-external=true#exportObject-java.rmi.Remote-" title="class or interface in java.rmi.server">exportObject</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/rmi/server/UnicastRemoteObject.html?is-external=true#exportObject-java.rmi.Remote-int-" title="class or interface in java.rmi.server">exportObject</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/rmi/server/UnicastRemoteObject.html?is-external=true#exportObject-java.rmi.Remote-int-java.rmi.server.RMIClientSocketFactory-java.rmi.server.RMIServerSocketFactory-" title="class or interface in java.rmi.server">exportObject</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/rmi/server/UnicastRemoteObject.html?is-external=true#unexportObject-java.rmi.Remote-boolean-" title="class or interface in java.rmi.server">unexportObject</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.rmi.server.RemoteServer"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.rmi.server.<a href="https://docs.oracle.com/javase/7/docs/api/java/rmi/server/RemoteServer.html?is-external=true" title="class or interface in java.rmi.server">RemoteServer</a></h3> |
| <code><a href="https://docs.oracle.com/javase/7/docs/api/java/rmi/server/RemoteServer.html?is-external=true#getClientHost--" title="class or interface in java.rmi.server">getClientHost</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/rmi/server/RemoteServer.html?is-external=true#getLog--" title="class or interface in java.rmi.server">getLog</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/rmi/server/RemoteServer.html?is-external=true#setLog-java.io.OutputStream-" title="class or interface in java.rmi.server">setLog</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.rmi.server.RemoteObject"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.rmi.server.<a href="https://docs.oracle.com/javase/7/docs/api/java/rmi/server/RemoteObject.html?is-external=true" title="class or interface in java.rmi.server">RemoteObject</a></h3> |
| <code><a href="https://docs.oracle.com/javase/7/docs/api/java/rmi/server/RemoteObject.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.rmi.server">equals</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/rmi/server/RemoteObject.html?is-external=true#getRef--" title="class or interface in java.rmi.server">getRef</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/rmi/server/RemoteObject.html?is-external=true#hashCode--" title="class or interface in java.rmi.server">hashCode</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/rmi/server/RemoteObject.html?is-external=true#toString--" title="class or interface in java.rmi.server">toString</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/rmi/server/RemoteObject.html?is-external=true#toStub-java.rmi.Remote-" title="class or interface in java.rmi.server">toStub</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="UDDICustodyTransferService-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>UDDICustodyTransferService</h4> |
| <pre>protected UDDICustodyTransferService(int port) |
| throws <a href="https://docs.oracle.com/javase/7/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/7/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> |
| <!-- ============ 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>public void discardTransferToken(<a href="../../../../org/uddi/custody_v3/DiscardTransferToken.html" title="class in org.uddi.custody_v3">DiscardTransferToken</a> 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/7/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: <code><a href="../../../../org/uddi/v3_service/UDDICustodyTransferPortType.html#discardTransferToken-org.uddi.custody_v3.DiscardTransferToken-">UDDICustodyTransferPortType</a></code></span></div> |
| <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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/uddi/v3_service/UDDICustodyTransferPortType.html#discardTransferToken-org.uddi.custody_v3.DiscardTransferToken-">discardTransferToken</a></code> in interface <code><a href="../../../../org/uddi/v3_service/UDDICustodyTransferPortType.html" title="interface in org.uddi.v3_service">UDDICustodyTransferPortType</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 "Times New |
| Roman""> |
| </span></span><b><i>authInfo</i></b>: 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.</p> |
| |
| <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span |
| style="font-family:Symbol">·<span style="font:7.0pt "Times New |
| Roman""> |
| </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 "Times New |
| Roman""> |
| </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. 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/7/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. </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: "Times New |
| Roman""> |
| </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.</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>public void getTransferToken(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> authInfo, |
| <a href="../../../../org/uddi/custody_v3/KeyBag.html" title="class in org.uddi.custody_v3">KeyBag</a> keyBag, |
| <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/Holder.html?is-external=true" title="class or interface in javax.xml.ws">Holder</a><<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> nodeID, |
| <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/Holder.html?is-external=true" title="class or interface in javax.xml.ws">Holder</a><<a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/datatype/XMLGregorianCalendar.html?is-external=true" title="class or interface in javax.xml.datatype">XMLGregorianCalendar</a>> expirationTime, |
| <a href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/Holder.html?is-external=true" title="class or interface in javax.xml.ws">Holder</a><byte[]> 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/7/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: <code><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-">UDDICustodyTransferPortType</a></code></span></div> |
| <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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><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></code> in interface <code><a href="../../../../org/uddi/v3_service/UDDICustodyTransferPortType.html" title="interface in org.uddi.v3_service">UDDICustodyTransferPortType</a></code></dd> |
| <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/7/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. </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 "Times New |
| Roman""> |
| </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.</p> |
| |
| <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span |
| style="font-family:Symbol">·<span style="font:7.0pt "Times New |
| Roman""> |
| </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. 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 "Times New |
| Roman""> |
| </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. 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>public void transferEntities(<a href="../../../../org/uddi/custody_v3/TransferEntities.html" title="class in org.uddi.custody_v3">TransferEntities</a> 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/7/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: <code><a href="../../../../org/uddi/v3_service/UDDICustodyTransferPortType.html#transferEntities-org.uddi.custody_v3.TransferEntities-">UDDICustodyTransferPortType</a></code></span></div> |
| <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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/uddi/v3_service/UDDICustodyTransferPortType.html#transferEntities-org.uddi.custody_v3.TransferEntities-">transferEntities</a></code> in interface <code><a href="../../../../org/uddi/v3_service/UDDICustodyTransferPortType.html" title="interface in org.uddi.v3_service">UDDICustodyTransferPortType</a></code></dd> |
| <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. 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 "Times New |
| Roman""> |
| </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 "Times New |
| Roman""> |
| </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 "Times New |
| Roman""> |
| </span></span>Verification with the custodial node that the transfer of |
| the designated entities is allowed. This is accomplished by |
| invoking transfer_custody on the custodial node that is identified by the |
| nodeID element in the transferToken. 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 "Times New |
| Roman""> |
| </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><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/7/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/UDDICustodyTransferService.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/rmi/RMIRegistration.html" title="class in org.apache.juddi.rmi"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/juddi/rmi/UDDIInquiryService.html" title="class in org.apache.juddi.rmi"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/juddi/rmi/UDDICustodyTransferService.html" target="_top">Frames</a></li> |
| <li><a href="UDDICustodyTransferService.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li><a href="#fields.inherited.from.class.java.rmi.server.RemoteObject">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 © 2004–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |