Google Git
Sign in
apache / qpid-site / refs/heads/asf-site / . / input / releases / qpid-proton-dotnet-1.0.0-M10 / api / interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1Client_1_1ISaslCredentialsProvider.html
blob: 0aab439cd243aa96b25c5f28742883140ac3344a [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Proton DotNet: Apache.Qpid.Proton.Engine.Sasl.Client.ISaslCredentialsProvider Interface Reference</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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.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">Proton DotNet
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceApache.html">Apache</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid.html">Qpid</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton.html">Proton</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Engine.html">Engine</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl.html">Sasl</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1Client.html">Client</a></li><li class="navelem"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1Client_1_1ISaslCredentialsProvider.html">ISaslCredentialsProvider</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#properties">Properties</a> &#124;
<a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1Client_1_1ISaslCredentialsProvider-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Apache.Qpid.Proton.Engine.Sasl.Client.ISaslCredentialsProvider Interface Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Interface for a supplier of login credentials used by the SASL Authenticator to select and configure the client SASL mechanism.
<a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1Client_1_1ISaslCredentialsProvider.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for Apache.Qpid.Proton.Engine.Sasl.Client.ISaslCredentialsProvider:</div>
<div class="dyncontent">
<div class="center">
<img src="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1Client_1_1ISaslCredentialsProvider.png" usemap="#Apache.Qpid.Proton.Engine.Sasl.Client.ISaslCredentialsProvider_map" alt=""/>
<map id="Apache.Qpid.Proton.Engine.Sasl.Client.ISaslCredentialsProvider_map" name="Apache.Qpid.Proton.Engine.Sasl.Client.ISaslCredentialsProvider_map">
<area href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1Client_1_1DelegatedSaslCredentialsProvider.html" title="SASL Credentials Provider instance that accepts delegate methods which can provide the credentials up..." alt="Apache.Qpid.Proton.Engine.Sasl.Client.DelegatedSaslCredentialsProvider" shape="rect" coords="0,56,433,80"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:a0d36eb512b18a85cdf296866f046d906"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1Client_1_1ISaslCredentialsProvider.html#a0d36eb512b18a85cdf296866f046d906">VHost</a><code> [get]</code></td></tr>
<tr class="memdesc:a0d36eb512b18a85cdf296866f046d906"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the virtual host value the use when performing SASL authentication. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1Client_1_1ISaslCredentialsProvider.html#a0d36eb512b18a85cdf296866f046d906">More...</a><br /></td></tr>
<tr class="separator:a0d36eb512b18a85cdf296866f046d906"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a08ac9cc55c20d0d5bf26e41dca2c1c1f"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1Client_1_1ISaslCredentialsProvider.html#a08ac9cc55c20d0d5bf26e41dca2c1c1f">Username</a><code> [get]</code></td></tr>
<tr class="memdesc:a08ac9cc55c20d0d5bf26e41dca2c1c1f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the user name value the use when performing SASL authentication. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1Client_1_1ISaslCredentialsProvider.html#a08ac9cc55c20d0d5bf26e41dca2c1c1f">More...</a><br /></td></tr>
<tr class="separator:a08ac9cc55c20d0d5bf26e41dca2c1c1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a44c3aa27ca3fc6214ca9464e7b46f110"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1Client_1_1ISaslCredentialsProvider.html#a44c3aa27ca3fc6214ca9464e7b46f110">Password</a><code> [get]</code></td></tr>
<tr class="memdesc:a44c3aa27ca3fc6214ca9464e7b46f110"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the password value the use when performing SASL authentication. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1Client_1_1ISaslCredentialsProvider.html#a44c3aa27ca3fc6214ca9464e7b46f110">More...</a><br /></td></tr>
<tr class="separator:a44c3aa27ca3fc6214ca9464e7b46f110"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abfe80bbab6d5a5c8ebec8705f9dca7f5"><td class="memItemLeft" align="right" valign="top">IPrincipal&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1Client_1_1ISaslCredentialsProvider.html#abfe80bbab6d5a5c8ebec8705f9dca7f5">LocalPrincipal</a><code> [get]</code></td></tr>
<tr class="memdesc:abfe80bbab6d5a5c8ebec8705f9dca7f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">The local principal value to use when performing SASL authentication. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1Client_1_1ISaslCredentialsProvider.html#abfe80bbab6d5a5c8ebec8705f9dca7f5">More...</a><br /></td></tr>
<tr class="separator:abfe80bbab6d5a5c8ebec8705f9dca7f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3977aa208e6929bf1cc0617c929a6588"><td class="memItemLeft" align="right" valign="top">IDictionary&lt; string, object &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1Client_1_1ISaslCredentialsProvider.html#a3977aa208e6929bf1cc0617c929a6588">Options</a><code> [get]</code></td></tr>
<tr class="memdesc:a3977aa208e6929bf1cc0617c929a6588"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets a collection of options the use when performing SASL authentication. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1Client_1_1ISaslCredentialsProvider.html#a3977aa208e6929bf1cc0617c929a6588">More...</a><br /></td></tr>
<tr class="separator:a3977aa208e6929bf1cc0617c929a6588"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Interface for a supplier of login credentials used by the SASL Authenticator to select and configure the client SASL mechanism. </p>
</div><h2 class="groupheader">Property Documentation</h2>
<a id="abfe80bbab6d5a5c8ebec8705f9dca7f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abfe80bbab6d5a5c8ebec8705f9dca7f5">&#9670;&nbsp;</a></span>LocalPrincipal</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">IPrincipal Apache.Qpid.Proton.Engine.Sasl.Client.ISaslCredentialsProvider.LocalPrincipal</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The local principal value to use when performing SASL authentication. </p>
</div>
</div>
<a id="a3977aa208e6929bf1cc0617c929a6588"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3977aa208e6929bf1cc0617c929a6588">&#9670;&nbsp;</a></span>Options</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">IDictionary&lt;string, object&gt; Apache.Qpid.Proton.Engine.Sasl.Client.ISaslCredentialsProvider.Options</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets a collection of options the use when performing SASL authentication. </p>
</div>
</div>
<a id="a44c3aa27ca3fc6214ca9464e7b46f110"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a44c3aa27ca3fc6214ca9464e7b46f110">&#9670;&nbsp;</a></span>Password</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">string Apache.Qpid.Proton.Engine.Sasl.Client.ISaslCredentialsProvider.Password</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the password value the use when performing SASL authentication. </p>
</div>
</div>
<a id="a08ac9cc55c20d0d5bf26e41dca2c1c1f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a08ac9cc55c20d0d5bf26e41dca2c1c1f">&#9670;&nbsp;</a></span>Username</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">string Apache.Qpid.Proton.Engine.Sasl.Client.ISaslCredentialsProvider.Username</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the user name value the use when performing SASL authentication. </p>
</div>
</div>
<a id="a0d36eb512b18a85cdf296866f046d906"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0d36eb512b18a85cdf296866f046d906">&#9670;&nbsp;</a></span>VHost</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">string Apache.Qpid.Proton.Engine.Sasl.Client.ISaslCredentialsProvider.VHost</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the virtual host value the use when performing SASL authentication. </p>
</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li>src/Proton/Engine/Sasl/Client/ISaslCredentialsProvider.cs</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>