<!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>QOAuth: src/interface.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="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">QOAuth
 <span id="projectnumber">1.0.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">interface.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"> * Copyright (C) 2009 by Dominik Kapusta <d@ayoy.net> *</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"> * This library is free software; you can redistribute it and/or modify *</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * it under the terms of the GNU Lesser General Public License as *</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * published by the Free Software Foundation; either version 2.1 of *</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * the License, or (at your option) any later version. *</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 distributed in the hope that it will be useful, *</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of *</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * Lesser General Public License for more details. *</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * *</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * You should have received a copy of the GNU Lesser General Public *</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * License along with this library; if not, write to *</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * the Free Software Foundation, Inc., *</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> ***************************************************************************/</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#ifndef INTERFACE_H</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#define INTERFACE_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> </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include <QtCrypto></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 "<a class="code" href="qoauth__global_8h.html">qoauth_global.h</a>"</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#include "<a class="code" href="qoauth__namespace_8h.html">qoauth_namespace.h</a>"</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">class </span>QNetworkAccessManager;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">class </span>QNetworkReply;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="namespace_q_o_auth.html"> 41</a></span> <span class="keyword">namespace </span><a class="code" href="namespace_q_o_auth.html">QOAuth</a> {</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">class </span>InterfacePrivate;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="class_q_o_auth_1_1_interface.html"> 45</a></span> <span class="keyword">class </span>QOAUTH_EXPORT <a class="code" href="class_q_o_auth_1_1_interface.html">Interface</a> : <span class="keyword">public</span> QObject</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> {</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  Q_OBJECT</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="class_q_o_auth_1_1_interface.html#ad808121c86dfd7901140b5031a28f417"> 49</a></span>  Q_PROPERTY( QByteArray consumerKey READ consumerKey WRITE setConsumerKey )</div><div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="class_q_o_auth_1_1_interface.html#aff55c5d184a11d34b0ce2e992bda3982"> 50</a></span>  Q_PROPERTY( QByteArray consumerSecret READ consumerSecret WRITE setConsumerSecret )</div><div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="class_q_o_auth_1_1_interface.html#a03241bf78e933ed564c9b4914357f000"> 51</a></span>  Q_PROPERTY( uint requestTimeout READ requestTimeout WRITE setRequestTimeout )</div><div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="class_q_o_auth_1_1_interface.html#a7b161f077467574766ca9f48ef167642"> 52</a></span>  Q_PROPERTY( <span class="keywordtype">bool</span> ignoreSslErrors READ ignoreSslErrors WRITE setIgnoreSslErrors )</div><div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="class_q_o_auth_1_1_interface.html#a99c6f33258eccdb3d6ea28e4944f94e9"> 53</a></span>  Q_PROPERTY( <span class="keywordtype">int</span> error READ error )</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> public:</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <a class="code" href="class_q_o_auth_1_1_interface.html">Interface</a>( QObject *parent = 0 );</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <a class="code" href="class_q_o_auth_1_1_interface.html">Interface</a>( QNetworkAccessManager *manager, QObject *parent = 0 );</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  virtual ~<a class="code" href="class_q_o_auth_1_1_interface.html">Interface</a>();</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  QNetworkAccessManager* networkAccessManager() const;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordtype">void</span> setNetworkAccessManager(QNetworkAccessManager *manager);</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordtype">bool</span> ignoreSslErrors() const;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordtype">void</span> setIgnoreSslErrors(<span class="keywordtype">bool</span> enabled);</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  QByteArray consumerKey() const;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordtype">void</span> setConsumerKey( const QByteArray &consumerKey );</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  QByteArray consumerSecret() const;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordtype">void</span> setConsumerSecret( const QByteArray &consumerSecret );</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>  uint requestTimeout() const;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keywordtype">void</span> setRequestTimeout( uint msec );</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordtype">int</span> error() const;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keywordtype">bool</span> setRSAPrivateKey( const QString &key,</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  const QCA::SecureArray &passphrase = QCA::SecureArray() );</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keywordtype">bool</span> setRSAPrivateKeyFromFile( const QString &filename,</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  const QCA::SecureArray &passphrase = QCA::SecureArray() );</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <a class="code" href="namespace_q_o_auth.html#a4a001535b7fdb06cc9d34cad1af27d2f">ParamMap</a> requestToken( const QString &requestUrl, <a class="code" href="namespace_q_o_auth.html#aa0e0bd4d8c1802873d3b3d2deb099319">HttpMethod</a> httpMethod,</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <a class="code" href="namespace_q_o_auth.html#a4cc48c641aa9025d289d7d7e013f766f">SignatureMethod</a> signatureMethod = <a class="code" href="namespace_q_o_auth.html#a4cc48c641aa9025d289d7d7e013f766fa74bc0d418aa61ebf3efc38282d6d22b0">HMAC_SHA1</a>, const <a class="code" href="namespace_q_o_auth.html#a4a001535b7fdb06cc9d34cad1af27d2f">ParamMap</a> &params = <a class="code" href="namespace_q_o_auth.html#a4a001535b7fdb06cc9d34cad1af27d2f">ParamMap</a>() );</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  ParamMap accessToken( const QString &requestUrl, <a class="code" href="namespace_q_o_auth.html#aa0e0bd4d8c1802873d3b3d2deb099319">HttpMethod</a> httpMethod, const QByteArray &token,</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  const QByteArray &tokenSecret, <a class="code" href="namespace_q_o_auth.html#a4cc48c641aa9025d289d7d7e013f766f">SignatureMethod</a> signatureMethod = HMAC_SHA1,</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  const ParamMap &params = ParamMap() );</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  QByteArray createParametersString( const QString &requestUrl, <a class="code" href="namespace_q_o_auth.html#aa0e0bd4d8c1802873d3b3d2deb099319">HttpMethod</a> httpMethod,</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  const QByteArray &token, const QByteArray &tokenSecret,</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <a class="code" href="namespace_q_o_auth.html#a4cc48c641aa9025d289d7d7e013f766f">SignatureMethod</a> signatureMethod, const ParamMap &params, <a class="code" href="namespace_q_o_auth.html#a442456118c9a45ac446554f17620def4">ParsingMode</a> mode );</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>  QByteArray inlineParameters( const ParamMap &params, <a class="code" href="namespace_q_o_auth.html#a442456118c9a45ac446554f17620def4">ParsingMode</a> mode = <a class="code" href="namespace_q_o_auth.html#a442456118c9a45ac446554f17620def4ad28f70298ea8c4c1bec8c9c27b0aeaf5">ParseForRequestContent</a> );</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> protected:</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  InterfacePrivate * const d_ptr;</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> private:</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  Q_DISABLE_COPY(Interface)</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  Q_DECLARE_PRIVATE(Interface)</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  Q_PRIVATE_SLOT(d_func(), <span class="keywordtype">void</span> _q_parseReply(QNetworkReply *reply))</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  Q_PRIVATE_SLOT(d_func(), <span class="keywordtype">void</span> _q_setPassphrase(<span class="keywordtype">int</span> <span class="keywordtype">id</span>, const QCA::Event &event))</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  Q_PRIVATE_SLOT(d_func(), <span class="keywordtype">void</span> _q_handleSslErrors( QNetworkReply *reply,</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  const QList<QSslError> &errors ))</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="preprocessor">#ifdef UNIT_TEST</span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="keyword">friend</span> <span class="keyword">class </span>Ut_Interface;</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keyword">friend</span> <span class="keyword">class </span>Ft_Interface;</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> };</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> </div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> } <span class="comment">// namespace QOAuth</span></div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> </div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="preprocessor">#endif // INTERFACE_H</span></div><div class="ttc" id="qoauth__global_8h_html"><div class="ttname"><a href="qoauth__global_8h.html">qoauth_global.h</a></div></div>
<div class="ttc" id="namespace_q_o_auth_html_a4cc48c641aa9025d289d7d7e013f766fa74bc0d418aa61ebf3efc38282d6d22b0"><div class="ttname"><a href="namespace_q_o_auth.html#a4cc48c641aa9025d289d7d7e013f766fa74bc0d418aa61ebf3efc38282d6d22b0">QOAuth::HMAC_SHA1</a></div><div class="ttdoc">Sets the signature method to HMAC-SHA1. </div><div class="ttdef"><b>Definition:</b> qoauth_namespace.h:60</div></div>
<div class="ttc" id="namespace_q_o_auth_html_a4cc48c641aa9025d289d7d7e013f766f"><div class="ttname"><a href="namespace_q_o_auth.html#a4cc48c641aa9025d289d7d7e013f766f">QOAuth::SignatureMethod</a></div><div class="ttdeci">SignatureMethod</div><div class="ttdoc">This enum type describes the signature method used by the request. </div><div class="ttdef"><b>Definition:</b> qoauth_namespace.h:59</div></div>
<div class="ttc" id="namespace_q_o_auth_html_a442456118c9a45ac446554f17620def4"><div class="ttname"><a href="namespace_q_o_auth.html#a442456118c9a45ac446554f17620def4">QOAuth::ParsingMode</a></div><div class="ttdeci">ParsingMode</div><div class="ttdoc">This enum type specifies the method of parsing parameters into a parameter string. </div><div class="ttdef"><b>Definition:</b> qoauth_namespace.h:106</div></div>
<div class="ttc" id="namespace_q_o_auth_html_a442456118c9a45ac446554f17620def4ad28f70298ea8c4c1bec8c9c27b0aeaf5"><div class="ttname"><a href="namespace_q_o_auth.html#a442456118c9a45ac446554f17620def4ad28f70298ea8c4c1bec8c9c27b0aeaf5">QOAuth::ParseForRequestContent</a></div><div class="ttdoc">Inline query format (foo=bar&bar=baz&baz=foo ...), suitable for POST requests. </div><div class="ttdef"><b>Definition:</b> qoauth_namespace.h:107</div></div>
<div class="ttc" id="qoauth__namespace_8h_html"><div class="ttname"><a href="qoauth__namespace_8h.html">qoauth_namespace.h</a></div></div>
<div class="ttc" id="namespace_q_o_auth_html"><div class="ttname"><a href="namespace_q_o_auth.html">QOAuth</a></div><div class="ttdoc">This namespace encapsulates all classes and definitions provided by libqoauth. </div><div class="ttdef"><b>Definition:</b> interface.h:41</div></div>
<div class="ttc" id="class_q_o_auth_1_1_interface_html"><div class="ttname"><a href="class_q_o_auth_1_1_interface.html">QOAuth::Interface</a></div><div class="ttdoc">This class provides means for interaction with network services supporting OAuth authorization scheme...</div><div class="ttdef"><b>Definition:</b> interface.h:45</div></div>
<div class="ttc" id="namespace_q_o_auth_html_aa0e0bd4d8c1802873d3b3d2deb099319"><div class="ttname"><a href="namespace_q_o_auth.html#aa0e0bd4d8c1802873d3b3d2deb099319">QOAuth::HttpMethod</a></div><div class="ttdeci">HttpMethod</div><div class="ttdoc">This enum type specifies the HTTP method used for creating a Signature Base String and/or sending a r...</div><div class="ttdef"><b>Definition:</b> qoauth_namespace.h:80</div></div>
<div class="ttc" id="namespace_q_o_auth_html_a4a001535b7fdb06cc9d34cad1af27d2f"><div class="ttname"><a href="namespace_q_o_auth.html#a4a001535b7fdb06cc9d34cad1af27d2f">QOAuth::ParamMap</a></div><div class="ttdeci">QMultiMap< QByteArray, QByteArray > ParamMap</div><div class="ttdoc">A typedef for the data structure for storing request parameters. </div><div class="ttdef"><b>Definition:</b> qoauth_namespace.h:46</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.12
</small></address>
</body>
</html>
