~ubuntu-branches/ubuntu/jaunty/lasso/jaunty

« back to all changes in this revision

Viewing changes to docs/reference/html/LassoFederation.html

  • Committer: Bazaar Package Importer
  • Author(s): Loic Pefferkorn
  • Date: 2005-11-25 19:20:59 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20051125192059-m4894lhpynmkrmwr
Tags: 0.6.3-4ubuntu1
Resynchronise with Debian.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>LassoFederation</title><meta name="generator" content="DocBook XSL Stylesheets V1.68.1"><link rel="start" href="index.html" title="Lasso Reference Manual"><link rel="up" href="architecture.html" title="Lasso Architecture"><link rel="prev" href="LassoSession.html" title="LassoSession"><link rel="next" href="idff.html" title="Identity Federation Framework"><meta name="generator" content="GTK-Doc V1.3 (XML mode)"><link rel="stylesheet" href="style.css" type="text/css"><link rel="chapter" href="lasso.html" title="Lasso &amp; Liberty Alliance Overview"><link rel="chapter" href="architecture.html" title="Lasso Architecture"><link rel="chapter" href="idff.html" title="Identity Federation Framework"><link rel="chapter" href="idwsf.html" title="Identity Web Services Framework"><link rel="chapter" href="xml.html" title="Schemas"><link rel="chapter" href="misc.html" title="Misc"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="LassoSession.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td><td><a accesskey="u" href="architecture.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td><td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td><th width="100%" align="center">Lasso Reference Manual</th><td><a accesskey="n" href="idff.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td></tr></table><div class="refentry" lang="en"><a name="LassoFederation"></a><div class="titlepage"></div><div class="refnamediv"><table width="100%"><tr><td valign="top"><h2><span class="refentrytitle">LassoFederation</span></h2><p>LassoFederation &#8212; Principal federation between two providers</p></td><td valign="top" align="right"></td></tr></table></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
 
1
<html>
 
2
<head>
 
3
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
 
4
<title>LassoFederation</title>
 
5
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
 
6
<link rel="start" href="index.html" title="Lasso Reference Manual">
 
7
<link rel="up" href="architecture.html" title="Lasso Architecture">
 
8
<link rel="prev" href="LassoSession.html" title="LassoSession">
 
9
<link rel="next" href="idff.html" title="Identity Federation Framework">
 
10
<meta name="generator" content="GTK-Doc V1.4 (XML mode)">
 
11
<link rel="stylesheet" href="style.css" type="text/css">
 
12
<link rel="chapter" href="lasso.html" title="Lasso &amp; Liberty Alliance Overview">
 
13
<link rel="chapter" href="architecture.html" title="Lasso Architecture">
 
14
<link rel="chapter" href="idff.html" title="Identity Federation Framework">
 
15
<link rel="chapter" href="idwsf.html" title="Identity Web Services Framework">
 
16
<link rel="chapter" href="xml.html" title="Schemas">
 
17
<link rel="chapter" href="misc.html" title="Misc">
 
18
</head>
 
19
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
20
<table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
 
21
<td><a accesskey="p" href="LassoSession.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
22
<td><a accesskey="u" href="architecture.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
23
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
24
<th width="100%" align="center">Lasso Reference Manual</th>
 
25
<td><a accesskey="n" href="idff.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
26
</tr></table>
 
27
<div class="refentry" lang="en">
 
28
<a name="LassoFederation"></a><div class="titlepage"></div>
 
29
<div class="refnamediv"><table width="100%"><tr>
 
30
<td valign="top">
 
31
<h2><span class="refentrytitle">LassoFederation</span></h2>
 
32
<p>LassoFederation &#8212; Principal federation between two providers</p>
 
33
</td>
 
34
<td valign="top" align="right"></td>
 
35
</tr></table></div>
 
36
<div class="refsynopsisdiv">
 
37
<h2>Synopsis</h2>
 
38
<pre class="synopsis">
2
39
 
3
40
#include &lt;lasso/lasso.h&gt;
4
41
 
15
52
                                            (<a href="LassoFederation.html" title="LassoFederation">LassoFederation</a> *federation,
16
53
                                             <a href="LassoSamlNameIdentifier.html" title="LassoSamlNameIdentifier">LassoSamlNameIdentifier</a> *name_identifier);
17
54
 
18
 
