<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qauthenticator.cpp -->
<title>Qt 4.8: QAuthenticator Class Reference</title>
<link rel="stylesheet" type="text/css" href="style/style.css" />
<script src="scripts/jquery.js" type="text/javascript"></script>
<script src="scripts/functions.js" type="text/javascript"></script>
<link rel="stylesheet" type="text/css" href="style/superfish.css" />
<link rel="stylesheet" type="text/css" href="style/narrow.css" />
<!--[if IE]>
<meta name="MSSmartTagsPreventParsing" content="true">
<meta http-equiv="imagetoolbar" content="no">
<![endif]-->
<!--[if lt IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie6.css">
<![endif]-->
<!--[if IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie7.css">
<![endif]-->
<!--[if IE 8]>
<link rel="stylesheet" type="text/css" href="style/style_ie8.css">
<![endif]-->
<script src="scripts/superfish.js" type="text/javascript"></script>
<script src="scripts/narrow.js" type="text/javascript"></script>
</head>
<body class="" onload="CheckEmptyAndLoadList();">
<div class="header" id="qtdocheader">
<div class="content">
<div id="nav-logo">
<a href="index.html">Home</a></div>
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
<div id="narrowsearch"></div>
<div id="nav-topright">
<ul>
<li class="nav-topright-home"><a href="http://qt.digia.com/">Qt HOME</a></li>
<li class="nav-topright-dev"><a href="http://qt-project.org/">DEV</a></li>
<li class="nav-topright-doc nav-topright-doc-active"><a href="http://qt-project.org/doc/">
DOC</a></li>
<li class="nav-topright-blog"><a href="http://blog.qt.digia.com/">BLOG</a></li>
</ul>
</div>
<div id="shortCut">
<ul>
<li class="shortCut-topleft-inactive"><span><a href="index.html">Qt 4.8</a></span></li>
<li class="shortCut-topleft-active"><a href="http://qt-project.org/doc/">ALL VERSIONS </a></li>
</ul>
</div>
<ul class="sf-menu" id="narrowmenu">
<li><a href="#">API Lookup</a>
<ul>
<li><a href="classes.html">Class index</a></li>
<li><a href="functions.html">Function index</a></li>
<li><a href="modules.html">Modules</a></li>
<li><a href="namespaces.html">Namespaces</a></li>
<li><a href="qtglobal.html">Global Declarations</a></li>
<li><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</li>
<li><a href="#">Qt Topics</a>
<ul>
<li><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li><a href="supported-platforms.html">Supported Platforms</a></li>
<li><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</li>
<li><a href="#">Examples</a>
<ul>
<li><a href="all-examples.html">Examples</a></li>
<li><a href="tutorials.html">Tutorials</a></li>
<li><a href="demos.html">Demos</a></li>
<li><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="wrapper">
<div class="hd">
<span></span>
</div>
<div class="bd group">
<div class="sidebar">
<div class="searchlabel">
Search index:</div>
<div class="search" id="sidebarsearch">
<form id="qtdocsearch" action="" onsubmit="return false;">
<fieldset>
<input type="text" name="searchstring" id="pageType" value="" />
<div id="resultdialog">
<a href="#" id="resultclose">Close</a>
<p id="resultlinks" class="all"><a href="#" id="showallresults">All</a> | <a href="#" id="showapiresults">API</a> | <a href="#" id="showarticleresults">Articles</a> | <a href="#" id="showexampleresults">Examples</a></p>
<p id="searchcount" class="all"><span id="resultcount"></span><span id="apicount"></span><span id="articlecount"></span><span id="examplecount"></span> results:</p>
<ul id="resultlist" class="all">
</ul>
</div>
</fieldset>
</form>
</div>
<div class="box first bottombar" id="lookup">
<h2 title="API Lookup"><span></span>
API Lookup</h2>
<div id="list001" class="list">
<ul id="ul001" >
<li class="defaultLink"><a href="classes.html">Class index</a></li>
<li class="defaultLink"><a href="functions.html">Function index</a></li>
<li class="defaultLink"><a href="modules.html">Modules</a></li>
<li class="defaultLink"><a href="namespaces.html">Namespaces</a></li>
<li class="defaultLink"><a href="qtglobal.html">Global Declarations</a></li>
<li class="defaultLink"><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</div>
</div>
<div class="box bottombar" id="topics">
<h2 title="Qt Topics"><span></span>
Qt Topics</h2>
<div id="list002" class="list">
<ul id="ul002" >
<li class="defaultLink"><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li class="defaultLink"><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li class="defaultLink"><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li class="defaultLink"><a href="supported-platforms.html">Supported Platforms</a></li>
<li class="defaultLink"><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li class="defaultLink"><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</div>
</div>
<div class="box" id="examples">
<h2 title="Examples"><span></span>
Examples</h2>
<div id="list003" class="list">
<ul id="ul003">
<li class="defaultLink"><a href="all-examples.html">Examples</a></li>
<li class="defaultLink"><a href="tutorials.html">Tutorials</a></li>
<li class="defaultLink"><a href="demos.html">Demos</a></li>
<li class="defaultLink"><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</div>
</div>
</div>
<div class="wrap">
<div class="toolbar">
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtnetwork.html">QtNetwork</a></li>
<li>QAuthenticator</li>
</ul>
</div>
<div class="toolbuttons toolblock">
<ul>
<li id="smallA" class="t_button">A</li>
<li id="medA" class="t_button active">A</li>
<li id="bigA" class="t_button">A</li>
<li id="print" class="t_button"><a href="javascript:this.print();">
<span>Print</span></a></li>
</ul>
</div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
<li class="level2"><a href="#options">Options</a></li>
<li class="level3"><a href="#basic">Basic</a></li>
<li class="level3"><a href="#ntlm-version-2">NTLM version 2</a></li>
<li class="level3"><a href="#digest-md5">Digest-MD5</a></li>
</ul>
</div>
<h1 class="title">QAuthenticator Class Reference</h1>
<!-- $$$QAuthenticator-brief -->
<p>The QAuthenticator class provides an authentication object. <a href="#details">More...</a></p>
<!-- @@@QAuthenticator -->
<pre class="cpp"> <span class="preprocessor">#include <QAuthenticator></span></pre><p><b>Note:</b> All functions in this class are <a href="threads-reentrancy.html#reentrant">reentrant</a>.</p>
<p>This class was introduced in Qt 4.3.</p>
<ul>
<li><a href="qauthenticator-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qauthenticator.html#QAuthenticator">QAuthenticator</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qauthenticator.html#QAuthenticator-2">QAuthenticator</a></b> ( const QAuthenticator & <i>other</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qauthenticator.html#dtor.QAuthenticator">~QAuthenticator</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qauthenticator.html#isNull">isNull</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QVariant </td><td class="memItemRight bottomAlign"><b><a href="qauthenticator.html#option">option</a></b> ( const QString & <i>opt</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QVariantHash </td><td class="memItemRight bottomAlign"><b><a href="qauthenticator.html#options">options</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qauthenticator.html#password">password</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qauthenticator.html#realm">realm</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qauthenticator.html#setOption">setOption</a></b> ( const QString & <i>opt</i>, const QVariant & <i>value</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qauthenticator.html#setPassword">setPassword</a></b> ( const QString & <i>password</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qauthenticator.html#setUser">setUser</a></b> ( const QString & <i>user</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qauthenticator.html#user">user</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qauthenticator.html#operator-not-eq">operator!=</a></b> ( const QAuthenticator & <i>other</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QAuthenticator & </td><td class="memItemRight bottomAlign"><b><a href="qauthenticator.html#operator-eq">operator=</a></b> ( const QAuthenticator & <i>other</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qauthenticator.html#operator-eq-eq">operator==</a></b> ( const QAuthenticator & <i>other</i> ) const</td></tr>
</table>
<a name="details"></a>
<!-- $$$QAuthenticator-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QAuthenticator class provides an authentication object.</p>
<p>The QAuthenticator class is usually used in the <a href="qnetworkaccessmanager.html#authenticationRequired">authenticationRequired()</a> and <a href="qnetworkaccessmanager.html#proxyAuthenticationRequired">proxyAuthenticationRequired()</a> signals of <a href="qnetworkaccessmanager.html">QNetworkAccessManager</a> and <a href="qabstractsocket.html">QAbstractSocket</a>. The class provides a way to pass back the required authentication information to the socket when accessing services that require authentication.</p>
<p>QAuthenticator supports the following authentication methods:</p>
<ul>
<li>Basic</li>
<li>NTLM version 2</li>
<li>Digest-MD5</li>
</ul>
<a name="options"></a>
<h3>Options</h3>
<p>In addition to the username and password required for authentication, a QAuthenticator object can also contain additional options. The <a href="qauthenticator.html#options">options</a>() function can be used to query incoming options sent by the server; the <a href="qauthenticator.html#setOption">setOption</a>() function can be used to set outgoing options, to be processed by the authenticator calculation. The options accepted and provided depend on the authentication type (see method()).</p>
<p>The following tables list known incoming options as well as accepted outgoing options. The list of incoming options is not exhaustive, since servers may include additional information at any time. The list of outgoing options is exhaustive, however, and no unknown options will be treated or sent back to the server.</p>
<a name="basic"></a>
<h4>Basic</h4>
<table class="generic">
<thead><tr class="qt-style"><th >Option</th><th >Direction</th><th >Description</th></tr></thead>
<tr valign="top" class="odd"><td ><tt>realm</tt></td><td >Incoming</td><td >Contains the realm of the authentication, the same as <a href="qauthenticator.html#realm">realm</a>()</td></tr>
</table>
<p>The Basic authentication mechanism supports no outgoing options.</p>
<a name="ntlm-version-2"></a>
<h4>NTLM version 2</h4>
<p>The NTLM authentication mechanism currently supports no incoming or outgoing options.</p>
<a name="digest-md5"></a>
<h4>Digest-MD5</h4>
<table class="generic">
<thead><tr class="qt-style"><th >Option</th><th >Direction</th><th >Description</th></tr></thead>
<tr valign="top" class="odd"><td ><tt>realm</tt></td><td >Incoming</td><td >Contains the realm of the authentication, the same as <a href="qauthenticator.html#realm">realm</a>()</td></tr>
</table>
<p>The Digest-MD5 authentication mechanism supports no outgoing options.</p>
</div>
<p><b>See also </b><a href="qsslsocket.html">QSslSocket</a>.</p>
<!-- @@@QAuthenticator -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QAuthenticator[overload1]$$$QAuthenticator -->
<h3 class="fn"><a name="QAuthenticator"></a>QAuthenticator::<span class="name">QAuthenticator</span> ()</h3>
<p>Constructs an empty authentication object</p>
<!-- @@@QAuthenticator -->
<!-- $$$QAuthenticator$$$QAuthenticatorconstQAuthenticator& -->
<h3 class="fn"><a name="QAuthenticator-2"></a>QAuthenticator::<span class="name">QAuthenticator</span> ( const <span class="type">QAuthenticator</span> & <i>other</i> )</h3>
<p>Constructs a copy of <i>other</i>.</p>
<!-- @@@QAuthenticator -->
<!-- $$$~QAuthenticator[overload1]$$$~QAuthenticator -->
<h3 class="fn"><a name="dtor.QAuthenticator"></a>QAuthenticator::<span class="name">~QAuthenticator</span> ()</h3>
<p>Destructs the object</p>
<!-- @@@~QAuthenticator -->
<!-- $$$isNull[overload1]$$$isNull -->
<h3 class="fn"><a name="isNull"></a><span class="type">bool</span> QAuthenticator::<span class="name">isNull</span> () const</h3>
<p>Returns true if the authenticator is null.</p>
<!-- @@@isNull -->
<!-- $$$option[overload1]$$$optionconstQString& -->
<h3 class="fn"><a name="option"></a><span class="type"><a href="qvariant.html">QVariant</a></span> QAuthenticator::<span class="name">option</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>opt</i> ) const</h3>
<p>Returns the value related to option <i>opt</i> if it was set by the server. See <a href="qauthenticator.html#options">QAuthenticator#Options</a> for more information on incoming options. If option <i>opt</i> isn't found, an invalid <a href="qvariant.html">QVariant</a> will be returned.</p>
<p>This function was introduced in Qt 4.7.</p>
<p><b>See also </b><a href="qauthenticator.html#setOption">setOption</a>(), <a href="qauthenticator.html#options">options</a>(), and <a href="qauthenticator.html#options">QAuthenticator#Options</a>.</p>
<!-- @@@option -->
<!-- $$$options[overload1]$$$options -->
<h3 class="fn"><a name="options"></a><span class="type"><a href="qvariant.html#QVariantHash-typedef">QVariantHash</a></span> QAuthenticator::<span class="name">options</span> () const</h3>
<p>Returns all incoming options set in this <a href="qauthenticator.html">QAuthenticator</a> object by parsing the server reply. See <a href="qauthenticator.html#options">QAuthenticator#Options</a> for more information on incoming options.</p>
<p>This function was introduced in Qt 4.7.</p>
<p><b>See also </b><a href="qauthenticator.html#option">option</a>() and <a href="qauthenticator.html#options">QAuthenticator#Options</a>.</p>
<!-- @@@options -->
<!-- $$$password[overload1]$$$password -->
<h3 class="fn"><a name="password"></a><span class="type"><a href="qstring.html">QString</a></span> QAuthenticator::<span class="name">password</span> () const</h3>
<p>returns the password used for authentication.</p>
<p><b>See also </b><a href="qauthenticator.html#setPassword">setPassword</a>().</p>
<!-- @@@password -->
<!-- $$$realm[overload1]$$$realm -->
<h3 class="fn"><a name="realm"></a><span class="type"><a href="qstring.html">QString</a></span> QAuthenticator::<span class="name">realm</span> () const</h3>
<p>returns the realm requiring authentication.</p>
<!-- @@@realm -->
<!-- $$$setOption[overload1]$$$setOptionconstQString&constQVariant& -->
<h3 class="fn"><a name="setOption"></a><span class="type">void</span> QAuthenticator::<span class="name">setOption</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>opt</i>, const <span class="type"><a href="qvariant.html">QVariant</a></span> & <i>value</i> )</h3>
<p>Sets the outgoing option <i>opt</i> to value <i>value</i>. See <a href="qauthenticator.html#options">QAuthenticator#Options</a> for more information on outgoing options.</p>
<p>This function was introduced in Qt 4.7.</p>
<p><b>See also </b><a href="qauthenticator.html#options">options</a>(), <a href="qauthenticator.html#option">option</a>(), and <a href="qauthenticator.html#options">QAuthenticator#Options</a>.</p>
<!-- @@@setOption -->
<!-- $$$setPassword[overload1]$$$setPasswordconstQString& -->
<h3 class="fn"><a name="setPassword"></a><span class="type">void</span> QAuthenticator::<span class="name">setPassword</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>password</i> )</h3>
<p>Sets the <i>password</i> used for authentication.</p>
<p><b>See also </b><a href="qauthenticator.html#password">password</a>().</p>
<!-- @@@setPassword -->
<!-- $$$setUser[overload1]$$$setUserconstQString& -->
<h3 class="fn"><a name="setUser"></a><span class="type">void</span> QAuthenticator::<span class="name">setUser</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>user</i> )</h3>
<p>Sets the <i>user</i> used for authentication.</p>
<p><b>See also </b><a href="qauthenticator.html#user">user</a>().</p>
<!-- @@@setUser -->
<!-- $$$user[overload1]$$$user -->
<h3 class="fn"><a name="user"></a><span class="type"><a href="qstring.html">QString</a></span> QAuthenticator::<span class="name">user</span> () const</h3>
<p>returns the user used for authentication.</p>
<p><b>See also </b><a href="qauthenticator.html#setUser">setUser</a>().</p>
<!-- @@@user -->
<!-- $$$operator!=[overload1]$$$operator!=constQAuthenticator& -->
<h3 class="fn"><a name="operator-not-eq"></a><span class="type">bool</span> QAuthenticator::<span class="name">operator!=</span> ( const <span class="type">QAuthenticator</span> & <i>other</i> ) const</h3>
<p>Returns true if this authenticator is different from <i>other</i>; otherwise returns false.</p>
<!-- @@@operator!= -->
<!-- $$$operator=[overload1]$$$operator=constQAuthenticator& -->
<h3 class="fn"><a name="operator-eq"></a><span class="type">QAuthenticator</span> & QAuthenticator::<span class="name">operator=</span> ( const <span class="type">QAuthenticator</span> & <i>other</i> )</h3>
<p>Assigns the contents of <i>other</i> to this authenticator.</p>
<!-- @@@operator= -->
<!-- $$$operator==[overload1]$$$operator==constQAuthenticator& -->
<h3 class="fn"><a name="operator-eq-eq"></a><span class="type">bool</span> QAuthenticator::<span class="name">operator==</span> ( const <span class="type">QAuthenticator</span> & <i>other</i> ) const</h3>
<p>Returns true if this authenticator is identical to <i>other</i>; otherwise returns false.</p>
<!-- @@@operator== -->
</div>
</div>
</div>
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2013 Digia Plc and/or its
subsidiaries. Documentation contributions included herein are the copyrights of
their respective owners.</p>
<br />
<p>
The documentation provided herein is licensed under the terms of the
<a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation
License version 1.3</a> as published by the Free Software Foundation.</p>
<p>
Documentation sources may be obtained from <a href="http://www.qt-project.org">
www.qt-project.org</a>.</p>
<br />
<p>
Digia, Qt and their respective logos are trademarks of Digia Plc
in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. <a title="Privacy Policy"
href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
<script src="scripts/functions.js" type="text/javascript"></script>
</body>
</html>
