Blob Blame History Raw
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>LassoIdentity: Lasso Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Lasso Reference Manual">
<link rel="up" href="architecture.html" title="Lasso Architecture">
<link rel="prev" href="lasso-LassoProvider.html" title="LassoProvider">
<link rel="next" href="lasso-LassoFederation.html" title="LassoFederation">
<meta name="generator" content="GTK-Doc V1.28 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#lasso-LassoIdentity.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="architecture.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="lasso-LassoProvider.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="lasso-LassoFederation.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="lasso-LassoIdentity"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="lasso-LassoIdentity.top_of_page"></a>LassoIdentity</span></h2>
<p>LassoIdentity — Principal identity</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="lasso-LassoIdentity.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="lasso-LassoIdentity.html#LassoIdentity" title="struct LassoIdentity"><span class="returnvalue">LassoIdentity</span></a> *
</td>
<td class="function_name">
<a class="link" href="lasso-LassoIdentity.html#lasso-identity-new" title="lasso_identity_new ()">lasso_identity_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="lasso-LassoIdentity.html#LassoIdentity" title="struct LassoIdentity"><span class="returnvalue">LassoIdentity</span></a> *
</td>
<td class="function_name">
<a class="link" href="lasso-LassoIdentity.html#lasso-identity-new-from-dump" title="lasso_identity_new_from_dump ()">lasso_identity_new_from_dump</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="lasso-LassoFederation.html#LassoFederation" title="struct LassoFederation"><span class="returnvalue">LassoFederation</span></a> *
</td>
<td class="function_name">
<a class="link" href="lasso-LassoIdentity.html#lasso-identity-get-federation" title="lasso_identity_get_federation ()">lasso_identity_get_federation</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="lasso-LassoIdentity.html#lasso-identity-destroy" title="lasso_identity_destroy ()">lasso_identity_destroy</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="lasso-LassoIdentity.html#lasso-identity-dump" title="lasso_identity_dump ()">lasso_identity_dump</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="lasso-LassoIdentity.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="lasso-LassoIdentity.html#LassoIdentity" title="struct LassoIdentity">LassoIdentity</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="lasso-LassoIdentity.description"></a><h2>Description</h2>
<p>A <a class="link" href="lasso-LassoIdentity.html#LassoIdentity" title="struct LassoIdentity"><span class="type">LassoIdentity</span></a> object records the identifers that a principal use two federate pairs of
providers.</p>
</div>
<div class="refsect1">
<a name="lasso-LassoIdentity.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="lasso-identity-new"></a><h3>lasso_identity_new ()</h3>
<pre class="programlisting"><a class="link" href="lasso-LassoIdentity.html#LassoIdentity" title="struct LassoIdentity"><span class="returnvalue">LassoIdentity</span></a> *
lasso_identity_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new <a class="link" href="lasso-LassoIdentity.html#LassoIdentity" title="struct LassoIdentity"><span class="type">LassoIdentity</span></a>.</p>
<div class="refsect3">
<a name="lasso-identity-new.returns"></a><h4>Returns</h4>
<p> a newly created <a class="link" href="lasso-LassoIdentity.html#LassoIdentity" title="struct LassoIdentity"><span class="type">LassoIdentity</span></a></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="lasso-identity-new-from-dump"></a><h3>lasso_identity_new_from_dump ()</h3>
<pre class="programlisting"><a class="link" href="lasso-LassoIdentity.html#LassoIdentity" title="struct LassoIdentity"><span class="returnvalue">LassoIdentity</span></a> *
lasso_identity_new_from_dump (<em class="parameter"><code>const <span class="type">gchar</span> *dump</code></em>);</pre>
<p>Restores the <em class="parameter"><code>dump</code></em>
 to a new <a class="link" href="lasso-LassoIdentity.html#LassoIdentity" title="struct LassoIdentity"><span class="type">LassoIdentity</span></a>.</p>
<div class="refsect3">
<a name="lasso-identity-new-from-dump.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>dump</p></td>
<td class="parameter_description"><p>XML server dump</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="lasso-identity-new-from-dump.returns"></a><h4>Returns</h4>
<p> a newly created <a class="link" href="lasso-LassoIdentity.html#LassoIdentity" title="struct LassoIdentity"><span class="type">LassoIdentity</span></a>; or NULL if an error occured</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="lasso-identity-get-federation"></a><h3>lasso_identity_get_federation ()</h3>
<pre class="programlisting"><a class="link" href="lasso-LassoFederation.html#LassoFederation" title="struct LassoFederation"><span class="returnvalue">LassoFederation</span></a> *
lasso_identity_get_federation (<em class="parameter"><code><a class="link" href="lasso-LassoIdentity.html#LassoIdentity" title="struct LassoIdentity"><span class="type">LassoIdentity</span></a> *identity</code></em>,
                               <em class="parameter"><code>const <span class="type">char</span> *providerID</code></em>);</pre>
<p>Looks up and returns the <a class="link" href="lasso-LassoFederation.html#LassoFederation" title="struct LassoFederation"><span class="type">LassoFederation</span></a> for this provider ID.</p>
<div class="refsect3">
<a name="lasso-identity-get-federation.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>identity</p></td>
<td class="parameter_description"><p>a <a class="link" href="lasso-LassoIdentity.html#LassoIdentity" title="struct LassoIdentity"><span class="type">LassoIdentity</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>providerID</p></td>
<td class="parameter_description"><p>the provider ID</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="lasso-identity-get-federation.returns"></a><h4>Returns</h4>
<p>the <a class="link" href="lasso-LassoFederation.html#LassoFederation" title="struct LassoFederation"><span class="type">LassoFederation</span></a>; or NULL if it didn't exist.  The
<a class="link" href="lasso-LassoFederation.html#LassoFederation" title="struct LassoFederation"><span class="type">LassoFederation</span></a> is internally allocated.  It must not be freed,
modified or stored. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="lasso-identity-destroy"></a><h3>lasso_identity_destroy ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
lasso_identity_destroy (<em class="parameter"><code><a class="link" href="lasso-LassoIdentity.html#LassoIdentity" title="struct LassoIdentity"><span class="type">LassoIdentity</span></a> *identity</code></em>);</pre>
<p>Destroys an identity.</p>
<div class="refsect3">
<a name="lasso-identity-destroy.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>identity</p></td>
<td class="parameter_description"><p>a <a class="link" href="lasso-LassoIdentity.html#LassoIdentity" title="struct LassoIdentity"><span class="type">LassoIdentity</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="lasso-identity-dump"></a><h3>lasso_identity_dump ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
lasso_identity_dump (<em class="parameter"><code><a class="link" href="lasso-LassoIdentity.html#LassoIdentity" title="struct LassoIdentity"><span class="type">LassoIdentity</span></a> *identity</code></em>);</pre>
<p>Dumps <em class="parameter"><code>identity</code></em>
 content to an XML string.</p>
<div class="refsect3">
<a name="lasso-identity-dump.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>identity</p></td>
<td class="parameter_description"><p>a <a class="link" href="lasso-LassoIdentity.html#LassoIdentity" title="struct LassoIdentity"><span class="type">LassoIdentity</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="lasso-identity-dump.returns"></a><h4>Returns</h4>
<p>the dump string.  It must be freed by the caller. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="lasso-LassoIdentity.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="LassoIdentity"></a><h3>struct LassoIdentity</h3>
<pre class="programlisting">struct LassoIdentity {
	LassoNode parent;

	GHashTable *federations; /* of LassoFederation */
	gboolean is_dirty;
};
</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.28</div>
</body>
</html>