docs/html/GSignondExtension.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>gsignond API Reference Manual: GSignondExtension</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
   7 <link rel="home" href="index.html" title="gsignond API Reference Manual">
   8 <link rel="up" href="ch06.html" title="GSignond API for writing platform adaptation extensions">
   9 <link rel="prev" href="ch06.html" title="GSignond API for writing platform adaptation extensions">
  10 <link rel="next" href="GSignondAccessControlManager.html" title="GSignondAccessControlManager">
  11 <meta name="generator" content="GTK-Doc V1.20 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
  16 <td width="100%" align="left" class="shortcuts">
  17 <a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
  18                   <a href="#GSignondExtension.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
  19                   <a href="#GSignondExtension.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
  20 </td>
  21 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
  22 <td><a accesskey="u" href="ch06.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  23 <td><a accesskey="p" href="ch06.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  24 <td><a accesskey="n" href="GSignondAccessControlManager.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
  25 </tr></table>
  26 <div class="refentry">
  27 <a name="GSignondExtension"></a><div class="titlepage"></div>
  28 <div class="refnamediv"><table width="100%"><tr>
  29 <td valign="top">
  30 <h2><span class="refentrytitle"><a name="GSignondExtension.top_of_page"></a>GSignondExtension</span></h2>
  31 <p>GSignondExtension — provides platform adaptation functionality</p>
  32 </td>
  33 <td class="gallery_image" valign="top" align="right"></td>
  34 </tr></table></div>
  35 <div class="refsect1">
  36 <a name="GSignondExtension.functions"></a><h2>Functions</h2>
  37 <div class="informaltable"><table width="100%" border="0">
  38 <colgroup>
  39 <col width="150px" class="functions_return">
  40 <col class="functions_name">
  41 </colgroup>
  42 <tbody>
  43 <tr>
  44 <td class="function_type">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
  45 </td>
  46 <td class="function_name">
  47 <a class="link" href="GSignondExtension.html#gsignond-extension-get-name" title="gsignond_extension_get_name ()">gsignond_extension_get_name</a> <span class="c_punctuation">()</span>
  48 </td>
  49 </tr>
  50 <tr>
  51 <td class="function_type">
  52 <span class="returnvalue">guint32</span>
  53 </td>
  54 <td class="function_name">
  55 <a class="link" href="GSignondExtension.html#gsignond-extension-get-version" title="gsignond_extension_get_version ()">gsignond_extension_get_version</a> <span class="c_punctuation">()</span>
  56 </td>
  57 </tr>
  58 <tr>
  59 <td class="function_type">
  60 <a class="link" href="GSignondStorageManager.html" title="GSignondStorageManager"><span class="returnvalue">GSignondStorageManager</span></a> *
  61 </td>
  62 <td class="function_name">
  63 <a class="link" href="GSignondExtension.html#gsignond-extension-get-storage-manager" title="gsignond_extension_get_storage_manager ()">gsignond_extension_get_storage_manager</a> <span class="c_punctuation">()</span>
  64 </td>
  65 </tr>
  66 <tr>
  67 <td class="function_type">
  68 <a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="returnvalue">GSignondSecretStorage</span></a> *
  69 </td>
  70 <td class="function_name">
  71 <a class="link" href="GSignondExtension.html#gsignond-extension-get-secret-storage" title="gsignond_extension_get_secret_storage ()">gsignond_extension_get_secret_storage</a> <span class="c_punctuation">()</span>
  72 </td>
  73 </tr>
  74 <tr>
  75 <td class="function_type">
  76 <a class="link" href="GSignondAccessControlManager.html" title="GSignondAccessControlManager"><span class="returnvalue">GSignondAccessControlManager</span></a> *
  77 </td>
  78 <td class="function_name">
  79 <a class="link" href="GSignondExtension.html#gsignond-extension-get-access-control-manager" title="gsignond_extension_get_access_control_manager ()">gsignond_extension_get_access_control_manager</a> <span class="c_punctuation">()</span>
  80 </td>
  81 </tr>
  82 </tbody>
  83 </table></div>
  84 </div>
  85 <div class="refsect1">
  86 <a name="GSignondExtension.object-hierarchy"></a><h2>Object Hierarchy</h2>
  87 <pre class="screen">    <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  88     <span class="lineart">╰──</span> GSignondExtension
  89 </pre>
  90 </div>
  91 <div class="refsect1">
  92 <a name="GSignondExtension.includes"></a><h2>Includes</h2>
  93 <pre class="synopsis">#include &lt;gsignond/gsignond-plugin-interface.h&gt;
  94 </pre>
  95 </div>
  96 <div class="refsect1">
  97 <a name="GSignondExtension.description"></a><h2>Description</h2>
  98 <p><a class="link" href="GSignondExtension.html" title="GSignondExtension"><span class="type">GSignondExtension</span></a> provides access to platform adaptation functionality. It
  99 contains getter methods for default implementations of <a class="link" href="GSignondAccessControlManager.html" title="GSignondAccessControlManager"><span class="type">GSignondAccessControlManager</span></a>,
 100 <a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> and <a class="link" href="GSignondStorageManager.html" title="GSignondStorageManager"><span class="type">GSignondStorageManager</span></a>.</p>
 101 <p>gSSO can be adapted to a specific platform environment by implementing a
 102 custom extension module. The following steps need to be taken:</p>
 103 <p>a) subclass and re-implement some (or all) of the functionality of the above
 104 three classes.</p>
 105 <p>b) subclass <a class="link" href="GSignondExtension.html" title="GSignondExtension"><span class="type">GSignondExtension</span></a> and provide implementations of its getter methods for those
 106 of the adaptation classes that have been changed.</p>
 107 <p>d) provide a function <code class="function">GSignondExtension * extensionname_extension_init(void)</code>
 108 that returns an instance of the <a class="link" href="GSignondExtension.html" title="GSignondExtension"><span class="type">GSignondExtension</span></a> subclass.</p>
 109 <p>c) build and install these implementations as a gSSO extension module and
 110 configure gSSO to use it.</p>
 111 <p>Examples of custom extensions can be seen here:</p>
 112 <a class="ulink" href="https://code.google.com/p/accounts-sso/source/browse/?repo=gsignond#git%2Fsrc%2Fextensions" target="_top">
 113 https://code.google.com/p/accounts-sso/source/browse/?repo=gsignond#git%2Fsrc%2Fextensions</a><p>and gSSO configuration is described in <a class="link" href="GSignondConfig.html" title="GSignondConfig"><span class="type">GSignondConfig</span></a>.</p>
 114 </div>
 115 <div class="refsect1">
 116 <a name="GSignondExtension.functions_details"></a><h2>Functions</h2>
 117 <div class="refsect2">
 118 <a name="gsignond-extension-get-name"></a><h3>gsignond_extension_get_name ()</h3>
 119 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 120 gsignond_extension_get_name (<em class="parameter"><code><a class="link" href="GSignondExtension.html" title="GSignondExtension"><span class="type">GSignondExtension</span></a> *self</code></em>);</pre>
 121 <p>Get a human readable name of the extension. Default implementation
 122 returns "default".</p>
 123 <div class="refsect3">
 124 <a name="id-1.7.2.7.2.5"></a><h4>Parameters</h4>
 125 <div class="informaltable"><table width="100%" border="0">
 126 <colgroup>
 127 <col width="150px" class="parameters_name">
 128 <col class="parameters_description">
 129 <col width="200px" class="parameters_annotations">
 130 </colgroup>
 131 <tbody><tr>
 132 <td class="parameter_name"><p>self</p></td>
 133 <td class="parameter_description"><p>object instance.</p></td>
 134 <td class="parameter_annotations"> </td>
 135 </tr></tbody>
 136 </table></div>
 137 </div>
 138 <div class="refsect3">
 139 <a name="id-1.7.2.7.2.6"></a><h4>Returns</h4>
 140 <p> name of the extension. </p>
 141 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 142 </div>
 143 </div>
 144 <hr>
 145 <div class="refsect2">
 146 <a name="gsignond-extension-get-version"></a><h3>gsignond_extension_get_version ()</h3>
 147 <pre class="programlisting"><span class="returnvalue">guint32</span>
 148 gsignond_extension_get_version (<em class="parameter"><code><a class="link" href="GSignondExtension.html" title="GSignondExtension"><span class="type">GSignondExtension</span></a> *self</code></em>);</pre>
 149 <p>Get version of the extension, split into four bytes in order from MSB to LSB;
 150 major, minor, patchlevel, build. Default implementation returns 0.</p>
 151 <div class="refsect3">
 152 <a name="id-1.7.2.7.3.5"></a><h4>Parameters</h4>
 153 <div class="informaltable"><table width="100%" border="0">
 154 <colgroup>
 155 <col width="150px" class="parameters_name">
 156 <col class="parameters_description">
 157 <col width="200px" class="parameters_annotations">
 158 </colgroup>
 159 <tbody><tr>
 160 <td class="parameter_name"><p>self</p></td>
 161 <td class="parameter_description"><p>object instance.</p></td>
 162 <td class="parameter_annotations"> </td>
 163 </tr></tbody>
 164 </table></div>
 165 </div>
 166 </div>
 167 <hr>
 168 <div class="refsect2">
 169 <a name="gsignond-extension-get-storage-manager"></a><h3>gsignond_extension_get_storage_manager ()</h3>
 170 <pre class="programlisting"><a class="link" href="GSignondStorageManager.html" title="GSignondStorageManager"><span class="returnvalue">GSignondStorageManager</span></a> *
 171 gsignond_extension_get_storage_manager
 172                                (<em class="parameter"><code><a class="link" href="GSignondExtension.html" title="GSignondExtension"><span class="type">GSignondExtension</span></a> *self</code></em>,
 173                                 <em class="parameter"><code><a class="link" href="GSignondConfig.html" title="GSignondConfig"><span class="type">GSignondConfig</span></a> *config</code></em>);</pre>
 174 <p>Factory method to get a singleton storage manager object. See
 175 <a class="link" href="GSignondStorageManager.html" title="GSignondStorageManager"><span class="type">GSignondStorageManager</span></a> for the description of the default implementation.</p>
 176 <div class="refsect3">
 177 <a name="id-1.7.2.7.4.5"></a><h4>Parameters</h4>
 178 <div class="informaltable"><table width="100%" border="0">
 179 <colgroup>
 180 <col width="150px" class="parameters_name">
 181 <col class="parameters_description">
 182 <col width="200px" class="parameters_annotations">
 183 </colgroup>
 184 <tbody>
 185 <tr>
 186 <td class="parameter_name"><p>self</p></td>
 187 <td class="parameter_description"><p>object instance.</p></td>
 188 <td class="parameter_annotations"> </td>
 189 </tr>
 190 <tr>
 191 <td class="parameter_name"><p>config</p></td>
 192 <td class="parameter_description"><p>configuration object instance.</p></td>
 193 <td class="parameter_annotations"> </td>
 194 </tr>
 195 </tbody>
 196 </table></div>
 197 </div>
 198 <div class="refsect3">
 199 <a name="id-1.7.2.7.4.6"></a><h4>Returns</h4>
 200 <p> storage manager object instance. </p>
 201 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 202 </div>
 203 </div>
 204 <hr>
 205 <div class="refsect2">
 206 <a name="gsignond-extension-get-secret-storage"></a><h3>gsignond_extension_get_secret_storage ()</h3>
 207 <pre class="programlisting"><a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="returnvalue">GSignondSecretStorage</span></a> *
 208 gsignond_extension_get_secret_storage (<em class="parameter"><code><a class="link" href="GSignondExtension.html" title="GSignondExtension"><span class="type">GSignondExtension</span></a> *self</code></em>,
 209                                        <em class="parameter"><code><a class="link" href="GSignondConfig.html" title="GSignondConfig"><span class="type">GSignondConfig</span></a> *config</code></em>);</pre>
 210 <p>Factory method to get a singleton secret storage object. See
 211 <a class="link" href="GSignondSecretStorage.html" title="GSignondSecretStorage"><span class="type">GSignondSecretStorage</span></a> for the description of the default implementation.</p>
 212 <div class="refsect3">
 213 <a name="id-1.7.2.7.5.5"></a><h4>Parameters</h4>
 214 <div class="informaltable"><table width="100%" border="0">
 215 <colgroup>
 216 <col width="150px" class="parameters_name">
 217 <col class="parameters_description">
 218 <col width="200px" class="parameters_annotations">
 219 </colgroup>
 220 <tbody>
 221 <tr>
 222 <td class="parameter_name"><p>self</p></td>
 223 <td class="parameter_description"><p>object instance.</p></td>
 224 <td class="parameter_annotations"> </td>
 225 </tr>
 226 <tr>
 227 <td class="parameter_name"><p>config</p></td>
 228 <td class="parameter_description"><p>configuration object instance.</p></td>
 229 <td class="parameter_annotations"> </td>
 230 </tr>
 231 </tbody>
 232 </table></div>
 233 </div>
 234 <div class="refsect3">
 235 <a name="id-1.7.2.7.5.6"></a><h4>Returns</h4>
 236 <p> secret storage object instance. </p>
 237 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 238 </div>
 239 </div>
 240 <hr>
 241 <div class="refsect2">
 242 <a name="gsignond-extension-get-access-control-manager"></a><h3>gsignond_extension_get_access_control_manager ()</h3>
 243 <pre class="programlisting"><a class="link" href="GSignondAccessControlManager.html" title="GSignondAccessControlManager"><span class="returnvalue">GSignondAccessControlManager</span></a> *
 244 gsignond_extension_get_access_control_manager
 245                                (<em class="parameter"><code><a class="link" href="GSignondExtension.html" title="GSignondExtension"><span class="type">GSignondExtension</span></a> *self</code></em>,
 246                                 <em class="parameter"><code><a class="link" href="GSignondConfig.html" title="GSignondConfig"><span class="type">GSignondConfig</span></a> *config</code></em>);</pre>
 247 <p>Factory method to get a singleton access control manager object. See
 248 <a class="link" href="GSignondAccessControlManager.html" title="GSignondAccessControlManager"><span class="type">GSignondAccessControlManager</span></a> for the description of the default implementation.</p>
 249 <div class="refsect3">
 250 <a name="id-1.7.2.7.6.5"></a><h4>Parameters</h4>
 251 <div class="informaltable"><table width="100%" border="0">
 252 <colgroup>
 253 <col width="150px" class="parameters_name">
 254 <col class="parameters_description">
 255 <col width="200px" class="parameters_annotations">
 256 </colgroup>
 257 <tbody>
 258 <tr>
 259 <td class="parameter_name"><p>self</p></td>
 260 <td class="parameter_description"><p>object instance.</p></td>
 261 <td class="parameter_annotations"> </td>
 262 </tr>
 263 <tr>
 264 <td class="parameter_name"><p>config</p></td>
 265 <td class="parameter_description"><p>configuration object instance.</p></td>
 266 <td class="parameter_annotations"> </td>
 267 </tr>
 268 </tbody>
 269 </table></div>
 270 </div>
 271 <div class="refsect3">
 272 <a name="id-1.7.2.7.6.6"></a><h4>Returns</h4>
 273 <p> access control manager object instance. </p>
 274 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 275 </div>
 276 </div>
 277 </div>
 278 <div class="refsect1">
 279 <a name="GSignondExtension.other_details"></a><h2>Types and Values</h2>
 280 </div>
 281 </div>
 282 <div class="footer">
 283 <hr>
 284           Generated by GTK-Doc V1.20</div>
 285 </body>
 286 </html>