File: Poco.Net.HTTPBasicCredentials.html

package info (click to toggle)
poco-doc 1.3.6-1
  • links: PTS
  • area: main
  • in suites: buster, jessie, jessie-kfreebsd, squeeze, stretch, wheezy
  • size: 10,076 kB
  • ctags: 9,611
  • sloc: makefile: 31
file content (90 lines) | stat: -rw-r--r-- 6,107 bytes parent folder | download | duplicates (2)
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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
<!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>
<title>Class Poco::Net::HTTPBasicCredentials</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
<meta name="author" content="Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="publisher" content="Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="copyright" content="Copyright (c) 2009, Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="language" content="en"/>
<meta name="date" content="2009-11-24"/>
<meta name="generator" content="PocoDoc"/>
<link rel="stylesheet" href="css/styles.css" type="text/css"/>
</head>
<body bgcolor="#ffffff" leftmargin="0" topmargin="0">
<div class="header">
<h1 class="namespace"><a href="Poco.Net.html" class="namespace">Poco::Net</a></h1>
<h1 class="symbol">class HTTPBasicCredentials</h1>
</div>
<div class="body">
<p>
<b>Library:</b> Net<br />
<b>Package:</b> HTTP<br />
<b>Header:</b> Poco/Net/HTTPBasicCredentials.h</p>
<h2>Description</h2>
<div class="description">
<p>This is a utility class for working with HTTP Basic Authentication in <a href="Poco.Net.HTTPRequest.html" title="class Poco::Net::HTTPRequest">HTTPRequest</a> objects. </p>
</div>
<h2>Member Summary</h2>
<p><b>Member Functions: </b><a href="Poco.Net.HTTPBasicCredentials.html#12488" title="Poco::Net::HTTPBasicCredentials::authenticate()">authenticate</a>, <a href="Poco.Net.HTTPBasicCredentials.html#12487" title="Poco::Net::HTTPBasicCredentials::getPassword()">getPassword</a>, <a href="Poco.Net.HTTPBasicCredentials.html#12484" title="Poco::Net::HTTPBasicCredentials::getUsername()">getUsername</a>, <a href="Poco.Net.HTTPBasicCredentials.html#12485" title="Poco::Net::HTTPBasicCredentials::setPassword()">setPassword</a>, <a href="Poco.Net.HTTPBasicCredentials.html#12482" title="Poco::Net::HTTPBasicCredentials::setUsername()">setUsername</a></p>
<h2>Constructors</h2>
<h3><a name="12475">HTTPBasicCredentials</a></h3>
<p class="decl"><a href="Poco.Net.HTTPBasicCredentials.html" title="class Poco::Net::HTTPBasicCredentials">HTTPBasicCredentials</a>();</p>
<div class="description">
<p>Creates an empty <a href="Poco.Net.HTTPBasicCredentials.html" title="class Poco::Net::HTTPBasicCredentials">HTTPBasicCredentials</a> object. </p>
</div>
<h3><a name="12479">HTTPBasicCredentials</a></h3>
<p class="decl">explicit <a href="Poco.Net.HTTPBasicCredentials.html" title="class Poco::Net::HTTPBasicCredentials">HTTPBasicCredentials</a>(<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.Net.HTTPRequest.html" title="class Poco::Net::HTTPRequest">HTTPRequest</a> &amp; request<br />);</p>
<div class="description">
<p>Creates a <a href="Poco.Net.HTTPBasicCredentials.html" title="class Poco::Net::HTTPBasicCredentials">HTTPBasicCredentials</a> object with the authentication information from the given request. </p>
<p>Throws a <a href="Poco.Net.NotAuthenticatedException.html" title="class Poco::Net::NotAuthenticatedException">NotAuthenticatedException</a> if the request does not contain basic authentication information. </p>
</div>
<h3><a name="12476">HTTPBasicCredentials</a></h3>
<p class="decl"><a href="Poco.Net.HTTPBasicCredentials.html" title="class Poco::Net::HTTPBasicCredentials">HTTPBasicCredentials</a>(<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; username,<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; password<br />);</p>
<div class="description">
<p>Creates a <a href="Poco.Net.HTTPBasicCredentials.html" title="class Poco::Net::HTTPBasicCredentials">HTTPBasicCredentials</a> object with the given username and password. </p>
</div>
<h2>Destructor</h2>
<h3><a name="12481">~HTTPBasicCredentials</a></h3>
<p class="decl">~<a href="Poco.Net.HTTPBasicCredentials.html" title="class Poco::Net::HTTPBasicCredentials">HTTPBasicCredentials</a>();</p>
<div class="description">
<p>Destroys the <a href="Poco.Net.HTTPBasicCredentials.html" title="class Poco::Net::HTTPBasicCredentials">HTTPBasicCredentials</a>. </p>
</div>
<h2>Member Functions</h2>
<h3><a name="12488">authenticate</a></h3>
<p class="decl">void authenticate(<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.Net.HTTPRequest.html" title="class Poco::Net::HTTPRequest">HTTPRequest</a> &amp; request<br />);</p>
<div class="description">
<p>Adds authentication information to the given <a href="Poco.Net.HTTPRequest.html" title="class Poco::Net::HTTPRequest">HTTPRequest</a>. </p>
</div>
<h3><a name="12487">getPassword</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">const std::string &amp; getPassword() const;</p>
<div class="description">
<p>Returns the password. </p>
</div>
<h3><a name="12484">getUsername</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">const std::string &amp; getUsername() const;</p>
<div class="description">
<p>Returns the username. </p>
</div>
<h3><a name="12485">setPassword</a></h3>
<p class="decl">void setPassword(<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; password<br />);</p>
<div class="description">
<p>Sets the password. </p>
</div>
<h3><a name="12482">setUsername</a></h3>
<p class="decl">void setUsername(<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; username<br />);</p>
<div class="description">
<p>Sets the username. </p>
</div>
<h2>Variables</h2>
<h3><a name="12490">SCHEME</a> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static const std::string <a href="Poco.Net.HTTPBasicCredentials.html#12490" title="Poco::Net::HTTPBasicCredentials::SCHEME">SCHEME</a>;</p>
<div class="description">
<p></p>
</div>
<p class="footer">POCO C++ Libraries 1.3.6-all<br />
Copyright &copy; 2009, <a href="http://pocoproject.org/" target="_blank">Applied Informatics Software Engineering GmbH and Contributors</a></p>

</div>
</body>
</html>