</pre></div><div class="refsect1" lang="en"><a name="id2540589"></a><h2>Object Hierarchy</h2><pre class="synopsis">
 
55
</pre>
 
56
</div>
 
57
<div class="refsect1" lang="en">
 
58
<a name="id2525285"></a><h2>Object Hierarchy</h2>
 
59
<pre class="synopsis">
19
60
 
20
61
  <GTKDOCLINK HREF="GObject">GObject</GTKDOCLINK>
21
62
   +----<a href="LassoNode.html" title="LassoNode">LassoNode</a>
22
63
         +----LassoFederation
23
 
</pre></div><div class="refsect1" lang="en"><a name="id2540616"></a><h2>Description</h2><p>
 
64
</pre>
 
65
</div>
 
66
<div class="refsect1" lang="en">
 
67
<a name="id2525312"></a><h2>Description</h2>
 
68
<p>
24
69
 
25
 
</p></div><div class="refsect1" lang="en"><a name="id2540626"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2540631"></a><h3><a name="LassoFederation-struct"></a>LassoFederation</h3><a class="indexterm" name="id2540643"></a><pre class="programlisting">typedef struct {
 
70
</p>
 
71
</div>
 
72
<div class="refsect1" lang="en">
 
73
<a name="id2525322"></a><h2>Details</h2>
 
74
<div class="refsect2" lang="en">
 
75
<a name="id2525327"></a><h3>
 
76
<a name="LassoFederation-struct"></a>LassoFederation</h3>
 
77
<a class="indexterm" name="id2525338"></a><pre class="programlisting">typedef struct {
26
78
        gchar *remote_providerID;
27
79
        LassoSamlNameIdentifier *local_nameIdentifier;
28
80
        LassoSamlNameIdentifier *remote_nameIdentifier;
29
81
} LassoFederation;
30
 
</pre><p>
31
 
 
32
 
</p></div><hr><div class="refsect2" lang="en"><a name="id2540660"></a><h3><a name="lasso-federation-new"></a>lasso_federation_new ()</h3><a class="indexterm" name="id2540671"></a><pre class="programlisting"><a href="LassoFederation.html" title="LassoFederation">LassoFederation</a>* lasso_federation_new       (<GTKDOCLINK HREF="gchar">gchar</GTKDOCLINK> *remote_providerID);</pre><p>
33
 
Creates a new <a href="LassoFederation.html" title="LassoFederation"><span class="type">LassoFederation</span></a> with the remote provider.</p><p>
34
 
 
35
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>remote_providerID</code></em>�:</span></td><td> remote Provider ID
36
 
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>�:</span></td><td> a newly created <a href="LassoFederation.html" title="LassoFederation"><span class="type">LassoFederation</span></a>
37
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2540749"></a><h3><a name="lasso-federation-destroy"></a>lasso_federation_destroy ()</h3><a class="indexterm" name="id2540760"></a><pre class="programlisting"><GTKDOCLINK HREF="void">void</GTKDOCLINK>        lasso_federation_destroy        (<a href="LassoFederation.html" title="LassoFederation">LassoFederation</a> *federation);</pre><p>
38
 
Destroys a federation.</p><p>
39
 
 
40
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>federation</code></em>�:</span></td><td> a <a href="LassoFederation.html" title="LassoFederation"><span class="type">LassoFederation</span></a>
41
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2540818"></a><h3><a name="lasso-federation-build-local-name-identifier"></a>lasso_federation_build_local_name_identifier ()</h3><a class="indexterm" name="id2540831"></a><pre class="programlisting"><GTKDOCLINK HREF="void">void</GTKDOCLINK>        lasso_federation_build_local_name_identifier
 
82
</pre>
 
83
<p>
 
84
 
 
85
</p>
 
86
</div>
 
87
<hr>
 
88
<div class="refsect2" lang="en">
 
89
<a name="id2525356"></a><h3>
 
90
<a name="lasso-federation-new"></a>lasso_federation_new ()</h3>
 
91
<a class="indexterm" name="id2525366"></a><pre class="programlisting"><a href="LassoFederation.html" title="LassoFederation">LassoFederation</a>* lasso_federation_new       (<GTKDOCLINK HREF="gchar">gchar</GTKDOCLINK> *remote_providerID);</pre>
 
92
<p>
 
93
Creates a new <a href="LassoFederation.html" title="LassoFederation"><span class="type">LassoFederation</span></a> with the remote provider.</p>
 
