1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
-
- This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
- project.
-
- Copyright (C) 1998-2018 OpenLink Software
-
- This project is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by the
- Free Software Foundation; only version 2 of the License, dated June 1991.
-
- This program is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU General Public License along
- with this program; if not, write to the Free Software Foundation, Inc.,
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
-
-->
<refentry id="me_uddi_discard_authToken">
<refmeta>
<refentrytitle>uddi_discard_authToken</refentrytitle>
<refmiscinfo>uddi</refmiscinfo>
</refmeta>
<refnamediv>
<refname>uddi_discard_authToken</refname>
<refpurpose>Inform a UDDI server that the authentication token can be discarded.</refpurpose>
</refnamediv>
<refsect1 id="syntax_uddi_discard_authToken"><title>Syntax</title>
<screen>
<uddi_discard_authToken
generic="1.0"
xmlns="urn:uddi-org:api" >
<authInfo/>
</uddi_discard_authToken>
</screen></refsect1>
<refsect1 id="desc_uddi_discard_authToken"><title>Description</title>
<para>
The <parameter>uddi_discard_authToken</parameter> message is used to tell a UDDI-enabled server
that the authentication token can be discarded. Subsequent calls that
use the same <parameter>authToken</parameter> may be rejected. This message is optional for
UDDI-enabled servers that do not manage session state or that do not
support the <parameter>get_authToken</parameter> message.
</para></refsect1>
<refsect1 id="params_uddi_discard_authToken"><title>Attributes & Children</title>
<refsect2><title>authInfo</title><para>This required argument is an
element that contains an authentication token. Authentication tokens are
obtained using the <parameter>get_authToken</parameter> message.</para></refsect2>
</refsect1>
<refsect1 id="ret_uddi_discard_authToken"><title>Return Types</title>
<para>
Upon successful completion, the server returns a <parameter>dispositionReport</parameter> is returned with a
single success indicator. Discarding an expired <parameter>authToken</parameter> will be
reported as a success condition.
</para>
</refsect1>
<refsect1 id="errors_uddi_discard_authToken"><title>Errors</title>
<para>
If an error occurs in processing this message, a <parameter>dispositionReport</parameter>
structure will be returned to the caller in a SOAP Fault. The following
error information will be relevant:
</para>
<table><title>Errors signalled by get_authToken</title>
<tgroup cols="2">
<thead><row><entry>Error Code</entry><entry>Description</entry></row></thead>
<tbody>
<row>
<entry><errorcode>E_authTokenRequired</errorcode></entry>
<entry>signifies that the authentication token value passed in
the <parameter>authInfo</parameter> argument is either missing or is not valid.</entry>
</row>
</tbody>
</tgroup>
</table>
</refsect1>
</refentry>
|