Google Git
Sign in
apache / qpid-site / refs/heads/asf-site / . / input / releases / qpid-proton-dotnet-1.0.0-M10 / api / classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1SaslSystemException.html
blob: 9b2df03288b0389a38209c083f72739b6f3793db [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.SaslSystemException 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_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="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1SaslSystemException.html">SaslSystemException</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1SaslSystemException-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Apache.Qpid.Proton.Engine.Sasl.SaslSystemException Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Indicates that a SASL handshake has failed with a 'sys", 'sys-perm', or 'sys-temp' outcome code as defined by:
<a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1SaslSystemException.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for Apache.Qpid.Proton.Engine.Sasl.SaslSystemException:</div>
<div class="dyncontent">
<div class="center">
<img src="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1SaslSystemException.png" usemap="#Apache.Qpid.Proton.Engine.Sasl.SaslSystemException_map" alt=""/>
<map id="Apache.Qpid.Proton.Engine.Sasl.SaslSystemException_map" name="Apache.Qpid.Proton.Engine.Sasl.SaslSystemException_map">
<area href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1SaslException.html" title="Base exception type for exceptions encountered during SASL authentication." alt="Apache.Qpid.Proton.Engine.Sasl.SaslException" shape="rect" coords="0,56,322,80"/>
</map>
</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:a1d08d3166efefb22131a9590e3e4950f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1SaslSystemException.html#a1d08d3166efefb22131a9590e3e4950f">SaslSystemException</a> (bool permanent)</td></tr>
<tr class="memdesc:a1d08d3166efefb22131a9590e3e4950f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a default version of this exception type. <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1SaslSystemException.html#a1d08d3166efefb22131a9590e3e4950f">More...</a><br /></td></tr>
<tr class="separator:a1d08d3166efefb22131a9590e3e4950f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a85ff4a2175d58b4a991c0a2576121f79"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1SaslSystemException.html#a85ff4a2175d58b4a991c0a2576121f79">SaslSystemException</a> (string message, bool permanent)</td></tr>
<tr class="memdesc:a85ff4a2175d58b4a991c0a2576121f79"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new instance with the given message that describes the specifics of the error. <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1SaslSystemException.html#a85ff4a2175d58b4a991c0a2576121f79">More...</a><br /></td></tr>
<tr class="separator:a85ff4a2175d58b4a991c0a2576121f79"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1SaslException"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1SaslException')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1SaslException.html">Apache.Qpid.Proton.Engine.Sasl.SaslException</a></td></tr>
<tr class="memitem:a5e634b97ac46fb547f5a2be8e9f90db1 inherit pub_methods_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1SaslException"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1SaslException.html#a5e634b97ac46fb547f5a2be8e9f90db1">SaslException</a> ()</td></tr>
<tr class="memdesc:a5e634b97ac46fb547f5a2be8e9f90db1 inherit pub_methods_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1SaslException"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a default version of this exception type. <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1SaslException.html#a5e634b97ac46fb547f5a2be8e9f90db1">More...</a><br /></td></tr>
<tr class="separator:a5e634b97ac46fb547f5a2be8e9f90db1 inherit pub_methods_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1SaslException"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac8b5f3109cf7ee2815f5d79f48643445 inherit pub_methods_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1SaslException"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1SaslException.html#ac8b5f3109cf7ee2815f5d79f48643445">SaslException</a> (string message)</td></tr>
<tr class="memdesc:ac8b5f3109cf7ee2815f5d79f48643445 inherit pub_methods_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1SaslException"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new instance with the given message that describes the specifics of the error. <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1SaslException.html#ac8b5f3109cf7ee2815f5d79f48643445">More...</a><br /></td></tr>
<tr class="separator:ac8b5f3109cf7ee2815f5d79f48643445 inherit pub_methods_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1SaslException"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a190dcf29cabcfe601f42de3044457342 inherit pub_methods_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1SaslException"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1SaslException.html#a190dcf29cabcfe601f42de3044457342">SaslException</a> (string message, Exception cause)</td></tr>
<tr class="memdesc:a190dcf29cabcfe601f42de3044457342 inherit pub_methods_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1SaslException"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new instance with the given message that describes the specifics of the error. <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1SaslException.html#a190dcf29cabcfe601f42de3044457342">More...</a><br /></td></tr>
<tr class="separator:a190dcf29cabcfe601f42de3044457342 inherit pub_methods_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1SaslException"><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:a4b077f642ea9b867cd5a555a76574915"><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_1Engine_1_1Sasl_1_1SaslSystemException.html#a4b077f642ea9b867cd5a555a76574915">Permanent</a><code> [get]</code></td></tr>
<tr class="memdesc:a4b077f642ea9b867cd5a555a76574915"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if the condition that caused this exception is of a permanent nature. <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1SaslSystemException.html#a4b077f642ea9b867cd5a555a76574915">More...</a><br /></td></tr>
<tr class="separator:a4b077f642ea9b867cd5a555a76574915"><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>Indicates that a SASL handshake has failed with a 'sys", 'sys-perm', or 'sys-temp' outcome code as defined by: </p>
<p>http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-security-v1.0-os.html::type-sasl-code</p>
<p>Version 1.0, Section 5.3.3.6</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a1d08d3166efefb22131a9590e3e4950f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1d08d3166efefb22131a9590e3e4950f">&#9670;&nbsp;</a></span>SaslSystemException() <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.Engine.Sasl.SaslSystemException.SaslSystemException </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>permanent</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>Creates a default version of this exception type. </p>
</div>
</div>
<a id="a85ff4a2175d58b4a991c0a2576121f79"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a85ff4a2175d58b4a991c0a2576121f79">&#9670;&nbsp;</a></span>SaslSystemException() <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.Engine.Sasl.SaslSystemException.SaslSystemException </td>
<td>(</td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>message</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>permanent</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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 instance with the given message that describes the specifics of the error. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">message</td><td>Description of the error</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a id="a4b077f642ea9b867cd5a555a76574915"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4b077f642ea9b867cd5a555a76574915">&#9670;&nbsp;</a></span>Permanent</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.Engine.Sasl.SaslSystemException.Permanent</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>Checks if the condition that caused this exception is of a permanent nature. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/Proton/Engine/Sasl/SaslSystemException.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>