← Back to branch summary

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

« back to all changes in this revision

Viewing changes to docs/reference/html/lasso-LassoNameIdentifierMapping.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:
docs/reference/html/lasso-LassoNameIdentifierMapping.html
1
 
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>LassoNameIdentifierMapping</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="idff.html" title="Identity Federation Framework"><link rel="prev" href="lasso-LassoNameRegistration.html" title="LassoNameRegistration"><link rel="next" href="idwsf.html" title="Identity Web Services 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="lasso-LassoNameRegistration.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td><td><a accesskey="u" href="idff.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="idwsf.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td></tr></table><div class="refentry" lang="en"><a name="lasso-LassoNameIdentifierMapping"></a><div class="titlepage"></div><div class="refnamediv"><table width="100%"><tr><td valign="top"><h2><span class="refentrytitle">LassoNameIdentifierMapping</span></h2><p>LassoNameIdentifierMapping &#8212; Name Identifier Mapping</p></td><td valign="top" align="right"></td></tr></table></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
2
 
 
3
 
#include &lt;lasso/lasso.h&gt;
4
 
 
5
 
 
6
 
            <a href="lasso-LassoNameIdentifierMapping.html#LassoNameIdentifierMapping">LassoNameIdentifierMapping</a>;
7
 
<a href="lasso-LassoNameIdentifierMapping.html#LassoNameIdentifierMapping">LassoNameIdentifierMapping</a>* <a href="lasso-LassoNameIdentifierMapping.html#lasso-name-identifier-mapping-new">lasso_name_identifier_mapping_new</a>
8
 
                                            (<a href="LassoServer.html" title="LassoServer">LassoServer</a> *server);
9
 
<GTKDOCLINK HREF="void">void</GTKDOCLINK>        <a href="lasso-LassoNameIdentifierMapping.html#lasso-name-identifier-mapping-destroy">lasso_name_identifier_mapping_destroy</a>
10
 
                                            (<a href="lasso-LassoNameIdentifierMapping.html#LassoNameIdentifierMapping">LassoNameIdentifierMapping</a> *mapping);
11
 
<GTKDOCLINK HREF="gint">gint</GTKDOCLINK>        <a href="lasso-LassoNameIdentifierMapping.html#lasso-name-identifier-mapping-build-request-msg">lasso_name_identifier_mapping_build_request_msg</a>
12
 
                                            (<a href="lasso-LassoNameIdentifierMapping.html#LassoNameIdentifierMapping">LassoNameIdentifierMapping</a> *mapping);
13
 
<GTKDOCLINK HREF="gint">gint</GTKDOCLINK>        <a href="lasso-LassoNameIdentifierMapping.html#lasso-name-identifier-mapping-build-response-msg">lasso_name_identifier_mapping_build_response_msg</a>
14
 
                                            (<a href="lasso-LassoNameIdentifierMapping.html#LassoNameIdentifierMapping">LassoNameIdentifierMapping</a> *mapping);
15
 
<GTKDOCLINK HREF="gint">gint</GTKDOCLINK>        <a href="lasso-LassoNameIdentifierMapping.html#lasso-name-identifier-mapping-init-request">lasso_name_identifier_mapping_init_request</a>
16
 
                                            (<a href="lasso-LassoNameIdentifierMapping.html#LassoNameIdentifierMapping">LassoNameIdentifierMapping</a> *mapping,
17
 
                                             <GTKDOCLINK HREF="gchar">gchar</GTKDOCLINK> *targetNameSpace,
18
 
                                             <GTKDOCLINK HREF="gchar">gchar</GTKDOCLINK> *remote_providerID);
19
 
<GTKDOCLINK HREF="gint">gint</GTKDOCLINK>        <a href="lasso-LassoNameIdentifierMapping.html#lasso-name-identifier-mapping-process-request-msg">lasso_name_identifier_mapping_process_request_msg</a>
20
 
                                            (<a href="lasso-LassoNameIdentifierMapping.html#LassoNameIdentifierMapping">LassoNameIdentifierMapping</a> *mapping,
21
 
                                             <GTKDOCLINK HREF="gchar">gchar</GTKDOCLINK> *request_msg);
22
 
