/usr/share/doc/libsignon-qt/html/authservice_8h_source.html is in libsignon-qt-doc 8.59-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>authservice.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('authservice_8h_source.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">authservice.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * This file is part of signon</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * Copyright (C) 2009-2010 Nokia Corporation.</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * Copyright (C) 2012-2016 Canonical Ltd.</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> *</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * Contact: Alberto Mardegan <alberto.mardegan@canonical.com></span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> *</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * This library is free software; you can redistribute it and/or</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * modify it under the terms of the GNU Lesser General Public License</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * version 2.1 as published by the Free Software Foundation.</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> *</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * This library is distributed in the hope that it will be useful, but</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * Lesser General Public License for more details.</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> *</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * You should have received a copy of the GNU Lesser General Public</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * License along with this library; if not, write to the Free Software</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * 02110-1301 USA</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> */</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#ifndef AUTHSERVICE_H</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#define AUTHSERVICE_H</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include <QObject></span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include <QStringList></span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include <QMap></span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#include "libsignoncommon.h"</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#include "identityinfo.h"</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#include "signonerror.h"</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">namespace </span><a class="code" href="namespaceSignOn.html">SignOn</a> {</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="classSignOn_1_1AuthService.html"> 49</a></span> <span class="keyword">class </span>SIGNON_EXPORT <a class="code" href="classSignOn_1_1AuthService.html">AuthService</a>: <span class="keyword">public</span> QObject</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> {</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  Q_OBJECT</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  Q_DISABLE_COPY(<a class="code" href="classSignOn_1_1AuthService.html">AuthService</a>)</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">friend</span> <span class="keyword">class </span>AuthServiceImpl;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="classSignOn_1_1AuthService.html#a95926b7896f59c4b95dd0d761283e674"> 62</a></span>  <span class="keyword">enum</span> <a class="code" href="classSignOn_1_1AuthService.html#a95926b7896f59c4b95dd0d761283e674">ServiceError</a> {</div><div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="classSignOn_1_1AuthService.html#a95926b7896f59c4b95dd0d761283e674a061c94a1bda6a9dc52f3db06416f8ea4"> 63</a></span>  UnknownError = 1, </div><div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="classSignOn_1_1AuthService.html#a95926b7896f59c4b95dd0d761283e674ad9b74db38dcc0d46704ac1744ab5d376"> 64</a></span>  InternalServerError = 2, </div><div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="classSignOn_1_1AuthService.html#a95926b7896f59c4b95dd0d761283e674a8ee12cca21786aef26458a5d97fa6443"> 65</a></span>  InternalCommunicationError = 3, </div><div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="classSignOn_1_1AuthService.html#a95926b7896f59c4b95dd0d761283e674a7706acb68a8a28407081be4f95fb0fa7"> 66</a></span>  PermissionDeniedError = 4, </div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  AuthServiceErr = 100, <span class="comment">/* Placeholder to rearrange enumeration */</span></div><div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="classSignOn_1_1AuthService.html#a95926b7896f59c4b95dd0d761283e674a615eccb98ad8bc91f732c9301a8f8478"> 68</a></span>  <a class="code" href="classSignOn_1_1AuthService.html#a95926b7896f59c4b95dd0d761283e674a615eccb98ad8bc91f732c9301a8f8478">MethodNotKnownError</a>, </div><div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="classSignOn_1_1AuthService.html#a95926b7896f59c4b95dd0d761283e674a23340e9d74be43a5294910ac883e1c1c"> 69</a></span>  <a class="code" href="classSignOn_1_1AuthService.html#a95926b7896f59c4b95dd0d761283e674a23340e9d74be43a5294910ac883e1c1c">NotAvailableError</a>, </div><div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="classSignOn_1_1AuthService.html#a95926b7896f59c4b95dd0d761283e674a52d38ac87577622827a731c9df88b957"> 70</a></span>  InvalidQueryError </div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  };</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div><div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="classSignOn_1_1AuthService.html#ad9ac832e70cb6251375e9947d558d2b5"> 78</a></span>  <span class="keyword">typedef</span> <span class="keyword">enum</span> {</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  AuthMethod = 0,</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  Username,</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  Realm,</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  Caption</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  } <a class="code" href="classSignOn_1_1AuthService.html#ad9ac832e70cb6251375e9947d558d2b5">IdentityFilterCriteria</a>;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div><div class="line"><a name="l00092"></a><span class="lineno"><a class="line" href="classSignOn_1_1AuthService_1_1IdentityRegExp.html"> 92</a></span>  <span class="keyword">class </span><a class="code" href="classSignOn_1_1AuthService_1_1IdentityRegExp.html">IdentityRegExp</a></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  {</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <a class="code" href="classSignOn_1_1AuthService_1_1IdentityRegExp.html">IdentityRegExp</a>(<span class="keyword">const</span> QString &pattern);</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <a class="code" href="classSignOn_1_1AuthService_1_1IdentityRegExp.html">IdentityRegExp</a>(<span class="keyword">const</span> <a class="code" href="classSignOn_1_1AuthService_1_1IdentityRegExp.html">IdentityRegExp</a> &src);</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> </div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keywordtype">bool</span> isValid() <span class="keyword">const</span>;</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  QString pattern() <span class="keyword">const</span>;</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> </div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  QString m_pattern;</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  };</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> </div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00128"></a><span class="lineno"><a class="line" href="classSignOn_1_1AuthService.html#a3acba53f72b72ef9b08ea8a4d49dd344"> 128</a></span>  <span class="keyword">typedef</span> QMap<IdentityFilterCriteria, IdentityRegExp> <a class="code" href="classSignOn_1_1AuthService.html#a3acba53f72b72ef9b08ea8a4d49dd344">IdentityFilter</a>;</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> </div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <a class="code" href="classSignOn_1_1AuthService.html">AuthService</a>(QObject *parent = 0);</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> </div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  ~<a class="code" href="classSignOn_1_1AuthService.html">AuthService</a>();</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> </div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  <span class="keywordtype">void</span> queryMethods();</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> </div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  <span class="keywordtype">void</span> queryMechanisms(<span class="keyword">const</span> QString &method);</div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span> </div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  <span class="keywordtype">void</span> queryIdentities(<span class="keyword">const</span> IdentityFilter &filter = IdentityFilter());</div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span> </div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  <span class="keywordtype">void</span> clear();</div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span> </div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span> Q_SIGNALS:</div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span> </div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span>  <span class="keywordtype">void</span> error(<span class="keyword">const</span> <a class="code" href="classSignOn_1_1Error.html">SignOn::Error</a> &err);</div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span> </div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span>  <span class="keywordtype">void</span> methodsAvailable(<span class="keyword">const</span> QStringList &methods);</div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span> </div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span>  <span class="keywordtype">void</span> mechanismsAvailable(<span class="keyword">const</span> QString &method, <span class="keyword">const</span> QStringList &mechanisms);</div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span> </div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span>  <span class="keywordtype">void</span> identities(<span class="keyword">const</span> QList<SignOn::IdentityInfo> &identityList);</div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span> </div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span>  <span class="keywordtype">void</span> cleared();</div><div class="line"><a name="l00242"></a><span class="lineno"> 242</span> </div><div class="line"><a name="l00243"></a><span class="lineno"> 243</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00244"></a><span class="lineno"> 244</span>  <span class="keyword">class </span>AuthServiceImpl *impl;</div><div class="line"><a name="l00245"></a><span class="lineno"> 245</span> };</div><div class="line"><a name="l00246"></a><span class="lineno"> 246</span> </div><div class="line"><a name="l00247"></a><span class="lineno"> 247</span> } <span class="comment">// namespace SignOn</span></div><div class="line"><a name="l00248"></a><span class="lineno"> 248</span> </div><div class="line"><a name="l00249"></a><span class="lineno"> 249</span> <span class="preprocessor">#endif // AUTHSERVICE_H</span></div><div class="ttc" id="classSignOn_1_1AuthService_html_a95926b7896f59c4b95dd0d761283e674a23340e9d74be43a5294910ac883e1c1c"><div class="ttname"><a href="classSignOn_1_1AuthService.html#a95926b7896f59c4b95dd0d761283e674a23340e9d74be43a5294910ac883e1c1c">SignOn::AuthService::NotAvailableError</a></div><div class="ttdef"><b>Definition:</b> <a href="authservice_8h_source.html#l00069">authservice.h:69</a></div></div>
<div class="ttc" id="classSignOn_1_1AuthService_html_ad9ac832e70cb6251375e9947d558d2b5"><div class="ttname"><a href="classSignOn_1_1AuthService.html#ad9ac832e70cb6251375e9947d558d2b5">SignOn::AuthService::IdentityFilterCriteria</a></div><div class="ttdeci">IdentityFilterCriteria</div><div class="ttdoc">Criterias for idetity query filtering. </div><div class="ttdef"><b>Definition:</b> <a href="authservice_8h_source.html#l00078">authservice.h:78</a></div></div>
<div class="ttc" id="classSignOn_1_1AuthService_html"><div class="ttname"><a href="classSignOn_1_1AuthService.html">SignOn::AuthService</a></div><div class="ttdoc">Represents signon for client application. </div><div class="ttdef"><b>Definition:</b> <a href="authservice_8h_source.html#l00049">authservice.h:49</a></div></div>
<div class="ttc" id="classSignOn_1_1AuthService_html_a95926b7896f59c4b95dd0d761283e674a615eccb98ad8bc91f732c9301a8f8478"><div class="ttname"><a href="classSignOn_1_1AuthService.html#a95926b7896f59c4b95dd0d761283e674a615eccb98ad8bc91f732c9301a8f8478">SignOn::AuthService::MethodNotKnownError</a></div><div class="ttdef"><b>Definition:</b> <a href="authservice_8h_source.html#l00068">authservice.h:68</a></div></div>
<div class="ttc" id="classSignOn_1_1AuthService_html_a95926b7896f59c4b95dd0d761283e674"><div class="ttname"><a href="classSignOn_1_1AuthService.html#a95926b7896f59c4b95dd0d761283e674">SignOn::AuthService::ServiceError</a></div><div class="ttdeci">ServiceError</div><div class="ttdoc">Codes for errors that may be reported by AuthService objects. </div><div class="ttdef"><b>Definition:</b> <a href="authservice_8h_source.html#l00062">authservice.h:62</a></div></div>
<div class="ttc" id="classSignOn_1_1AuthService_1_1IdentityRegExp_html"><div class="ttname"><a href="classSignOn_1_1AuthService_1_1IdentityRegExp.html">SignOn::AuthService::IdentityRegExp</a></div><div class="ttdoc">The class represents a regular expression. </div><div class="ttdef"><b>Definition:</b> <a href="authservice_8h_source.html#l00092">authservice.h:92</a></div></div>
<div class="ttc" id="namespaceSignOn_html"><div class="ttname"><a href="namespaceSignOn.html">SignOn</a></div><div class="ttdef"><b>Definition:</b> <a href="async-dbus-proxy_8cpp_source.html#l00041">async-dbus-proxy.cpp:41</a></div></div>
<div class="ttc" id="classSignOn_1_1Error_html"><div class="ttname"><a href="classSignOn_1_1Error.html">SignOn::Error</a></div><div class="ttdoc">definition for Signon error handling. </div><div class="ttdef"><b>Definition:</b> <a href="signonerror_8h_source.html#l00049">signonerror.h:49</a></div></div>
<div class="ttc" id="classSignOn_1_1AuthService_html_a3acba53f72b72ef9b08ea8a4d49dd344"><div class="ttname"><a href="classSignOn_1_1AuthService.html#a3acba53f72b72ef9b08ea8a4d49dd344">SignOn::AuthService::IdentityFilter</a></div><div class="ttdeci">QMap< IdentityFilterCriteria, IdentityRegExp > IdentityFilter</div><div class="ttdoc">Map to hold different filtering options. </div><div class="ttdef"><b>Definition:</b> <a href="authservice_8h_source.html#l00128">authservice.h:128</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><b>authservice.h</b></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.12 </li>
</ul>
</div>
</body>
</html>
|