blob: 6cc725244b8b158cf56c8c02faf9be8197a4b434 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_101) on Mon Sep 19 16:59:27 EDT 2022 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>UDDISecurityPortType (jUDDI_v3 Parent 3.3.11-SNAPSHOT API)</title>
<meta name="date" content="2022-09-19">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="UDDISecurityPortType (jUDDI_v3 Parent 3.3.11-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/UDDISecurityPortType.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/uddi/v3_service/UDDIReplicationPortType.html" title="interface in org.uddi.v3_service"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../org/uddi/v3_service/UDDISubscriptionListenerPortType.html" title="interface in org.uddi.v3_service"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/uddi/v3_service/UDDISecurityPortType.html" target="_top">Frames</a></li>
<li><a href="UDDISecurityPortType.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.uddi.v3_service</div>
<h2 title="Interface UDDISecurityPortType" class="title">Interface UDDISecurityPortType</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/6/docs/api/java/rmi/Remote.html?is-external=true" title="class or interface in java.rmi">Remote</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../org/apache/juddi/v3/client/transport/wrapper/Security3to2.html" title="class in org.apache.juddi.v3.client.transport.wrapper">Security3to2</a>, <a href="../../../org/apache/juddi/api/impl/UDDISecurityImpl.html" title="class in org.apache.juddi.api.impl">UDDISecurityImpl</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">UDDISecurityPortType</span>
extends <a href="https://docs.oracle.com/javase/6/docs/api/java/rmi/Remote.html?is-external=true" title="class or interface in java.rmi">Remote</a></pre>
<div class="block">This portType defines all of the UDDI security operations.
This class was generated by the JAX-WS RI. JAX-WS RI 2.1.5-b03- Generated
source version: 2.1
<p class="MsoBodyText">The security API includes the following API calls:</p>
<p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span
style="font-family:Symbol">·<span style="font:7.0pt &quot;Times New
Roman&quot;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</span></span><b>discard_authToken</b>: Used to inform a node that a
previously obtained authentication token is no longer required and should be
considered invalid if used after this message is received.</p>
<p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span
style="font-family:Symbol">·<span style="font:7.0pt &quot;Times New
Roman&quot;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</span></span><b>get_authToken</b>: Used to request an authentication token
in the form of an authInfo element from a UDDI node.&nbsp; An authInfo
element MAY be required when using the API calls defined in Section <a
href="#_Ref8979317 ">5.1</a> <i>Inquiry API Set</i>, Section <a
href="#_Ref8979330 ">5.2</a> <i>Publication API Set</i>, Section <a
href="#_Ref8979371 ">5.4</a> <i>Custody and Ownership Transfer API Set,
</i>and Section <a href="#_Ref8979423 ">5.5</a> <i>Subscription API
Set</i>.</p>
<p class="MsoBodyText">Whether authInfo elements are required on API calls is
determined by node policy as described in Section <a href="#_Ref8979130
">4.8</a> <i>About Access Control and the authInfo Element</i>. In the event
that an authInfo element is not discarded, a node MAY choose to expire the
authentication token so it is no longer valid for authentication in API calls
after a period of time.&nbsp; If an expired token is passed to an API call
other than discard_authToken, the error E_authTokenExpired will be returned
as described in Chapter 12, <i>Error Codes</i>.</p>
<p class="MsoBodyText">A UDDI node typically does not support the Security
API set if it does not support using an authInfo element in any API set. If
the node does support using an authInfo element in any of the API set
provided by the node, it SHOULD support the Security API set.&nbsp; A node
MAY provide an alternative mechanism for obtaining authInfo elements.&nbsp;
</p></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/uddi/v3_service/UDDISecurityPortType.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>&nbsp;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/uddi/v3_service/UDDISecurityPortType.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>&nbsp;body)</code>
<div class="block">The get_authToken API call is used to obtain an authentication token.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="discardAuthToken-org.uddi.api_v3.DiscardAuthToken-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>discardAuthToken</h4>
<pre>void&nbsp;discardAuthToken(<a href="../../../org/uddi/api_v3/DiscardAuthToken.html" title="class in org.uddi.api_v3">DiscardAuthToken</a>&nbsp;body)
throws <a href="../../../org/uddi/v3_service/DispositionReportFaultMessage.html" title="class in org.uddi.v3_service">DispositionReportFaultMessage</a>,
<a href="https://docs.oracle.com/javase/6/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></pre>
<div class="block">The discard_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="paramLabel">Parameters:</span></dt>
<dd><code>body</code> - <span style="font-family:Symbol">·<span style="font:7.0pt
&quot;Times New
Roman&quot;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</span></span><b><i>authInfo</i></b>: This required argument is an
element that contains an authentication token.&nbsp; 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>
<dd><code><a href="https://docs.oracle.com/javase/6/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></code></dd>
</dl>
</li>
</ul>
<a name="getAuthToken-org.uddi.api_v3.GetAuthToken-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getAuthToken</h4>
<pre><a href="../../../org/uddi/api_v3/AuthToken.html" title="class in org.uddi.api_v3">AuthToken</a>&nbsp;getAuthToken(<a href="../../../org/uddi/api_v3/GetAuthToken.html" title="class in org.uddi.api_v3">GetAuthToken</a>&nbsp;body)
throws <a href="../../../org/uddi/v3_service/DispositionReportFaultMessage.html" title="class in org.uddi.v3_service">DispositionReportFaultMessage</a>,
<a href="https://docs.oracle.com/javase/6/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></pre>
<div class="block">The get_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="paramLabel">Parameters:</span></dt>
<dd><code>body</code> - <p class="MsoBodyText"
style="margin-left:1.0in;text-indent:-.25in"><span
style="font-family:Symbol">·<span style="font:7.0pt &quot;Times New
Roman&quot;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</span></span><b><i>userID</i></b>: This required attribute argument is
the user identifier that an individual authorized user was assigned by a
UDDI node.&nbsp; 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 &quot;Times New
Roman&quot;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</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.&nbsp; In addition to the
errors common to all APIs, the following error information is relevant
here:</p>
<p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span
style="font-family:Symbol">·<span style="font:7.0pt &quot;Times New
Roman&quot;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
</span></span><b>E_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">&nbsp;</p></dd>
<dd><code><a href="https://docs.oracle.com/javase/6/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/UDDISecurityPortType.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/uddi/v3_service/UDDIReplicationPortType.html" title="interface in org.uddi.v3_service"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../org/uddi/v3_service/UDDISubscriptionListenerPortType.html" title="interface in org.uddi.v3_service"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/uddi/v3_service/UDDISecurityPortType.html" target="_top">Frames</a></li>
<li><a href="UDDISecurityPortType.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2004&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>