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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
|
<?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_find_binding">
<refmeta>
<refentrytitle>uddi_find_binding</refentrytitle>
<refmiscinfo>uddi</refmiscinfo>
</refmeta>
<refnamediv>
<refname>uddi_find_binding</refname>
<refpurpose>Retrieves matching bindings</refpurpose>
</refnamediv>
<refsect1 id="syntax_uddi_find_binding"><title>Syntax</title>
<screen>
<uddi_find_binding
serviceKey="uuid_key"
generic="1.0"
[ maxRows="nn" ]
xmlns="urn:uddi-org:api" >
[<findQualifiers/>]
<tModelBag/>
</uddi_find_binding>
</screen></refsect1>
<refsect1 id="desc_uddi_find_binding"><title>Description</title>
<para>
The <parameter>uddi_find_binding</parameter> message returns a <parameter>bindingDetail</parameter> message that contains a
<parameter>bindingTemplates</parameter> structure with zero or more <parameter>bindingTemplate</parameter> structures
matching the criteria specified in the argument list.
</para></refsect1>
<refsect1 id="params_uddi_find_binding"><title>Attributes & Children</title>
<refsect2><title>maxRows</title><para>This optional integer value allows
the requesting program to limit the number of results returned.</para></refsect2>
<refsect2><title>serviceKey</title><para>This <parameter>uuid_key</parameter> is used to specify a
particular instance of a <parameter>businessService</parameter> element in the registered data. Only
bindings in the specific <parameter>businessService</parameter> data identified by the <parameter>serviceKey</parameter>
passed will be searched.</para></refsect2>
<refsect2><title>findQualifiers</title><para>This collection of
<parameter>findQualifier</parameter> elements can be used to alter the default behavior of search
functionality.</para></refsect2>
<refsect2><title>tModelBag</title><para>This is a list of <parameter>tModel uuid_key</parameter>
values that represent the technical fingerprint the server should locate in a <parameter>bindingTemplate</parameter>
structure contained within the <parameter>businessService</parameter> instance specified by the
<parameter>serviceKey</parameter> value. If more than one <parameter>tModel</parameter> key is specified in this structure,
only <parameter>bindingTemplate</parameter> information that exactly matches all of the <parameter>tModel</parameter>
keys specified will be returned (logical AND). The order of the keys in the
<parameter>tModel</parameter> bag is not relevant. All <parameter>tModelKey</parameter> values begin with a uuid URN
qualifier (e.g. "uuid:" followed by a known <parameter>tModel</parameter> uuid value.</para></refsect2>
</refsect1>
<refsect1 id="ret_uddi_find_binding"><title>Return Types</title>
<para>
This function returns a <parameter>bindingDetail</parameter> message on success. In the event
that no matches were located for the specified criteria, the <parameter>bindingDetail</parameter>
structure returned in the response will be empty; that is, it will contain no
<parameter>bindingTemplate</parameter> data.
</para>
<para>
In the event of a large number of matches, a UDDI-enabled server may
truncate the result set. If this occurs, the response message will
contain the <parameter>truncated</parameter> attribute with the value of this attribute set
to true.
</para>
<para>
Searching using <parameter>tModelBag</parameter> will also return any <parameter>bindingTemplate</parameter> information
that matches due to <parameter>hostingRedirector</parameter> references. The resolved <parameter>bindingTemplate</parameter>
structure will be returned, even if that <parameter>bindingTemplate</parameter> is owned by a
different <parameter>businessService</parameter> structure.
</para>
</refsect1>
<refsect1 id="errors_uddi_find_binding"><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_find_binding</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 the <parameter>uuid</parameter>_key value passed did not match with any known
<parameter>serviceKey</parameter> or <parameter>tModel</parameter> key values. The error structure will signal which condition occurred first.</entry>
</row>
<row>
<entry><errorcode>E_tooManyOptions</errorcode></entry>
<entry>signifies that more than one mutually exclusive argument was passed.</entry>
</row>
<row>
<entry><errorcode>E_unsupported</errorcode></entry>
<entry>signifies that one of the <parameter>findQualifier</parameter> values passed was invalid.</entry>
</row>
</tbody>
</tgroup>
</table>
</refsect1>
</refentry>
|
