http://git-wip-us.apache.org/repos/asf/juddi/blob/8ef46321/apidocs/org/apache/juddi/api/impl/UDDIReplicationImpl.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/juddi/api/impl/UDDIReplicationImpl.html b/apidocs/org/apache/juddi/api/impl/UDDIReplicationImpl.html new file mode 100644 index 0000000..a6dc825 --- /dev/null +++ b/apidocs/org/apache/juddi/api/impl/UDDIReplicationImpl.html @@ -0,0 +1,499 @@ +<!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 Wed Feb 28 07:01:13 EST 2018 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>UDDIReplicationImpl (jUDDI_v3 Parent 3.3.6-SNAPSHOT API)</title> +<meta name="date" content="2018-02-28"> +<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="UDDIReplicationImpl (jUDDI_v3 Parent 3.3.6-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":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/UDDIReplicationImpl.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/juddi/api/impl/UDDIPublicationImpl.html" title="class in org.apache.juddi.api.impl"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/juddi/api/impl/UDDISecurityImpl.html" title="class in org.apache.juddi.api.impl"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/juddi/api/impl/UDDIReplicationImpl.html" target="_top">Frames</a></li> +<li><a href="UDDIReplicationImpl.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.org.apache.juddi.api.impl.AuthenticatedService">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.api.impl</div> +<h2 title="Class UDDIReplicationImpl" class="title">Class UDDIReplicationImpl</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://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="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html" title="class in org.apache.juddi.api.impl">org.apache.juddi.api.impl.AuthenticatedService</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.juddi.api.impl.UDDIReplicationImpl</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://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/UDDIReplicationPortType.html" title="interface in org.uddi.v3_service">UDDIReplicationPortType</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">UDDIReplicationImpl</span> +extends <a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html" title="class in org.apache.juddi.api.impl">AuthenticatedService</a> +implements <a href="../../../../../org/uddi/v3_service/UDDIReplicationPortType.html" title="interface in org.uddi.v3_service">UDDIReplicationPortType</a></pre> +<div class="block">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. + <ul> + <li>get_changeRecords</li> + <li>notify_changeRecordsAvailable</li> + <li>do_ping</li> + <li>get_highWaterMarks</li></ul></div> +<dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd><a href="mailto:[email protected]";>Alex O'Ree</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.org.apache.juddi.api.impl.AuthenticatedService"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.juddi.api.impl.<a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html" title="class in org.apache.juddi.api.impl">AuthenticatedService</a></h3> +<code><a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html#AUTHTOKEN_ACTIVE">AUTHTOKEN_ACTIVE</a>, <a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html#AUTHTOKEN_RETIRED">AUTHTOKEN_RETIRED</a>, <a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html#baseUrl">baseUrl</a>, <a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html#baseUrlSSL">baseUrlSSL</a>, <a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html#ctx">ctx</a>, <a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html#df">df</a>, <a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html#UTF8">UTF8</a></code></li> +</ul> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/juddi/api/impl/UDDIReplicationImpl.html#UDDIReplicationImpl--">UDDIReplicationImpl</a></span>()</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><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juddi/api/impl/UDDIReplicationImpl.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> 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/apache/juddi/api/impl/UDDIReplicationImpl.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> 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="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../org/uddi/repl_v3/ChangeRecordIDType.html" title="class in org.uddi.repl_v3">ChangeRecordIDType</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juddi/api/impl/UDDIReplicationImpl.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/apache/juddi/api/impl/UDDIReplicationImpl.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> body)</code> +<div class="block">this means that another node has a change and we need to pick up the + change and apply it to our local database.</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/apache/juddi/api/impl/UDDIReplicationImpl.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> body)</code> +<div class="block">transfers custody of an entity from node1/user1 to node2/user2 + + assume this node is node 2.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.juddi.api.impl.AuthenticatedService"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.juddi.api.impl.<a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html" title="class in org.apache.juddi.api.impl">AuthenticatedService</a></h3> +<code><a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html#getEntityPublisher-javax.persistence.EntityManager-java.lang.String-">getEntityPublisher</a>, <a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html#getNode--">getNode</a>, <a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html#getRequestorsIPAddress--">getRequestorsIPAddress</a></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="http://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="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://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="http://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="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://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="http://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="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a>, <a href="http://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="http://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="http://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="UDDIReplicationImpl--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>UDDIReplicationImpl</h4> +<pre>public UDDIReplicationImpl()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="doPing-org.uddi.repl_v3.DoPing-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>doPing</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> doPing(<a href="../../../../../org/uddi/repl_v3/DoPing.html" title="class in org.uddi.repl_v3">DoPing</a> body) + throws <a href="../../../../../org/uddi/v3_service/DispositionReportFaultMessage.html" title="class in org.uddi.v3_service">DispositionReportFaultMessage</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/uddi/v3_service/UDDIReplicationPortType.html#doPing-org.uddi.repl_v3.DoPing-">UDDIReplicationPortType</a></code></span></div> +<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="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/uddi/v3_service/UDDIReplicationPortType.html#doPing-org.uddi.repl_v3.DoPing-">doPing</a></code> in interface <code><a href="../../../../../org/uddi/v3_service/UDDIReplicationPortType.html" title="interface in org.uddi.v3_service">UDDIReplicationPortType</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>body</code> - </dd> +<dt><span class="returnLabel">Returns:</span></dt> +<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> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>3.3</dd> +</dl> +</li> +</ul> +<a name="getChangeRecords-org.uddi.repl_v3.GetChangeRecords-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getChangeRecords</h4> +<pre>public <a href="../../../../../org/uddi/repl_v3/ChangeRecords.html" title="class in org.uddi.repl_v3">ChangeRecords</a> getChangeRecords(<a href="../../../../../org/uddi/repl_v3/GetChangeRecords.html" title="class in org.uddi.repl_v3">GetChangeRecords</a> body) + throws <a href="../../../../../org/uddi/v3_service/DispositionReportFaultMessage.html" title="class in org.uddi.v3_service">DispositionReportFaultMessage</a>, + <a href="http://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/UDDIReplicationPortType.html#getChangeRecords-org.uddi.repl_v3.GetChangeRecords-">UDDIReplicationPortType</a></code></span></div> +<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. 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. 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="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/uddi/v3_service/UDDIReplicationPortType.html#getChangeRecords-org.uddi.repl_v3.GetChangeRecords-">getChangeRecords</a></code> in interface <code><a href="../../../../../org/uddi/v3_service/UDDIReplicationPortType.html" title="interface in org.uddi.v3_service">UDDIReplicationPortType</a></code></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><a href="../../../../../org/uddi/v3_service/DispositionReportFaultMessage.html" title="class in org.uddi.v3_service">DispositionReportFaultMessage</a></code></dd> +<dd><code><a href="http://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> +<a name="getHighWaterMarks--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getHighWaterMarks</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../org/uddi/repl_v3/ChangeRecordIDType.html" title="class in org.uddi.repl_v3">ChangeRecordIDType</a>> getHighWaterMarks() + throws <a href="../../../../../org/uddi/v3_service/DispositionReportFaultMessage.html" title="class in org.uddi.v3_service">DispositionReportFaultMessage</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. If there is no graph, we just return the + local bits</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/uddi/v3_service/UDDIReplicationPortType.html#getHighWaterMarks--">getHighWaterMarks</a></code> in interface <code><a href="../../../../../org/uddi/v3_service/UDDIReplicationPortType.html" title="interface in org.uddi.v3_service">UDDIReplicationPortType</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<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> +</dl> +</li> +</ul> +<a name="notifyChangeRecordsAvailable-org.uddi.repl_v3.NotifyChangeRecordsAvailable-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>notifyChangeRecordsAvailable</h4> +<pre>public void notifyChangeRecordsAvailable(<a href="../../../../../org/uddi/repl_v3/NotifyChangeRecordsAvailable.html" title="class in org.uddi.repl_v3">NotifyChangeRecordsAvailable</a> body) + throws <a href="../../../../../org/uddi/v3_service/DispositionReportFaultMessage.html" title="class in org.uddi.v3_service">DispositionReportFaultMessage</a></pre> +<div class="block">this means that another node has a change and we need to pick up the + change and apply it to our local database.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/uddi/v3_service/UDDIReplicationPortType.html#notifyChangeRecordsAvailable-org.uddi.repl_v3.NotifyChangeRecordsAvailable-">notifyChangeRecordsAvailable</a></code> in interface <code><a href="../../../../../org/uddi/v3_service/UDDIReplicationPortType.html" title="interface in org.uddi.v3_service">UDDIReplicationPortType</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>body</code> - </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> +</dl> +</li> +</ul> +<a name="transferCustody-org.uddi.repl_v3.TransferCustody-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>transferCustody</h4> +<pre>public void transferCustody(<a href="../../../../../org/uddi/repl_v3/TransferCustody.html" title="class in org.uddi.repl_v3">TransferCustody</a> body) + throws <a href="../../../../../org/uddi/v3_service/DispositionReportFaultMessage.html" title="class in org.uddi.v3_service">DispositionReportFaultMessage</a></pre> +<div class="block">transfers custody of an entity from node1/user1 to node2/user2 + + assume this node is node 2. + + user1 on node1 requests a transfer token. node 1 issues the token. + + user1 now has a transfer token for their stuff user now takes the + token to node 2 and calls transferEntities + <img src="http://www.uddi.org/pubs/uddi-v3.0.2-20041019_files/image086.gif";></div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/uddi/v3_service/UDDIReplicationPortType.html#transferCustody-org.uddi.repl_v3.TransferCustody-">transferCustody</a></code> in interface <code><a href="../../../../../org/uddi/v3_service/UDDIReplicationPortType.html" title="interface in org.uddi.v3_service">UDDIReplicationPortType</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>body</code> - </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> +</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/UDDIReplicationImpl.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/juddi/api/impl/UDDIPublicationImpl.html" title="class in org.apache.juddi.api.impl"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/juddi/api/impl/UDDISecurityImpl.html" title="class in org.apache.juddi.api.impl"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/juddi/api/impl/UDDIReplicationImpl.html" target="_top">Frames</a></li> +<li><a href="UDDIReplicationImpl.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.org.apache.juddi.api.impl.AuthenticatedService">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–2018 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/juddi/blob/8ef46321/apidocs/org/apache/juddi/api/impl/UDDISecurityImpl.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/juddi/api/impl/UDDISecurityImpl.html b/apidocs/org/apache/juddi/api/impl/UDDISecurityImpl.html new file mode 100644 index 0000000..d02f5bf --- /dev/null +++ b/apidocs/org/apache/juddi/api/impl/UDDISecurityImpl.html @@ -0,0 +1,478 @@ +<!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 Wed Feb 28 07:01:13 EST 2018 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>UDDISecurityImpl (jUDDI_v3 Parent 3.3.6-SNAPSHOT API)</title> +<meta name="date" content="2018-02-28"> +<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="UDDISecurityImpl (jUDDI_v3 Parent 3.3.6-SNAPSHOT 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/UDDISecurityImpl.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/juddi/api/impl/UDDIReplicationImpl.html" title="class in org.apache.juddi.api.impl"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/juddi/api/impl/UDDIServiceCounter.html" title="class in org.apache.juddi.api.impl"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/juddi/api/impl/UDDISecurityImpl.html" target="_top">Frames</a></li> +<li><a href="UDDISecurityImpl.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="#field.summary">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><a href="#field.detail">Field</a> | </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.api.impl</div> +<h2 title="Class UDDISecurityImpl" class="title">Class UDDISecurityImpl</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://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="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html" title="class in org.apache.juddi.api.impl">org.apache.juddi.api.impl.AuthenticatedService</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.juddi.api.impl.UDDISecurityImpl</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://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/UDDISecurityPortType.html" title="interface in org.uddi.v3_service">UDDISecurityPortType</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">UDDISecurityImpl</span> +extends <a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html" title="class in org.apache.juddi.api.impl">AuthenticatedService</a> +implements <a href="../../../../../org/uddi/v3_service/UDDISecurityPortType.html" title="interface in org.uddi.v3_service">UDDISecurityPortType</a></pre> +<div class="block">This class implements the UDDI Security Service and basically handles all authentication requests + for jUDDI. These authentication requests are routed to the appropriately configured + authenticator for validation, then persisted in the database until they either + expire or are discarded.</div> +<dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd><a href="mailto:[email protected]";>Jeff Faath</a> (and many others)</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> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juddi/api/impl/UDDISecurityImpl.html#AUTH_TOKEN_PREFIX">AUTH_TOKEN_PREFIX</a></span></code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.juddi.api.impl.AuthenticatedService"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.juddi.api.impl.<a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html" title="class in org.apache.juddi.api.impl">AuthenticatedService</a></h3> +<code><a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html#AUTHTOKEN_ACTIVE">AUTHTOKEN_ACTIVE</a>, <a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html#AUTHTOKEN_RETIRED">AUTHTOKEN_RETIRED</a>, <a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html#baseUrl">baseUrl</a>, <a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html#baseUrlSSL">baseUrlSSL</a>, <a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html#ctx">ctx</a>, <a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html#df">df</a>, <a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html#UTF8">UTF8</a></code></li> +</ul> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </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> </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juddi/api/impl/UDDISecurityImpl.html#UDDISecurityImpl--">UDDISecurityImpl</a></span>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juddi/api/impl/UDDISecurityImpl.html#UDDISecurityImpl-javax.xml.ws.WebServiceContext-">UDDISecurityImpl</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceContext.html?is-external=true"; title="class or interface in javax.xml.ws">WebServiceContext</a> ctx)</code> +<div class="block">used for unit tests only</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </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/api/impl/UDDISecurityImpl.html#discardAuthToken-org.uddi.api_v3.DiscardAuthToken-">discardAuthToken</a></span>(<a href="../../../../../org/uddi/api_v3/DiscardAuthToken.html" title="class in org.uddi.api_v3">DiscardAuthToken</a> body)</code> +<div class="block">The discard_authToken API call is used to inform a node that the passed + authentication token is to be discarded, effectively ending the session.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/uddi/api_v3/AuthToken.html" title="class in org.uddi.api_v3">AuthToken</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juddi/api/impl/UDDISecurityImpl.html#getAuthToken-org.uddi.api_v3.GetAuthToken-">getAuthToken</a></span>(<a href="../../../../../org/uddi/api_v3/GetAuthToken.html" title="class in org.uddi.api_v3">GetAuthToken</a> body)</code> +<div class="block">The get_authToken API call is used to obtain an authentication token.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/uddi/api_v3/AuthToken.html" title="class in org.uddi.api_v3">AuthToken</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juddi/api/impl/UDDISecurityImpl.html#getAuthToken-java.lang.String-">getAuthToken</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> publisherId)</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.juddi.api.impl.AuthenticatedService"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.juddi.api.impl.<a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html" title="class in org.apache.juddi.api.impl">AuthenticatedService</a></h3> +<code><a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html#getEntityPublisher-javax.persistence.EntityManager-java.lang.String-">getEntityPublisher</a>, <a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html#getNode--">getNode</a>, <a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html#getRequestorsIPAddress--">getRequestorsIPAddress</a></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="http://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="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://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="http://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="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://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="http://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="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a>, <a href="http://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="http://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="http://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"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="AUTH_TOKEN_PREFIX"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AUTH_TOKEN_PREFIX</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> AUTH_TOKEN_PREFIX</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.juddi.api.impl.UDDISecurityImpl.AUTH_TOKEN_PREFIX">Constant Field Values</a></dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="UDDISecurityImpl--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>UDDISecurityImpl</h4> +<pre>public UDDISecurityImpl()</pre> +</li> +</ul> +<a name="UDDISecurityImpl-javax.xml.ws.WebServiceContext-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>UDDISecurityImpl</h4> +<pre>protected UDDISecurityImpl(<a href="http://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceContext.html?is-external=true"; title="class or interface in javax.xml.ws">WebServiceContext</a> ctx)</pre> +<div class="block">used for unit tests only</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>ctx</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="discardAuthToken-org.uddi.api_v3.DiscardAuthToken-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>discardAuthToken</h4> +<pre>public void discardAuthToken(<a href="../../../../../org/uddi/api_v3/DiscardAuthToken.html" title="class in org.uddi.api_v3">DiscardAuthToken</a> body) + throws <a href="../../../../../org/uddi/v3_service/DispositionReportFaultMessage.html" title="class in org.uddi.v3_service">DispositionReportFaultMessage</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/uddi/v3_service/UDDISecurityPortType.html#discardAuthToken-org.uddi.api_v3.DiscardAuthToken-">UDDISecurityPortType</a></code></span></div> +<div class="block">The discard_authToken API call is used to inform a node that the passed + authentication token is to be discarded, effectively ending the session.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/uddi/v3_service/UDDISecurityPortType.html#discardAuthToken-org.uddi.api_v3.DiscardAuthToken-">discardAuthToken</a></code> in interface <code><a href="../../../../../org/uddi/v3_service/UDDISecurityPortType.html" title="interface in org.uddi.v3_service">UDDISecurityPortType</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>body</code> - <span style="font-family:Symbol">·<span style="font:7.0pt + "Times New + Roman""> + </span></span><b><i>authInfo</i></b>: This required argument is an + element that contains an authentication token. Authentication + tokens are obtained using the get_authToken API call. Discarding an + expired authToken is processed and reported as a success condition.</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> - Upon successful completion, an + empty message is returned. See section 4.8 Success and Error Reporting. + If an error occurs in processing this API call, a dispositionReport + structure will be returned to the caller in a SOAP Fault.</dd> +</dl> +</li> +</ul> +<a name="getAuthToken-org.uddi.api_v3.GetAuthToken-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAuthToken</h4> +<pre>public <a href="../../../../../org/uddi/api_v3/AuthToken.html" title="class in org.uddi.api_v3">AuthToken</a> getAuthToken(<a href="../../../../../org/uddi/api_v3/GetAuthToken.html" title="class in org.uddi.api_v3">GetAuthToken</a> body) + throws <a href="../../../../../org/uddi/v3_service/DispositionReportFaultMessage.html" title="class in org.uddi.v3_service">DispositionReportFaultMessage</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/uddi/v3_service/UDDISecurityPortType.html#getAuthToken-org.uddi.api_v3.GetAuthToken-">UDDISecurityPortType</a></code></span></div> +<div class="block">The get_authToken API call is used to obtain an authentication token. An + authToken element MAY be required when using the API calls defined in + Section 5.1 Inquiry API Set, Section 5.2 Publication API Set, Section 5.4 + Custody and Ownership Transfer API Set, and Section 5.5 Subscription API + Set.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/uddi/v3_service/UDDISecurityPortType.html#getAuthToken-org.uddi.api_v3.GetAuthToken-">getAuthToken</a></code> in interface <code><a href="../../../../../org/uddi/v3_service/UDDISecurityPortType.html" title="interface in org.uddi.v3_service">UDDISecurityPortType</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>userID</i></b>: This required attribute argument is + the user identifier that an individual authorized user was assigned by a + UDDI node. Nodes SHOULD provide a means for individuals to obtain a + userID and password credentials that will be valid at the given 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>cred</i></b>: This required attribute argument is the + password or credential that is associated with the user.</p></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>returns org.uddi.api_v3.AuthToken Upon successful completion this + API call returns an authToken structure that contains a valid authInfo + element that can be used in subsequent calls to API calls that require an + authInfo value. + + The authToken message has the form: <img + src="http://uddi.org/pubs/uddi-v3.0.2-20041019_files/image085.gif";> + + The authToken structure contains a single authInfo element that + represents a token that is to be passed back in API calls that require + one. This structure is always returned as a synchronous response to the + get_authToken message.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../org/uddi/v3_service/DispositionReportFaultMessage.html" title="class in org.uddi.v3_service">DispositionReportFaultMessage</a></code> - <p class="MsoBodyText">If an error + occurs in processing this API call, a dispositionReport element will be + returned to the caller within a SOAP Fault. 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_unknownUser</b>: Signifies that the UDDI node that + received the request does not accept the userID and/or cred argument + values passed as valid credentials.</p> + + <p class="MsoBodyText"> </p></dd> +</dl> +</li> +</ul> +<a name="getAuthToken-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getAuthToken</h4> +<pre>public <a href="../../../../../org/uddi/api_v3/AuthToken.html" title="class in org.uddi.api_v3">AuthToken</a> getAuthToken(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> publisherId) + throws <a href="../../../../../org/uddi/v3_service/DispositionReportFaultMessage.html" title="class in org.uddi.v3_service">DispositionReportFaultMessage</a></pre> +<dl> +<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> +</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/UDDISecurityImpl.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/juddi/api/impl/UDDIReplicationImpl.html" title="class in org.apache.juddi.api.impl"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/juddi/api/impl/UDDIServiceCounter.html" title="class in org.apache.juddi.api.impl"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/juddi/api/impl/UDDISecurityImpl.html" target="_top">Frames</a></li> +<li><a href="UDDISecurityImpl.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="#field.summary">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><a href="#field.detail">Field</a> | </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–2018 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
![http://www.uddi.org/pubs/uddi-v3.0.2-20041019_files/image086.gif"](http://www.uddi.org/pubs/uddi-v3.0.2-20041019_files/image086.gif"){kind=link}
![http://uddi.org/pubs/uddi-v3.0.2-20041019_files/image085.gif"](http://uddi.org/pubs/uddi-v3.0.2-20041019_files/image085.gif"){kind=link}