<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>LassoWsAddrEndpointReference: 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="ws-addr.html" title="Object from the WS-* schemas">
<link rel="prev" href="lasso-LassoWsAddrAttributedURI.html" title="LassoWsAddrAttributedURI">
<link rel="next" href="lasso-LassoWsAddrMetadata.html" title="LassoWsAddrMetadata">
<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-LassoWsAddrEndpointReference.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="ws-addr.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="lasso-LassoWsAddrAttributedURI.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="lasso-LassoWsAddrMetadata.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="lasso-LassoWsAddrEndpointReference"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="lasso-LassoWsAddrEndpointReference.top_of_page"></a>LassoWsAddrEndpointReference</span></h2>
<p>LassoWsAddrEndpointReference</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="lasso-LassoWsAddrEndpointReference.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-LassoWsAddrEndpointReference.html#LassoWsAddrEndpointReference" title="struct LassoWsAddrEndpointReference"><span class="returnvalue">LassoWsAddrEndpointReference</span></a> *
</td>
<td class="function_name">
<a class="link" href="lasso-LassoWsAddrEndpointReference.html#lasso-wsa-endpoint-reference-new" title="lasso_wsa_endpoint_reference_new ()">lasso_wsa_endpoint_reference_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="lasso-node.html#LassoNode" title="struct LassoNode"><span class="returnvalue">LassoNode</span></a> *
</td>
<td class="function_name">
<a class="link" href="lasso-LassoWsAddrEndpointReference.html#lasso-wsa-endpoint-reference-get-target-identity-token" title="lasso_wsa_endpoint_reference_get_target_identity_token ()">lasso_wsa_endpoint_reference_get_target_identity_token</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="lasso-LassoWsAddrEndpointReference.html#LassoWsAddrEndpointReference" title="struct LassoWsAddrEndpointReference"><span class="returnvalue">LassoWsAddrEndpointReference</span></a> *
</td>
<td class="function_name">
<a class="link" href="lasso-LassoWsAddrEndpointReference.html#lasso-wsa-endpoint-reference-new-for-idwsf2-service" title="lasso_wsa_endpoint_reference_new_for_idwsf2_service ()">lasso_wsa_endpoint_reference_new_for_idwsf2_service</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">lasso_error_t</span>
</td>
<td class="function_name">
<a class="link" href="lasso-LassoWsAddrEndpointReference.html#lasso-wsa-endpoint-reference-add-security-token" title="lasso_wsa_endpoint_reference_add_security_token ()">lasso_wsa_endpoint_reference_add_security_token</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">lasso_error_t</span>
</td>
<td class="function_name">
<a class="link" href="lasso-LassoWsAddrEndpointReference.html#lasso-wsa-endpoint-reference-associate-service-to-type" title="lasso_wsa_endpoint_reference_associate_service_to_type ()">lasso_wsa_endpoint_reference_associate_service_to_type</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="lasso-LassoIdWsf2Profile.html#LassoIdWsf2Profile" title="struct LassoIdWsf2Profile"><span class="returnvalue">LassoIdWsf2Profile</span></a> *
</td>
<td class="function_name">
<a class="link" href="lasso-LassoWsAddrEndpointReference.html#lasso-wsa-endpoint-reference-get-service" title="lasso_wsa_endpoint_reference_get_service ()">lasso_wsa_endpoint_reference_get_service</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="lasso-LassoWsAddrEndpointReference.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-LassoWsAddrEndpointReference.html#LassoWsAddrEndpointReference" title="struct LassoWsAddrEndpointReference">LassoWsAddrEndpointReference</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="lasso-LassoWsAddrEndpointReference.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="lasso-LassoWsAddrEndpointReference.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="lasso-wsa-endpoint-reference-new"></a><h3>lasso_wsa_endpoint_reference_new ()</h3>
<pre class="programlisting"><a class="link" href="lasso-LassoWsAddrEndpointReference.html#LassoWsAddrEndpointReference" title="struct LassoWsAddrEndpointReference"><span class="returnvalue">LassoWsAddrEndpointReference</span></a> *
lasso_wsa_endpoint_reference_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new <a class="link" href="lasso-LassoWsAddrEndpointReference.html#LassoWsAddrEndpointReference" title="struct LassoWsAddrEndpointReference"><span class="type">LassoWsAddrEndpointReference</span></a> object.</p>
<div class="refsect3">
<a name="lasso-wsa-endpoint-reference-new.returns"></a><h4>Returns</h4>
<p> a newly created <a class="link" href="lasso-LassoWsAddrEndpointReference.html#LassoWsAddrEndpointReference" title="struct LassoWsAddrEndpointReference"><span class="type">LassoWsAddrEndpointReference</span></a> object</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="lasso-wsa-endpoint-reference-get-target-identity-token"></a><h3>lasso_wsa_endpoint_reference_get_target_identity_token ()</h3>
<pre class="programlisting"><a class="link" href="lasso-node.html#LassoNode" title="struct LassoNode"><span class="returnvalue">LassoNode</span></a> *
lasso_wsa_endpoint_reference_get_target_identity_token
(<em class="parameter"><code>const <a class="link" href="lasso-LassoWsAddrEndpointReference.html#LassoWsAddrEndpointReference" title="struct LassoWsAddrEndpointReference"><span class="type">LassoWsAddrEndpointReference</span></a> *epr</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> (*sech_mech_predicate) (const char *)</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *security_mech_id</code></em>);</pre>
<p>Return the first target identity token found in the metadata of the <em class="parameter"><code>epr</code></em>
object which qualify
with respect to the predicate or the given security mechanism identifier. It is an error to pass
both of <em class="parameter"><code>sech_mech_predicate</code></em>
and <em class="parameter"><code>security_mech_id</code></em>
as NULL.</p>
<div class="refsect3">
<a name="lasso-wsa-endpoint-reference-get-target-identity-token.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>epr</p></td>
<td class="parameter_description"><p>a <a class="link" href="lasso-LassoWsAddrEndpointReference.html#LassoWsAddrEndpointReference" title="struct LassoWsAddrEndpointReference"><span class="type">LassoWsAddrEndpointReference</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>sech_mech_predicate</p></td>
<td class="parameter_description"><p>a boolean function to select the security mechanism for which
we want the security token. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>security_mech_id</p></td>
<td class="parameter_description"><p>an optional specific security mechanism identifier to select the
security token. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="lasso-wsa-endpoint-reference-get-target-identity-token.returns"></a><h4>Returns</h4>
<p>a <a class="link" href="lasso-node.html#LassoNode" title="struct LassoNode"><span class="type">LassoNode</span></a> object or NULL if the query cannot be satisfied. </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-wsa-endpoint-reference-new-for-idwsf2-service"></a><h3>lasso_wsa_endpoint_reference_new_for_idwsf2_service ()</h3>
<pre class="programlisting"><a class="link" href="lasso-LassoWsAddrEndpointReference.html#LassoWsAddrEndpointReference" title="struct LassoWsAddrEndpointReference"><span class="returnvalue">LassoWsAddrEndpointReference</span></a> *
lasso_wsa_endpoint_reference_new_for_idwsf2_service
(<em class="parameter"><code>const <span class="type">char</span> *address</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *service_ype</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *provider_id</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *abstract</code></em>);</pre>
<p>Create and populate a new <a class="link" href="lasso-LassoWsAddrEndpointReference.html#LassoWsAddrEndpointReference" title="struct LassoWsAddrEndpointReference"><span class="type">LassoWsAddrEndpointReference</span></a> object.</p>
<div class="refsect3">
<a name="lasso-wsa-endpoint-reference-new-for-idwsf2-service.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>address</p></td>
<td class="parameter_description"><p>the URL of the SOAP endpoint where the service is anchored</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>service_type</p></td>
<td class="parameter_description"><p>an URI identifying the ID-WSF 2.0 service type</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>provider_id</p></td>
<td class="parameter_description"><p>an URI identifying the SAML 2.0 service provider hosting the service, this should
help in finding key material for security mechanisms.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>abstract</p></td>
<td class="parameter_description"><p>a human description of the service.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="lasso-wsa-endpoint-reference-new-for-idwsf2-service.returns"></a><h4>Returns</h4>
<p> a newly created <a class="link" href="lasso-LassoWsAddrEndpointReference.html#LassoWsAddrEndpointReference" title="struct LassoWsAddrEndpointReference"><span class="type">LassoWsAddrEndpointReference</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="lasso-wsa-endpoint-reference-add-security-token"></a><h3>lasso_wsa_endpoint_reference_add_security_token ()</h3>
<pre class="programlisting"><span class="returnvalue">lasso_error_t</span>
lasso_wsa_endpoint_reference_add_security_token
(<em class="parameter"><code><a class="link" href="lasso-LassoWsAddrEndpointReference.html#LassoWsAddrEndpointReference" title="struct LassoWsAddrEndpointReference"><span class="type">LassoWsAddrEndpointReference</span></a> *epr</code></em>,
<em class="parameter"><code><a class="link" href="lasso-node.html#LassoNode" title="struct LassoNode"><span class="type">LassoNode</span></a> *security_token</code></em>,
<em class="parameter"><code><span class="type">GList</span> *security_mechanisms</code></em>);</pre>
<p>Add a new security context declaration for the given security mechanisms identifiers and populate
it with a security token.</p>
<div class="refsect3">
<a name="lasso-wsa-endpoint-reference-add-security-token.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>epr</p></td>
<td class="parameter_description"><p>a <a class="link" href="lasso-LassoWsAddrEndpointReference.html#LassoWsAddrEndpointReference" title="struct LassoWsAddrEndpointReference"><span class="type">LassoWsAddrEndpointReference</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>security_token</p></td>
<td class="parameter_description"><p>a security token as a <a class="link" href="lasso-node.html#LassoNode" title="struct LassoNode"><span class="type">LassoNode</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>security_mechanisms</p></td>
<td class="parameter_description"><p>a list of security mechanism
for whom the token is made. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="lasso-wsa-endpoint-reference-add-security-token.returns"></a><h4>Returns</h4>
<p> 0 if successfull, an error code otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="lasso-wsa-endpoint-reference-associate-service-to-type"></a><h3>lasso_wsa_endpoint_reference_associate_service_to_type ()</h3>
<pre class="programlisting"><span class="returnvalue">lasso_error_t</span>
lasso_wsa_endpoint_reference_associate_service_to_type
(<em class="parameter"><code>const <span class="type">char</span> *service_type_uri</code></em>,
<em class="parameter"><code><span class="type">GType</span> g_type</code></em>);</pre>
<p>Associate a profile type to a service type.</p>
<div class="refsect3">
<a name="lasso-wsa-endpoint-reference-associate-service-to-type.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>service_type_uri</p></td>
<td class="parameter_description"><p>a service type to associate</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>g_type</p></td>
<td class="parameter_description"><p>the type of the profile object handling this service type</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="lasso-wsa-endpoint-reference-associate-service-to-type.returns"></a><h4>Returns</h4>
<p> 0 if successful, an error code otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="lasso-wsa-endpoint-reference-get-service"></a><h3>lasso_wsa_endpoint_reference_get_service ()</h3>
<pre class="programlisting"><a class="link" href="lasso-LassoIdWsf2Profile.html#LassoIdWsf2Profile" title="struct LassoIdWsf2Profile"><span class="returnvalue">LassoIdWsf2Profile</span></a> *
lasso_wsa_endpoint_reference_get_service
(<em class="parameter"><code><a class="link" href="lasso-LassoWsAddrEndpointReference.html#LassoWsAddrEndpointReference" title="struct LassoWsAddrEndpointReference"><span class="type">LassoWsAddrEndpointReference</span></a> *epr</code></em>);</pre>
<p>Get a profile object able to communicate with the service represented by this EPR.</p>
<p>Return object: a newly created <a class="link" href="lasso-LassoIdWsf2Profile.html#LassoIdWsf2Profile" title="struct LassoIdWsf2Profile"><span class="type">LassoIdWsf2Profile</span></a> instance.</p>
<div class="refsect3">
<a name="lasso-wsa-endpoint-reference-get-service.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>epr</p></td>
<td class="parameter_description"><p>a <a class="link" href="lasso-LassoWsAddrEndpointReference.html#LassoWsAddrEndpointReference" title="struct LassoWsAddrEndpointReference"><span class="type">LassoWsAddrEndpointReference</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="lasso-LassoWsAddrEndpointReference.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="LassoWsAddrEndpointReference"></a><h3>struct LassoWsAddrEndpointReference</h3>
<pre class="programlisting">struct LassoWsAddrEndpointReference {
LassoNode parent;
/* elements */
LassoWsAddrAttributedURI *Address;
LassoWsAddrReferenceParameters *ReferenceParameters;
LassoWsAddrMetadata *Metadata;
GList *any; /* of LassoNode */
/* attributes */
GHashTable *attributes;
};
</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.28</div>
</body>
</html>