<GTKDOCLINK HREF="gint">gint</GTKDOCLINK>        <a href="lasso-LassoNameIdentifierMapping.html#lasso-name-identifier-mapping-process-response-msg">lasso_name_identifier_mapping_process_response_msg</a>
23
 
                                            (<a href="lasso-LassoNameIdentifierMapping.html#LassoNameIdentifierMapping">LassoNameIdentifierMapping</a> *mapping,
24
 
                                             <GTKDOCLINK HREF="gchar">gchar</GTKDOCLINK> *response_msg);
25
 
<GTKDOCLINK HREF="gint">gint</GTKDOCLINK>        <a href="lasso-LassoNameIdentifierMapping.html#lasso-name-identifier-mapping-validate-request">lasso_name_identifier_mapping_validate_request</a>
26
 
                                            (<a href="lasso-LassoNameIdentifierMapping.html#LassoNameIdentifierMapping">LassoNameIdentifierMapping</a> *mapping);
27
 
 
28
 
</pre></div><div class="refsect1" lang="en"><a name="id2562496"></a><h2>Description</h2><p>
29
 
 
30
 
</p></div><div class="refsect1" lang="en"><a name="id2562506"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2562512"></a><h3><a name="LassoNameIdentifierMapping"></a>LassoNameIdentifierMapping</h3><a class="indexterm" name="id2562523"></a><pre class="programlisting">typedef struct {
31
 
        LassoProfile parent;
32
 
 
33
 
        gchar *targetNameIdentifier;
34
 
} LassoNameIdentifierMapping;
35
 
</pre><p>
36
 
 
37
 
</p></div><hr><div class="refsect2" lang="en"><a name="id2562540"></a><h3><a name="lasso-name-identifier-mapping-new"></a>lasso_name_identifier_mapping_new ()</h3><a class="indexterm" name="id2562552"></a><pre class="programlisting"><a href="lasso-LassoNameIdentifierMapping.html#LassoNameIdentifierMapping">LassoNameIdentifierMapping</a>* lasso_name_identifier_mapping_new
38
 
                                            (<a href="LassoServer.html" title="LassoServer">LassoServer</a> *server);</pre><p>
39
 
Creates a new <a href="lasso-LassoNameIdentifierMapping.html#LassoNameIdentifierMapping"><span class="type">LassoNameIdentifierMapping</span></a>.</p><p>
40
 
 
41
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>server</code></em>�:</span></td><td> the <a href="LassoServer.html" title="LassoServer"><span class="type">LassoServer</span></a>
42
 
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>�:</span></td><td> a newly created <a href="lasso-LassoNameIdentifierMapping.html#LassoNameIdentifierMapping"><span class="type">LassoNameIdentifierMapping</span></a> object; or NULL
43
 
    if an error occured
44
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2562639"></a><h3><a name="lasso-name-identifier-mapping-destroy"></a>lasso_name_identifier_mapping_destroy ()</h3><a class="indexterm" name="id2562652"></a><pre class="programlisting"><GTKDOCLINK HREF="void">void</GTKDOCLINK>        lasso_name_identifier_mapping_destroy
45
 
                                            (<a href="lasso-LassoNameIdentifierMapping.html#LassoNameIdentifierMapping">LassoNameIdentifierMapping</a> *mapping);</pre><p>
46
 
Destroys a <a href="lasso-LassoNameIdentifierMapping.html#LassoNameIdentifierMapping"><span class="type">LassoNameIdentifierMapping</span></a> object.</p><p>
47
 
 
48
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>mapping</code></em>�:</span></td><td> a <a href="lasso-LassoNameIdentifierMapping.html#LassoNameIdentifierMapping"><span class="type">LassoNameIdentifierMapping</span></a>
49
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2562720"></a><h3><a name="lasso-name-identifier-mapping-build-request-msg"></a>lasso_name_identifier_mapping_build_request_msg ()</h3><a class="indexterm" name="id2562734"></a><pre class="programlisting"><GTKDOCLINK HREF="gint">gint</GTKDOCLINK>        lasso_name_identifier_mapping_build_request_msg
50
 
                                            (<a href="lasso-LassoNameIdentifierMapping.html#LassoNameIdentifierMapping">LassoNameIdentifierMapping</a> *mapping);</pre><p>
