blob: f62271b76af7d5cfb7493d17f917ecdc60c65d18 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>org.apache.qpid.protonj2.engine.sasl.client (Qpid ProtonJ2 Parent 1.0.0-M18 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.apache.qpid.protonj2.engine.sasl.client">
<meta name="generator" content="javadoc/PackageWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../../script.js"></script>
</head>
<body class="package-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../../../index.html">Overview</a></li>
<li class="nav-bar-cell1-rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../help-doc.html#package">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Package:&nbsp;</li>
<li>Description&nbsp;|&nbsp;</li>
<li><a href="#related-package-summary">Related Packages</a>&nbsp;|&nbsp;</li>
<li><a href="#class-summary">Classes and Interfaces</a></li>
</ul>
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1 title="Package org.apache.qpid.protonj2.engine.sasl.client" class="title">Package org.apache.qpid.protonj2.engine.sasl.client</h1>
</div>
<hr>
<div class="package-signature">package <span class="element-name">org.apache.qpid.protonj2.engine.sasl.client</span></div>
<section class="summary">
<ul class="summary-list">
<li>
<div id="related-package-summary">
<div class="caption"><span>Related Packages</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Package</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="../package-summary.html">org.apache.qpid.protonj2.engine.sasl</a></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</div>
</li>
<li>
<div id="class-summary">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab1" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab1', 2)" class="table-tab">Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button><button id="class-summary-tab3" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab3', 2)" class="table-tab">Enums</button></div>
<div id="class-summary.tabpanel" role="tabpanel">
<div class="summary-table two-column-summary" aria-labelledby="class-summary-tab0">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="AbstractMechanism.html" title="class in org.apache.qpid.protonj2.engine.sasl.client">AbstractMechanism</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Base class for SASL Authentication Mechanism that implements the basic
methods of a Mechanism class.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="AnonymousMechanism.html" title="class in org.apache.qpid.protonj2.engine.sasl.client">AnonymousMechanism</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Implements the Anonymous SASL authentication mechanism.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="CramMD5Mechanism.html" title="class in org.apache.qpid.protonj2.engine.sasl.client">CramMD5Mechanism</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Implements the SASL CRAM-MD5 authentication Mechanism.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ExternalMechanism.html" title="class in org.apache.qpid.protonj2.engine.sasl.client">ExternalMechanism</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Implements the External SASL authentication mechanism.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="Mechanism.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">Mechanism</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Interface for all SASL authentication mechanism implementations.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="PlainMechanism.html" title="class in org.apache.qpid.protonj2.engine.sasl.client">PlainMechanism</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Implements the SASL PLAIN authentication Mechanism.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="SaslAuthenticator.html" title="class in org.apache.qpid.protonj2.engine.sasl.client">SaslAuthenticator</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Handles SASL traffic from the proton engine and drives the authentication process</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="SaslCredentialsProvider.html" title="interface in org.apache.qpid.protonj2.engine.sasl.client">SaslCredentialsProvider</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Interface for a supplier of login credentials used by the SASL Authenticator to
select and configure the client SASL mechanism.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab3"><a href="SaslMechanisms.html" title="enum in org.apache.qpid.protonj2.engine.sasl.client">SaslMechanisms</a></div>
<div class="col-last even-row-color class-summary class-summary-tab3">
<div class="block">Enumeration of all SASL Mechanisms supported by the client, order should be from most secure
to least secure.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="SaslMechanismSelector.html" title="class in org.apache.qpid.protonj2.engine.sasl.client">SaslMechanismSelector</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Client side mechanism used to select a matching mechanism from the server offered list of
mechanisms.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ScramSHA1Mechanism.html" title="class in org.apache.qpid.protonj2.engine.sasl.client">ScramSHA1Mechanism</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Implements the SASL Scram SHA1 authentication Mechanism.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ScramSHA256Mechanism.html" title="class in org.apache.qpid.protonj2.engine.sasl.client">ScramSHA256Mechanism</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Implements the SASL Scram SHA 256 authentication Mechanism.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ScramSHA512Mechanism.html" title="class in org.apache.qpid.protonj2.engine.sasl.client">ScramSHA512Mechanism</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Implements the SASL Scram SHA 256 authentication Mechanism.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="XOauth2Mechanism.html" title="class in org.apache.qpid.protonj2.engine.sasl.client">XOauth2Mechanism</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Implements the SASL XOAUTH2 authentication Mechanism .</div>
</div>
</div>
</div>
</div>
</li>
</ul>
</section>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>