| <!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.Implementation.Sasl.ProtonSaslServerContext 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&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&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_1Implementation.html">Implementation</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl.html">Sasl</a></li><li class="navelem"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslServerContext.html">ProtonSaslServerContext</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#nested-classes">Classes</a> | |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#properties">Properties</a> | |
| <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslServerContext-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Apache.Qpid.Proton.Engine.Implementation.Sasl.ProtonSaslServerContext Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>SASL Context for SASL client instances which handles the client side management of the SASL exchange. |
| <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslServerContext.html#details">More...</a></p> |
| <div class="dynheader"> |
| Inheritance diagram for Apache.Qpid.Proton.Engine.Implementation.Sasl.ProtonSaslServerContext:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslServerContext.png" usemap="#Apache.Qpid.Proton.Engine.Implementation.Sasl.ProtonSaslServerContext_map" alt=""/> |
| <map id="Apache.Qpid.Proton.Engine.Implementation.Sasl.ProtonSaslServerContext_map" name="Apache.Qpid.Proton.Engine.Implementation.Sasl.ProtonSaslServerContext_map"> |
| <area href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslContext.html" title="Engine handler that manages the SASL authentication process that occurs either on the client or serve..." alt="Apache.Qpid.Proton.Engine.Implementation.Sasl.ProtonSaslContext" shape="rect" coords="0,56,431,80"/> |
| <area href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslServerContext.html" title="SASL Server operating context used by an Engine that has been configured as a SASL server or that has..." alt="Apache.Qpid.Proton.Engine.Sasl.ISaslServerContext" shape="rect" coords="441,56,872,80"/> |
| <area href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext.html" title="Root context of a SASL authentication API which provides common elements used in both clients and ser..." alt="Apache.Qpid.Proton.Engine.Sasl.ISaslContext" shape="rect" coords="0,0,431,24"/> |
| <area href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext.html" title="Root context of a SASL authentication API which provides common elements used in both clients and ser..." alt="Apache.Qpid.Proton.Engine.Sasl.ISaslContext" shape="rect" coords="441,0,872,24"/> |
| </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:ad1834df4ac7b2d189eeacce7294cec96"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslServerContext.html">ISaslServerContext</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslServerContext.html#ad1834df4ac7b2d189eeacce7294cec96">SendMechanisms</a> (<a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Symbol.html">Symbol</a>[] mechanisms)</td></tr> |
| <tr class="memdesc:ad1834df4ac7b2d189eeacce7294cec96"><td class="mdescLeft"> </td><td class="mdescRight">Sends the set of supported mechanisms to the SASL client from which it must choose and return one mechanism which will then be the basis for the SASL authentication negotiation. <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslServerContext.html#ad1834df4ac7b2d189eeacce7294cec96">More...</a><br /></td></tr> |
| <tr class="separator:ad1834df4ac7b2d189eeacce7294cec96"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a894fc823f15b6ac63cecd23919965ada"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslServerContext.html">ISaslServerContext</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslServerContext.html#a894fc823f15b6ac63cecd23919965ada">SendChallenge</a> (<a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBuffer.html">IProtonBuffer</a> challenge)</td></tr> |
| <tr class="memdesc:a894fc823f15b6ac63cecd23919965ada"><td class="mdescLeft"> </td><td class="mdescRight">Sends the SASL challenge defined by the SASL mechanism that is in use during this SASL negotiation. The challenge is an opaque binary that is provided to the server by the security mechanism. <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslServerContext.html#a894fc823f15b6ac63cecd23919965ada">More...</a><br /></td></tr> |
| <tr class="separator:a894fc823f15b6ac63cecd23919965ada"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0ec73309dcb9d1f6248abefb0073290a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslServerContext.html">ISaslServerContext</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslServerContext.html#a0ec73309dcb9d1f6248abefb0073290a">SendOutcome</a> (<a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl.html#a007ac2ee5719c195cd362bfa2aec1b3a">SaslAuthOutcome</a> outcome, <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBuffer.html">IProtonBuffer</a> additional)</td></tr> |
| <tr class="memdesc:a0ec73309dcb9d1f6248abefb0073290a"><td class="mdescLeft"> </td><td class="mdescRight">Sends a response to a server side challenge that comprises the challenge / response exchange for the chosen SASL mechanism. <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslServerContext.html#a0ec73309dcb9d1f6248abefb0073290a">More...</a><br /></td></tr> |
| <tr class="separator:a0ec73309dcb9d1f6248abefb0073290a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8be4b734a49d4799fe0e8ed085fc7549"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslServerContext.html">ISaslServerContext</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslServerContext.html#a8be4b734a49d4799fe0e8ed085fc7549">SaslFailure</a> (<a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1SaslException.html">SaslException</a> failure)</td></tr> |
| <tr class="memdesc:a8be4b734a49d4799fe0e8ed085fc7549"><td class="mdescLeft"> </td><td class="mdescRight">Allows the server implementation to fail the SASL negotiation process due to some unrecoverable error. Failing the process will signal the <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Engine.html">Engine</a> that the SASL process has failed and place the engine in a failed state as well as notify the registered error handler for the <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Engine.html">Engine</a>. <a href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslServerContext.html#a8be4b734a49d4799fe0e8ed085fc7549">More...</a><br /></td></tr> |
| <tr class="separator:a8be4b734a49d4799fe0e8ed085fc7549"><td class="memSeparator" colspan="2"> </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:a88f5b4d71f90d79fb82d75dddb8889d8"><td class="memItemLeft" align="right" valign="top"><a id="a88f5b4d71f90d79fb82d75dddb8889d8"></a> |
| <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslServerAuthenticator.html">ISaslServerAuthenticator</a> </td><td class="memItemRight" valign="bottom"><b>Authenticator</b><code> [get, set]</code></td></tr> |
| <tr class="separator:a88f5b4d71f90d79fb82d75dddb8889d8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a466a767647d0d8d33599488d8da92e65"><td class="memItemLeft" align="right" valign="top"><a id="a466a767647d0d8d33599488d8da92e65"></a> |
| override <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl.html#a52f941085984113db91d0318285d9040">SaslContextRole</a> </td><td class="memItemRight" valign="bottom"><b>Role</b><code> [get]</code></td></tr> |
| <tr class="separator:a466a767647d0d8d33599488d8da92e65"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header properties_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslContext"><td colspan="2" onclick="javascript:toggleInherit('properties_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslContext')"><img src="closed.png" alt="-"/> Properties inherited from <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslContext.html">Apache.Qpid.Proton.Engine.Implementation.Sasl.ProtonSaslContext</a></td></tr> |
| <tr class="memitem:a32577e86edc7678f591cbb2965de464c inherit properties_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslContext"><td class="memItemLeft" align="right" valign="top"><a id="a32577e86edc7678f591cbb2965de464c"></a> |
| <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IAttachments.html">IAttachments</a> </td><td class="memItemRight" valign="bottom"><b>Attachments</b><code> [get]</code></td></tr> |
| <tr class="separator:a32577e86edc7678f591cbb2965de464c inherit properties_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslContext"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7356fd878181e5971dc4d857d82d6fe9 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslContext"><td class="memItemLeft" align="right" valign="top"><a id="a7356fd878181e5971dc4d857d82d6fe9"></a> |
| bool </td><td class="memItemRight" valign="bottom"><b>IsServer</b><code> [get]</code></td></tr> |
| <tr class="separator:a7356fd878181e5971dc4d857d82d6fe9 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslContext"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a765f20df070eeaf82b1fdd658809fecc inherit properties_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslContext"><td class="memItemLeft" align="right" valign="top"><a id="a765f20df070eeaf82b1fdd658809fecc"></a> |
| bool </td><td class="memItemRight" valign="bottom"><b>IsClient</b><code> [get]</code></td></tr> |
| <tr class="separator:a765f20df070eeaf82b1fdd658809fecc inherit properties_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslContext"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0c280f6f5fc702a7587b692f7d370d45 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslContext"><td class="memItemLeft" align="right" valign="top"><a id="a0c280f6f5fc702a7587b692f7d370d45"></a> |
| bool </td><td class="memItemRight" valign="bottom"><b>IsDone</b><code> [get]</code></td></tr> |
| <tr class="separator:a0c280f6f5fc702a7587b692f7d370d45 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslContext"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad03face66824056d9465d434d62f2465 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslContext"><td class="memItemLeft" align="right" valign="top"><a id="ad03face66824056d9465d434d62f2465"></a> |
| <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl.html#a007ac2ee5719c195cd362bfa2aec1b3a">SaslAuthOutcome</a> </td><td class="memItemRight" valign="bottom"><b>Outcome</b><code> [get]</code></td></tr> |
| <tr class="separator:ad03face66824056d9465d434d62f2465 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslContext"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7c18bfb766dc932ff1821a580bdfcc82 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslContext"><td class="memItemLeft" align="right" valign="top"><a id="a7c18bfb766dc932ff1821a580bdfcc82"></a> |
| <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Engine.html#ae14090a56ba2b8dc9b9bdccb6c5fdfb5">EngineSaslState</a> </td><td class="memItemRight" valign="bottom"><b>State</b><code> [get]</code></td></tr> |
| <tr class="separator:a7c18bfb766dc932ff1821a580bdfcc82 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslContext"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae674a65d1b4cdceaa5fe75470564df37 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslContext"><td class="memItemLeft" align="right" valign="top"><a id="ae674a65d1b4cdceaa5fe75470564df37"></a> |
| <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Symbol.html">Symbol</a>[] </td><td class="memItemRight" valign="bottom"><b>ServerMechanisms</b><code> [get]</code></td></tr> |
| <tr class="separator:ae674a65d1b4cdceaa5fe75470564df37 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslContext"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a534b53428ee1322a65c7edd908b83365 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslContext"><td class="memItemLeft" align="right" valign="top"><a id="a534b53428ee1322a65c7edd908b83365"></a> |
| <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Symbol.html">Symbol</a> </td><td class="memItemRight" valign="bottom"><b>ChosenMechanism</b><code> [get]</code></td></tr> |
| <tr class="separator:a534b53428ee1322a65c7edd908b83365 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslContext"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a851095319a86831c338b3983b0527c26 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslContext"><td class="memItemLeft" align="right" valign="top"><a id="a851095319a86831c338b3983b0527c26"></a> |
| string </td><td class="memItemRight" valign="bottom"><b>Hostname</b><code> [get]</code></td></tr> |
| <tr class="separator:a851095319a86831c338b3983b0527c26 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslContext"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2eba4d963ea5fc4394f827cf76b87450 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslContext"><td class="memItemLeft" align="right" valign="top"><a id="a2eba4d963ea5fc4394f827cf76b87450"></a> |
| abstract <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl.html#a52f941085984113db91d0318285d9040">SaslContextRole</a> </td><td class="memItemRight" valign="bottom"><b>Role</b><code> [get]</code></td></tr> |
| <tr class="separator:a2eba4d963ea5fc4394f827cf76b87450 inherit properties_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslContext"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext"><td colspan="2" onclick="javascript:toggleInherit('properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext')"><img src="closed.png" alt="-"/> Properties inherited from <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext.html">Apache.Qpid.Proton.Engine.Sasl.ISaslContext</a></td></tr> |
| <tr class="memitem:a6972d4297705f3d575103188e5fbb11a inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl.html#a52f941085984113db91d0318285d9040">SaslContextRole</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext.html#a6972d4297705f3d575103188e5fbb11a">Role</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a6972d4297705f3d575103188e5fbb11a inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext"><td class="mdescLeft"> </td><td class="mdescRight">Returns the role this context plays either client or server <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext.html#a6972d4297705f3d575103188e5fbb11a">More...</a><br /></td></tr> |
| <tr class="separator:a6972d4297705f3d575103188e5fbb11a inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a75ef27dafac5b8b0728b306433eba0bb inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1IAttachments.html">IAttachments</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext.html#a75ef27dafac5b8b0728b306433eba0bb">Attachments</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a75ef27dafac5b8b0728b306433eba0bb inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext"><td class="mdescLeft"> </td><td class="mdescRight">Access to the linked attachments instance where properties can be attached to this context for later application use. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext.html#a75ef27dafac5b8b0728b306433eba0bb">More...</a><br /></td></tr> |
| <tr class="separator:a75ef27dafac5b8b0728b306433eba0bb inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a403e1fdc89fa90668b749a1002a2c96a inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext.html#a403e1fdc89fa90668b749a1002a2c96a">IsDone</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a403e1fdc89fa90668b749a1002a2c96a inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext"><td class="mdescLeft"> </td><td class="mdescRight">Checks if SASL authentication has completed and an outcome is available. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext.html#a403e1fdc89fa90668b749a1002a2c96a">More...</a><br /></td></tr> |
| <tr class="separator:a403e1fdc89fa90668b749a1002a2c96a inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af8e4ee537c294a75f46070616f542a9b inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext.html#af8e4ee537c294a75f46070616f542a9b">IsServer</a><code> [get]</code></td></tr> |
| <tr class="memdesc:af8e4ee537c294a75f46070616f542a9b inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext"><td class="mdescLeft"> </td><td class="mdescRight">Provides a quick check for this context being a server context <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext.html#af8e4ee537c294a75f46070616f542a9b">More...</a><br /></td></tr> |
| <tr class="separator:af8e4ee537c294a75f46070616f542a9b inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2ecbba6508822305643bb1c267d73418 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext.html#a2ecbba6508822305643bb1c267d73418">IsClient</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a2ecbba6508822305643bb1c267d73418 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext"><td class="mdescLeft"> </td><td class="mdescRight">Provides a quick check for this context being a server context <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext.html#a2ecbba6508822305643bb1c267d73418">More...</a><br /></td></tr> |
| <tr class="separator:a2ecbba6508822305643bb1c267d73418 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a19c2730e84df0a9c407043256cfbae87 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl.html#a007ac2ee5719c195cd362bfa2aec1b3a">SaslAuthOutcome</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext.html#a19c2730e84df0a9c407043256cfbae87">Outcome</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a19c2730e84df0a9c407043256cfbae87 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext"><td class="mdescLeft"> </td><td class="mdescRight">Gets the outcome of the SASL authentication process. If the SASL exchange is ongoing or the SASL layer was skipped because a particular engine configuration allows such behavior then this method should return null to indicate no SASL outcome is available. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext.html#a19c2730e84df0a9c407043256cfbae87">More...</a><br /></td></tr> |
| <tr class="separator:a19c2730e84df0a9c407043256cfbae87 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a32e0f2ca8ae8112a5ff7fef29823aa3a inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Engine.html#ae14090a56ba2b8dc9b9bdccb6c5fdfb5">EngineSaslState</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext.html#a32e0f2ca8ae8112a5ff7fef29823aa3a">State</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a32e0f2ca8ae8112a5ff7fef29823aa3a inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext"><td class="mdescLeft"> </td><td class="mdescRight">Returns a state enum that indicates the current operating state of the SASL negotiation process or conversely if no SASL layer is configured this method should return the no-SASL state. This method must never return a null result. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext.html#a32e0f2ca8ae8112a5ff7fef29823aa3a">More...</a><br /></td></tr> |
| <tr class="separator:a32e0f2ca8ae8112a5ff7fef29823aa3a inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a11538259185fc4d7a5b3231ee5f41acd inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Symbol.html">Symbol</a>[] </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext.html#a11538259185fc4d7a5b3231ee5f41acd">ServerMechanisms</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a11538259185fc4d7a5b3231ee5f41acd inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext"><td class="mdescLeft"> </td><td class="mdescRight">After the server has sent its supported mechanisms this method will return a copy of that list for review by the server event handler. If called before the server has sent the mechanisms list this method will return null. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext.html#a11538259185fc4d7a5b3231ee5f41acd">More...</a><br /></td></tr> |
| <tr class="separator:a11538259185fc4d7a5b3231ee5f41acd inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a84ffa464643531a99cbe8b93fe7e52a5 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Symbol.html">Symbol</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext.html#a84ffa464643531a99cbe8b93fe7e52a5">ChosenMechanism</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a84ffa464643531a99cbe8b93fe7e52a5 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext"><td class="mdescLeft"> </td><td class="mdescRight">Returns the mechanism that was sent to the server to select the SASL mechanism to use for negotiations. If called before the client has sent its chosen mechanism this method returns null. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext.html#a84ffa464643531a99cbe8b93fe7e52a5">More...</a><br /></td></tr> |
| <tr class="separator:a84ffa464643531a99cbe8b93fe7e52a5 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6c7a8f0228fe0de0aacf0ac55acf8e28 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext.html#a6c7a8f0228fe0de0aacf0ac55acf8e28">Hostname</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a6c7a8f0228fe0de0aacf0ac55acf8e28 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext"><td class="mdescLeft"> </td><td class="mdescRight">The DNS name of the host (either fully qualified or relative) that was sent to the server which define the host the sending peer is connecting to. If called before the client sent the host name information to the server this method returns null. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext.html#a6c7a8f0228fe0de0aacf0ac55acf8e28">More...</a><br /></td></tr> |
| <tr class="separator:a6c7a8f0228fe0de0aacf0ac55acf8e28 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslContext"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslServerContext"><td colspan="2" onclick="javascript:toggleInherit('properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslServerContext')"><img src="closed.png" alt="-"/> Properties inherited from <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslServerContext.html">Apache.Qpid.Proton.Engine.Sasl.ISaslServerContext</a></td></tr> |
| <tr class="memitem:ad66d3933041fbfa3e51f4a993e702351 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslServerContext"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslServerAuthenticator.html">ISaslServerAuthenticator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslServerContext.html#ad66d3933041fbfa3e51f4a993e702351">Authenticator</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:ad66d3933041fbfa3e51f4a993e702351 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslServerContext"><td class="mdescLeft"> </td><td class="mdescRight">Configures the SASL authenticator which will be used to drive the SASL authentication process on the server side. <a href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslServerContext.html#ad66d3933041fbfa3e51f4a993e702351">More...</a><br /></td></tr> |
| <tr class="separator:ad66d3933041fbfa3e51f4a993e702351 inherit properties_interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslServerContext"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a> |
| Additional Inherited Members</h2></td></tr> |
| <tr class="inherit_header pro_attribs_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslContext"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslContext')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslContext.html">Apache.Qpid.Proton.Engine.Implementation.Sasl.ProtonSaslContext</a></td></tr> |
| <tr class="memitem:a541e7ac3859f85312526de46d0ed2218 inherit pro_attribs_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslContext"><td class="memItemLeft" align="right" valign="top"><a id="a541e7ac3859f85312526de46d0ed2218"></a> |
| readonly <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslHandler.html">ProtonSaslHandler</a> </td><td class="memItemRight" valign="bottom"><b>saslHandler</b></td></tr> |
| <tr class="separator:a541e7ac3859f85312526de46d0ed2218 inherit pro_attribs_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslContext"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a03db7b763d064d4b635474570c52d9c7 inherit pro_attribs_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslContext"><td class="memItemLeft" align="right" valign="top"><a id="a03db7b763d064d4b635474570c52d9c7"></a> |
| <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Symbol.html">Symbol</a>[] </td><td class="memItemRight" valign="bottom"><b>serverMechanisms</b></td></tr> |
| <tr class="separator:a03db7b763d064d4b635474570c52d9c7 inherit pro_attribs_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslContext"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad9507bdb0a31eff47c9555669d3a0cc4 inherit pro_attribs_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslContext"><td class="memItemLeft" align="right" valign="top"><a id="ad9507bdb0a31eff47c9555669d3a0cc4"></a> |
| <a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Symbol.html">Symbol</a> </td><td class="memItemRight" valign="bottom"><b>chosenMechanism</b></td></tr> |
| <tr class="separator:ad9507bdb0a31eff47c9555669d3a0cc4 inherit pro_attribs_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslContext"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a891dae9e089efad48056504c3403b257 inherit pro_attribs_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslContext"><td class="memItemLeft" align="right" valign="top"><a id="a891dae9e089efad48056504c3403b257"></a> |
| string </td><td class="memItemRight" valign="bottom"><b>hostname</b></td></tr> |
| <tr class="separator:a891dae9e089efad48056504c3403b257 inherit pro_attribs_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslContext"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4c69c083a3452c3b56f97d4317a08d18 inherit pro_attribs_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslContext"><td class="memItemLeft" align="right" valign="top"><a id="a4c69c083a3452c3b56f97d4317a08d18"></a> |
| <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Engine.html#ae14090a56ba2b8dc9b9bdccb6c5fdfb5">EngineSaslState</a> </td><td class="memItemRight" valign="bottom"><b>state</b> = <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Engine.html#ae14090a56ba2b8dc9b9bdccb6c5fdfb5ae599161956d626eda4cb0a5ffb85271c">EngineSaslState.Idle</a></td></tr> |
| <tr class="separator:a4c69c083a3452c3b56f97d4317a08d18 inherit pro_attribs_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslContext"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad0d7a93b68ce086f04069797bc1eadcc inherit pro_attribs_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslContext"><td class="memItemLeft" align="right" valign="top"><a id="ad0d7a93b68ce086f04069797bc1eadcc"></a> |
| <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl.html#a007ac2ee5719c195cd362bfa2aec1b3a">SaslAuthOutcome</a> </td><td class="memItemRight" valign="bottom"><b>outcome</b></td></tr> |
| <tr class="separator:ad0d7a93b68ce086f04069797bc1eadcc inherit pro_attribs_classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Implementation_1_1Sasl_1_1ProtonSaslContext"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>SASL Context for SASL client instances which handles the client side management of the SASL exchange. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a8be4b734a49d4799fe0e8ed085fc7549"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8be4b734a49d4799fe0e8ed085fc7549">◆ </a></span>SaslFailure()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslServerContext.html">ISaslServerContext</a> Apache.Qpid.Proton.Engine.Implementation.Sasl.ProtonSaslServerContext.SaslFailure </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1SaslException.html">SaslException</a> </td> |
| <td class="paramname"><em>failure</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>Allows the server implementation to fail the SASL negotiation process due to some unrecoverable error. Failing the process will signal the <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Engine.html">Engine</a> that the SASL process has failed and place the engine in a failed state as well as notify the registered error handler for the <a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Engine.html">Engine</a>. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">failure</td><td>The exception that indicates the reason for the server failure</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>This SASL server context instance.</dd></dl> |
| |
| <p>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslServerContext.html#a01f958c255928768a4c0248071a376f3">Apache.Qpid.Proton.Engine.Sasl.ISaslServerContext</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a894fc823f15b6ac63cecd23919965ada"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a894fc823f15b6ac63cecd23919965ada">◆ </a></span>SendChallenge()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslServerContext.html">ISaslServerContext</a> Apache.Qpid.Proton.Engine.Implementation.Sasl.ProtonSaslServerContext.SendChallenge </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBuffer.html">IProtonBuffer</a> </td> |
| <td class="paramname"><em>challenge</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>Sends the SASL challenge defined by the SASL mechanism that is in use during this SASL negotiation. The challenge is an opaque binary that is provided to the server by the security mechanism. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">challenge</td><td>The challenge bytes to send to the client</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>This SASL server context instance.</dd></dl> |
| |
| <p>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslServerContext.html#aa3f23390e03f95ba3e9639c60a39805b">Apache.Qpid.Proton.Engine.Sasl.ISaslServerContext</a>.</p> |
| |
| </div> |
| </div> |
| <a id="ad1834df4ac7b2d189eeacce7294cec96"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad1834df4ac7b2d189eeacce7294cec96">◆ </a></span>SendMechanisms()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslServerContext.html">ISaslServerContext</a> Apache.Qpid.Proton.Engine.Implementation.Sasl.ProtonSaslServerContext.SendMechanisms </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Types_1_1Symbol.html">Symbol</a>[] </td> |
| <td class="paramname"><em>mechanisms</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>Sends the set of supported mechanisms to the SASL client from which it must choose and return one mechanism which will then be the basis for the SASL authentication negotiation. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">mechanisms</td><td>The SASL mechanisms to offer to the client</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>This SASL server context instance.</dd></dl> |
| |
| <p>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslServerContext.html#a28ac39200e67889f33e8939874a759d6">Apache.Qpid.Proton.Engine.Sasl.ISaslServerContext</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a0ec73309dcb9d1f6248abefb0073290a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0ec73309dcb9d1f6248abefb0073290a">◆ </a></span>SendOutcome()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslServerContext.html">ISaslServerContext</a> Apache.Qpid.Proton.Engine.Implementation.Sasl.ProtonSaslServerContext.SendOutcome </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl.html#a007ac2ee5719c195cd362bfa2aec1b3a">SaslAuthOutcome</a> </td> |
| <td class="paramname"><em>outcome</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Buffer_1_1IProtonBuffer.html">IProtonBuffer</a> </td> |
| <td class="paramname"><em>additional</em> </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>Sends a response to a server side challenge that comprises the challenge / response exchange for the chosen SASL mechanism. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">outcome</td><td>The SASL Authentication outcome to send</td></tr> |
| <tr><td class="paramname">additional</td><td>Optional additional data to send</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>This SASL server context instance.</dd></dl> |
| |
| <p>Implements <a class="el" href="interfaceApache_1_1Qpid_1_1Proton_1_1Engine_1_1Sasl_1_1ISaslServerContext.html#afe9ea9510d98afa42f191b69e407c719">Apache.Qpid.Proton.Engine.Sasl.ISaslServerContext</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>src/Proton/Engine/Implementation/Sasl/ProtonSaslServerContext.cs</li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by <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> |
