Google Git
Sign in
apache / qpid-site / refs/heads/asf-site / . / content / releases / qpid-proton-dotnet-1.0.0-M10 / api / classApache_1_1Qpid_1_1Proton_1_1Client_1_1SaslOptions.html
blob: dabf31c235258fa460cbe93e02613bcc07f2d621 [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.Client.SaslOptions Class 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_1Client.html">Client</a></li><li class="navelem"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SaslOptions.html">SaslOptions</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SaslOptions-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Apache.Qpid.Proton.Client.SaslOptions Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Options that control how the SASL authentication process is performed.
<a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SaslOptions.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for Apache.Qpid.Proton.Client.SaslOptions:</div>
<div class="dyncontent">
<div class="center">
<img src="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SaslOptions.png" alt=""/>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a3f6a7da0ec330fecb7466a82e8ab9bd3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SaslOptions.html#a3f6a7da0ec330fecb7466a82e8ab9bd3">SaslOptions</a> ()</td></tr>
<tr class="memdesc:a3f6a7da0ec330fecb7466a82e8ab9bd3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a default SASL options instance. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SaslOptions.html#a3f6a7da0ec330fecb7466a82e8ab9bd3">More...</a><br /></td></tr>
<tr class="separator:a3f6a7da0ec330fecb7466a82e8ab9bd3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a919965725f333828fc3d72efdebcd133"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SaslOptions.html#a919965725f333828fc3d72efdebcd133">SaslOptions</a> (<a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SaslOptions.html">SaslOptions</a> other)</td></tr>
<tr class="memdesc:a919965725f333828fc3d72efdebcd133"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new SASL options instance whose settings are copied from the instance provided. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SaslOptions.html#a919965725f333828fc3d72efdebcd133">More...</a><br /></td></tr>
<tr class="separator:a919965725f333828fc3d72efdebcd133"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a731703e6dace47534ee36e1dd3441245"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SaslOptions.html#a731703e6dace47534ee36e1dd3441245">AddAllowedMechanism</a> (string mechanism)</td></tr>
<tr class="memdesc:a731703e6dace47534ee36e1dd3441245"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds the given SASL mechanism to the set of those allowed during connection authentication. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SaslOptions.html#a731703e6dace47534ee36e1dd3441245">More...</a><br /></td></tr>
<tr class="separator:a731703e6dace47534ee36e1dd3441245"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a407f0aef1b65ab0ad7477c9e15fc5fa5"><td class="memItemLeft" align="right" valign="top">object&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SaslOptions.html#a407f0aef1b65ab0ad7477c9e15fc5fa5">Clone</a> ()</td></tr>
<tr class="memdesc:a407f0aef1b65ab0ad7477c9e15fc5fa5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clone this options instance, changes to the cloned options are not reflected in this options instance. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SaslOptions.html#a407f0aef1b65ab0ad7477c9e15fc5fa5">More...</a><br /></td></tr>
<tr class="separator:a407f0aef1b65ab0ad7477c9e15fc5fa5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a7969521bf777ce846090b8e81ff56c29"><td class="memItemLeft" align="right" valign="top">static readonly bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SaslOptions.html#a7969521bf777ce846090b8e81ff56c29">DEFAULT_SASL_ENABLED</a> = true</td></tr>
<tr class="memdesc:a7969521bf777ce846090b8e81ff56c29"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default for SASL use on any connection created using these options. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SaslOptions.html#a7969521bf777ce846090b8e81ff56c29">More...</a><br /></td></tr>
<tr class="separator:a7969521bf777ce846090b8e81ff56c29"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:a2250edc5597ab2f259c9a83eba1cd4a1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SaslOptions.html#a2250edc5597ab2f259c9a83eba1cd4a1">SaslEnabled</a> = <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SaslOptions.html#a7969521bf777ce846090b8e81ff56c29">DEFAULT_SASL_ENABLED</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a2250edc5597ab2f259c9a83eba1cd4a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configures if a connection will enable its SASL layer for authentication which by default all connections will do. This should only be disabled if the remote peer is known not to be using a SASL authentication layer. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SaslOptions.html#a2250edc5597ab2f259c9a83eba1cd4a1">More...</a><br /></td></tr>
<tr class="separator:a2250edc5597ab2f259c9a83eba1cd4a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3dab435ec0a83bafb1e28f2e1ba87e7d"><td class="memItemLeft" align="right" valign="top">IReadOnlyCollection&lt; string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SaslOptions.html#a3dab435ec0a83bafb1e28f2e1ba87e7d">AllowedMechanisms</a><code> [get]</code></td></tr>
<tr class="memdesc:a3dab435ec0a83bafb1e28f2e1ba87e7d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a copy of the set of all allowed SASL mechanisms for the connections created using these options. By default there are no restrictions and all client supported SASL mechanisms will be considered however in some cases certain mechanisms are not enabled unless the user manually specifies them at the exclusion of all other mechanisms. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SaslOptions.html#a3dab435ec0a83bafb1e28f2e1ba87e7d">More...</a><br /></td></tr>
<tr class="separator:a3dab435ec0a83bafb1e28f2e1ba87e7d"><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>Options that control how the SASL authentication process is performed. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a3f6a7da0ec330fecb7466a82e8ab9bd3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3f6a7da0ec330fecb7466a82e8ab9bd3">&#9670;&nbsp;</a></span>SaslOptions() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Apache.Qpid.Proton.Client.SaslOptions.SaslOptions </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a default SASL options instance. </p>
</div>
</div>
<a id="a919965725f333828fc3d72efdebcd133"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a919965725f333828fc3d72efdebcd133">&#9670;&nbsp;</a></span>SaslOptions() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Apache.Qpid.Proton.Client.SaslOptions.SaslOptions </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SaslOptions.html">SaslOptions</a>&#160;</td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new SASL options instance whose settings are copied from the instance provided. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>The connection options instance to copy</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a731703e6dace47534ee36e1dd3441245"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a731703e6dace47534ee36e1dd3441245">&#9670;&nbsp;</a></span>AddAllowedMechanism()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Apache.Qpid.Proton.Client.SaslOptions.AddAllowedMechanism </td>
<td>(</td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>mechanism</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds the given SASL mechanism to the set of those allowed during connection authentication. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mechanism</td><td>The mechanism to add to the allowed set</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a407f0aef1b65ab0ad7477c9e15fc5fa5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a407f0aef1b65ab0ad7477c9e15fc5fa5">&#9670;&nbsp;</a></span>Clone()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">object Apache.Qpid.Proton.Client.SaslOptions.Clone </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Clone this options instance, changes to the cloned options are not reflected in this options instance. </p>
<dl class="section return"><dt>Returns</dt><dd>A deep copy of this options instance.</dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a7969521bf777ce846090b8e81ff56c29"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7969521bf777ce846090b8e81ff56c29">&#9670;&nbsp;</a></span>DEFAULT_SASL_ENABLED</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">readonly bool Apache.Qpid.Proton.Client.SaslOptions.DEFAULT_SASL_ENABLED = true</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Default for SASL use on any connection created using these options. </p>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a id="a3dab435ec0a83bafb1e28f2e1ba87e7d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3dab435ec0a83bafb1e28f2e1ba87e7d">&#9670;&nbsp;</a></span>AllowedMechanisms</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">IReadOnlyCollection&lt;string&gt; Apache.Qpid.Proton.Client.SaslOptions.AllowedMechanisms</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>Returns a copy of the set of all allowed SASL mechanisms for the connections created using these options. By default there are no restrictions and all client supported SASL mechanisms will be considered however in some cases certain mechanisms are not enabled unless the user manually specifies them at the exclusion of all other mechanisms. </p>
</div>
</div>
<a id="a2250edc5597ab2f259c9a83eba1cd4a1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2250edc5597ab2f259c9a83eba1cd4a1">&#9670;&nbsp;</a></span>SaslEnabled</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Apache.Qpid.Proton.Client.SaslOptions.SaslEnabled = <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1SaslOptions.html#a7969521bf777ce846090b8e81ff56c29">DEFAULT_SASL_ENABLED</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Configures if a connection will enable its SASL layer for authentication which by default all connections will do. This should only be disabled if the remote peer is known not to be using a SASL authentication layer. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/Proton.Client/Client/SaslOptions.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>