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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
<?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_get_bindingDetail">
<refmeta>
<refentrytitle>uddi_get_bindingDetail</refentrytitle>
<refmiscinfo>uddi</refmiscinfo>
</refmeta>
<refnamediv>
<refname>uddi_get_bindingDetail</refname>
<refpurpose>Request run-time <parameter>bindingTemplate</parameter> location information.</refpurpose>
</refnamediv>
<refsect1 id="syntax_uddi_get_bindingDetail"><title>Syntax</title>
<screen>
<uddi_get_bindingDetail
generic="1.0"
xmlns="urn:uddi-org:api" >
<bindingKey/>
[ <bindingKey/> ...]
</uddi_get_bindingDetail>
</screen></refsect1>
<refsect1 id="desc_uddi_get_bindingDetail"><title>Description</title>
<para>
The <parameter>uddi_get_bindingDetail</parameter> message requests the
run-time <parameter>bindingTemplate</parameter> information for the
purpose of invoking a registered business API.
</para>
</refsect1>
<refsect1 id="params_uddi_get_bindingDetail"><title>Attributes & Children</title>
<refsect2><title>bindingKey</title><para>One or more <parameter>uuid</parameter>_key values
that represent specific instances of known <parameter>bindingTemplate</parameter> data.</para></refsect2>
<refsect2><title>Behavior</title><para>In general, it is recommended that
<parameter>bindingTemplate</parameter> information be cached locally by applications so that repeated
calls to a service described by a <parameter>bindingTemplate</parameter> can be made without having
to make repeated round trips to a registry. In the event that a call made
with cached data fails, the <parameter>uddi</parameter>_get_bindingDetail message can be used to get
fresh <parameter>bindingTemplate</parameter> data. This is useful in
cases such as when a service you
are using relocates to another server or is restored at a disaster
recovery site.</para></refsect2>
</refsect1>
<refsect1 id="ret_uddi_get_bindingDetail"><title>Return Types</title>
<para>
This function returns a <parameter>bindingDetail</parameter> message on successful match of
one or more <parameter>bindingKey</parameter> values. If multiple <parameter>bindingKey</parameter> values were passed,
the results will be returned in the same order as the keys passed.
</para>
<para>
In the event of a large number of matches, a server may truncate
the result set. If this occurs, the <parameter>bindingDetail</parameter> result will contain the
<parameter>truncated</parameter> attribute with the value of this attribute set to true.
</para>
</refsect1>
<refsect1 id="errors_uddi_get_bindingDetail"><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 uddi_get_bindingDetail</title>
<tgroup cols="2">
<thead><row><entry>Error Code</entry><entry>Description</entry></row></thead>
<tbody>
<row>
<entry><errorcode>E_invalidKeyPassed</errorcode></entry>
<entry>signifies that one of the <parameter>uuid_key</parameter> values passed did not match with
any known <parameter>bindingKey</parameter> key values. No partial results will be returned;
if any <parameter>bindingKey</parameter> values passed are not valid <parameter>bindingKey</parameter> values,
this error will be returned.</entry>
</row>
</tbody>
</tgroup>
</table>
</refsect1>
</refentry>
|