51
 
Builds a name identifier mapping request message.
52
 
</p><p>
53
 
</p><div class="itemizedlist"><ul type="disc"><li><p>
54
 
  If it is a SOAP method, then it builds the request as a SOAP message,
55
 
  optionally signs his node, sets <em class="parameter"><code>msg_body</code></em> with that message and sets
56
 
  <em class="parameter"><code>msg_url</code></em> with the SOAP Endpoint URL
57
 
</p></li><li><p>
58
 
  If it is a HTTP-Redirect method, then it builds the request as a query
59
 
  string message, optionally signs it and sets <em class="parameter"><code>msg_url</code></em> to that URL.
60
 
</p></li></ul></div><p>
61
 
 
62
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>mapping</code></em>�:</span></td><td> a <a href="lasso-LassoNameIdentifierMapping.html#LassoNameIdentifierMapping"><span class="type">LassoNameIdentifierMapping</span></a>
63
 
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>�:</span></td><td> 0 on success; or a negative value otherwise.
64
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2562842"></a><h3><a name="lasso-name-identifier-mapping-build-response-msg"></a>lasso_name_identifier_mapping_build_response_msg ()</h3><a class="indexterm" name="id2562856"></a><pre class="programlisting"><GTKDOCLINK HREF="gint">gint</GTKDOCLINK>        lasso_name_identifier_mapping_build_response_msg
65
 
                                            (<a href="lasso-LassoNameIdentifierMapping.html#LassoNameIdentifierMapping">LassoNameIdentifierMapping</a> *mapping);</pre><p>
66
 
Builds a name identifier mapping response message.
67
 
</p><p>
68
 
</p><div class="itemizedlist"><ul type="disc"><li><p>
69
 
  If it is a SOAP method, then it builds the response as a SOAP message,
70
 
  optionally signs his node, sets <em class="parameter"><code>msg_body</code></em> with that message and sets
71
 
  <em class="parameter"><code>msg_url</code></em> with the register name identifier service return URL.
72
 
</p></li><li><p>
73
 
  If it is a HTTP-Redirect method, then it builds the response as a query
74
 
  string message, optionally signs it and sets <em class="parameter"><code>msg_url</code></em> to that URL.
75
 
</p></li></ul></div><p>
76
 
</p><p>
77
 
If private key and certificate are set in server object it will also signs
78
 
the message (either with X509 if SOAP or with a simple signature for query
79
 
strings).</p><p>
80
 
 
81
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>mapping</code></em>�:</span></td><td> a <a href="lasso-LassoNameIdentifierMapping.html#LassoNameIdentifierMapping"><span class="type">LassoNameIdentifierMapping</span></a>
82
 
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>�:</span></td><td> 0 on success; or a negative value otherwise.
83
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2562972"></a><h3><a name="lasso-name-identifier-mapping-init-request"></a>lasso_name_identifier_mapping_init_request ()</h3><a class="indexterm" name="id2562985"></a><pre class="programlisting"><GTKDOCLINK HREF="gint">gint</GTKDOCLINK>        lasso_name_identifier_mapping_init_request
84
 
                                            (<a href="lasso-LassoNameIdentifierMapping.html#LassoNameIdentifierMapping">LassoNameIdentifierMapping</a> *mapping,
85
 
                                             <GTKDOCLINK HREF="gchar">gchar</GTKDOCLINK> *targetNameSpace,
86
 
                                             <GTKDOCLINK HREF="gchar">gchar</GTKDOCLINK> *remote_providerID);</pre><p>
87
 
Initializes a new lib:NameIdentifierMappingRequest request.</p><p>
88
 
 
89
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>mapping</code></em>�:</span></td><td> a <a href="lasso-LassoNameIdentifierMapping.html#LassoNameIdentifierMapping"><span class="type">LassoNameIdentifierMapping</span></a>
90
 
</td></tr><tr><td><span class="term"><em class="parameter"><code>targetNameSpace</code></em>�:</span></td><td> the request targetNamespace
91
 