94
<p>
 
95
 
 
96
</p>
 
97
<div class="variablelist"><table border="0">
 
98
<col align="left" valign="top">
 
99
<tbody>
 
100
<tr>
 
101
<td>
 
102
<span class="term"><em class="parameter"><code>remote_providerID</code></em>&#160;:</span></td>
 
103
<td> remote Provider ID
 
104
</td>
 
105
</tr>
 
106
<tr>
 
107
<td>
 
108
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
109
<td> a newly created <a href="LassoFederation.html" title="LassoFederation"><span class="type">LassoFederation</span></a>
 
110
</td>
 
111
</tr>
 
112
</tbody>
 
113
</table></div>
 
114
</div>
 
115
<hr>
 
116
<div class="refsect2" lang="en">
 
117
<a name="id2525444"></a><h3>
 
118
<a name="lasso-federation-destroy"></a>lasso_federation_destroy ()</h3>
 
119
<a class="indexterm" name="id2525454"></a><pre class="programlisting"><GTKDOCLINK HREF="void">void</GTKDOCLINK>        lasso_federation_destroy        (<a href="LassoFederation.html" title="LassoFederation">LassoFederation</a> *federation);</pre>
 
120
<p>
 
121
Destroys a federation.</p>
 
122
<p>
 
123
 
 
124
</p>
 
125
<div class="variablelist"><table border="0">
 
126
<col align="left" valign="top">
 
127
<tbody><tr>
 
128
<td>
 
129
<span class="term"><em class="parameter"><code>federation</code></em>&#160;:</span></td>
 
130
<td> a <a href="LassoFederation.html" title="LassoFederation"><span class="type">LassoFederation</span></a>
 
131
</td>
 
132
</tr></tbody>
 
133
</table></div>
 
134
</div>
 
135
<hr>
 
136
<div class="refsect2" lang="en">
 
137
<a name="id2525513"></a><h3>
 
138
<a name="lasso-federation-build-local-name-identifier"></a>lasso_federation_build_local_name_identifier ()</h3>
 
139
<a class="indexterm" name="id2525524"></a><pre class="programlisting"><GTKDOCLINK HREF="void">void</GTKDOCLINK>        lasso_federation_build_local_name_identifier
42
140
                                            (<a href="LassoFederation.html" title="LassoFederation">LassoFederation</a> *federation,
43
141
                                             const <GTKDOCLINK HREF="gchar">gchar</GTKDOCLINK> *nameQualifier,
44
142
                                             const <GTKDOCLINK HREF="gchar">gchar</GTKDOCLINK> *format,
45
 
                                             const <GTKDOCLINK HREF="gchar">gchar</GTKDOCLINK> *content);</pre><p>
46
 
Builds federation local name identifier.</p><p>
 
143
                                             const <GTKDOCLINK HREF="gchar">gchar</GTKDOCLINK> *content);</pre>
 
144
<p>
 
145
Builds federation local name identifier.</p>
 
146
<p>
47
147
 
48
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>federation</code></em>�:</span></td><td> a <a href="LassoFederation.html" title="LassoFederation"><span class="type">LassoFederation</span></a>
49
 
</td></tr><tr><td><span class="term"><em class="parameter"><code>nameQualifier</code></em>�:</span></td><td> the name identifier qualifier
50
 
</td></tr><tr><td><span class="term"><em class="parameter"><code>format</code></em>�:</span></td><td> the name identifier format
51
 
</td></tr><tr><td><span class="term"><em class="parameter"><code>content</code></em>�:</span></td><td> the name identifier content
52
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2540957"></a><h3><a name="lasso-federation-verify-name-identifier"></a>lasso_federation_verify_name_identifier ()</h3><a class="indexterm" name="id2540969"></a><pre class="programlisting"><GTKDOCLINK HREF="gboolean">gboolean</GTKDOCLINK>    lasso_federation_verify_name_identifier
 
148
</p>
 
149
<div class="variablelist"><table border="0">
 
150
<col align="left" valign="top">
 
151
<tbody>
 
152
<tr>
 
153
<td>
 
154
<span class="term"><em class="parameter"><code>federation</code></em>&#160;:</span></td>
 
155
<td> a <a href="LassoFederation.html" title="LassoFederation"><span class="type">LassoFederation</span></a>
 