</td></tr><tr><td><span class="term"><em class="parameter"><code>remote_providerID</code></em>�:</span></td><td> the providerID of the identity provider.
92
 
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>�:</span></td><td> 0 on success; or a negative value otherwise.
93
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2563101"></a><h3><a name="lasso-name-identifier-mapping-process-request-msg"></a>lasso_name_identifier_mapping_process_request_msg ()</h3><a class="indexterm" name="id2563115"></a><pre class="programlisting"><GTKDOCLINK HREF="gint">gint</GTKDOCLINK>        lasso_name_identifier_mapping_process_request_msg
94
 
                                            (<a href="lasso-LassoNameIdentifierMapping.html#LassoNameIdentifierMapping">LassoNameIdentifierMapping</a> *mapping,
95
 
                                             <GTKDOCLINK HREF="gchar">gchar</GTKDOCLINK> *request_msg);</pre><p>
96
 
Processes a lib:NameIdentifierMappingRequest message.  Rebuilds a request
97
 
object from the message and optionally verifies its signature.</p><p>
98
 
 
99
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>mapping</code></em>�:</span></td><td> a <a href="lasso-LassoNameIdentifierMapping.html#LassoNameIdentifierMapping"><span class="type">LassoNameIdentifierMapping</span></a>
100
 
</td></tr><tr><td><span class="term"><em class="parameter"><code>request_msg</code></em>�:</span></td><td> the name identifier mapping request message
101
 
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>�:</span></td><td> 0 on success; or a negative value otherwise.
102
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2563210"></a><h3><a name="lasso-name-identifier-mapping-process-response-msg"></a>lasso_name_identifier_mapping_process_response_msg ()</h3><a class="indexterm" name="id2563224"></a><pre class="programlisting"><GTKDOCLINK HREF="gint">gint</GTKDOCLINK>        lasso_name_identifier_mapping_process_response_msg
103
 
                                            (<a href="lasso-LassoNameIdentifierMapping.html#LassoNameIdentifierMapping">LassoNameIdentifierMapping</a> *mapping,
104
 
                                             <GTKDOCLINK HREF="gchar">gchar</GTKDOCLINK> *response_msg);</pre><p>
105
 
Processes a lib:NameIdentifierMappingResponse message.  Rebuilds a response
106
 
object from the message and optionally verifies its signature.
107
 
</p><p>
108
 
If the response depicts Success it will also sets <em class="parameter"><code>targetNameIdentifier</code></em>.</p><p>
109
 
 
110
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>mapping</code></em>�:</span></td><td> a <a href="lasso-LassoNameIdentifierMapping.html#LassoNameIdentifierMapping"><span class="type">LassoNameIdentifierMapping</span></a>
111
 
</td></tr><tr><td><span class="term"><em class="parameter"><code>response_msg</code></em>�:</span></td><td> the name identifier mapping response message
112
 
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>�:</span></td><td> 0 on success; or a negative value otherwise.
113
 
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2563329"></a><h3><a name="lasso-name-identifier-mapping-validate-request"></a>lasso_name_identifier_mapping_validate_request ()</h3><a class="indexterm" name="id2563342"></a><pre class="programlisting"><GTKDOCLINK HREF="gint">gint</GTKDOCLINK>        lasso_name_identifier_mapping_validate_request
114
 
                                            (<a href="lasso-LassoNameIdentifierMapping.html#LassoNameIdentifierMapping">LassoNameIdentifierMapping</a> *mapping);</pre><p>
115
 
Checks profile request with regards to message status and principal
116
 
federations, update them accordingly and prepares a 
117
 
lib:NameIdentifierMappingResponse accordingly.</p><p>
118
 
 
119
 
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>mapping</code></em>�:</span></td><td> a <a href="lasso-LassoNameIdentifierMapping.html#LassoNameIdentifierMapping"><span class="type">LassoNameIdentifierMapping</span></a>
120
 
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>�:</span></td><td> 0 on success; or a negative value otherwise.
121
 
</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="lasso-LassoNameRegistration.html"><b>&lt;&lt;�LassoNameRegistration</b></a></td><td align="right"><a accesskey="n" href="idwsf.html"><b>Identity Web Services Framework�&gt;&gt;</b></a></td></tr></table></body></html>