156
</td>
 
157
</tr>
 
158
<tr>
 
159
<td>
 
160
<span class="term"><em class="parameter"><code>nameQualifier</code></em>&#160;:</span></td>
 
161
<td> the name identifier qualifier
 
162
</td>
 
163
</tr>
 
164
<tr>
 
165
<td>
 
166
<span class="term"><em class="parameter"><code>format</code></em>&#160;:</span></td>
 
167
<td> the name identifier format
 
168
</td>
 
169
</tr>
 
170
<tr>
 
171
<td>
 
172
<span class="term"><em class="parameter"><code>content</code></em>&#160;:</span></td>
 
173
<td> the name identifier content
 
174
</td>
 
175
</tr>
 
176
</tbody>
 
177
</table></div>
 
178
</div>
 
179
<hr>
 
180
<div class="refsect2" lang="en">
 
181
<a name="id2525650"></a><h3>
 
182
<a name="lasso-federation-verify-name-identifier"></a>lasso_federation_verify_name_identifier ()</h3>
 
183
<a class="indexterm" name="id2525662"></a><pre class="programlisting"><GTKDOCLINK HREF="gboolean">gboolean</GTKDOCLINK>    lasso_federation_verify_name_identifier
53
184
                                            (<a href="LassoFederation.html" title="LassoFederation">LassoFederation</a> *federation,
54
 
                                             <a href="LassoSamlNameIdentifier.html" title="LassoSamlNameIdentifier">LassoSamlNameIdentifier</a> *name_identifier);</pre><p>
55
 
Checks whether federation is for <em class="parameter"><code>name_identifier</code></em>.</p><p>
 
185
                                             <a href="LassoSamlNameIdentifier.html" title="LassoSamlNameIdentifier">LassoSamlNameIdentifier</a> *name_identifier);</pre>
 
186
<p>
 
187
Checks whether federation is for <em class="parameter"><code>name_identifier</code></em>.</p>
 
188
<p>
56
189
 
57
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>federation</code></em>�:</span></td><td> a <a href="LassoFederation.html" title="LassoFederation"><span class="type">LassoFederation</span></a>
58
 
</td></tr><tr><td><span class="term"><em class="parameter"><code>name_identifier</code></em>�:</span></td><td> the <a href="LassoSamlNameIdentifier.html" title="LassoSamlNameIdentifier"><span class="type">LassoSamlNameIdentifier</span></a>
59
 
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>�:</span></td><td> <code class="literal">TRUE</code> if the federation is for <em class="parameter"><code>name_identifier</code></em>.
60
 
</td></tr></tbody></table></div></div></div></div><table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="LassoSession.html"><b>&lt;&lt;�LassoSession</b></a></td><td align="right"><a accesskey="n" href="idff.html"><b>Identity Federation Framework�&gt;&gt;</b></a></td></tr></table></body></html>
 
190
</p>
 
191
<div class="variablelist"><table border="0">
 
192
<col align="left" valign="top">
 
193
<tbody>
 
194
<tr>
 
195
<td>
 
196
<span class="term"><em class="parameter"><code>federation</code></em>&#160;:</span></td>
 
197
<td> a <a href="LassoFederation.html" title="LassoFederation"><span class="type">LassoFederation</span></a>
 
198
</td>
 
199
</tr>
 
200
<tr>
 
201
<td>
 
202
<span class="term"><em class="parameter"><code>name_identifier</code></em>&#160;:</span></td>
 
203
<td> the <a href="LassoSamlNameIdentifier.html" title="LassoSamlNameIdentifier"><span class="type">LassoSamlNameIdentifier</span></a>
 
204
</td>
 
205
</tr>
 
206
<tr>
 
207
<td>
 
208
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
209
<td> <code class="literal">TRUE</code> if the federation is for <em class="parameter"><code>name_identifier</code></em>.
 
210
</td>
 
211
</tr>
 
212
</tbody>
 
213
</table></div>
 
214
</div>
 
215
</div>
 
216
</div>
 
217
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">
 
218
<td align="left"><a accesskey="p" href="LassoSession.html"><b>&lt;&lt;&#160;LassoSession</b></a></td>
 
219
<td align="right"><a accesskey="n" href="idff.html"><b>Identity Federation Framework&#160;&gt;&gt;</b></a></td>
 
220
</tr></table>
 
221
</body>
 
222
</html>