Google Git
Sign in
apache / qpid-site / 5404ff5f26d72c4c418dd95f4ef04e1fba050c29 / . / content / releases / qpid-proton-j-0.30.0 / api / org / apache / qpid / proton / engine / Sasl.html
blob: a1937957fdbf411c0160e135087d84329f0e881b [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Sasl (Qpid Proton-J API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Sasl (Qpid Proton-J API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/qpid/proton/engine/RecordAccessor.html" title="interface in org.apache.qpid.proton.engine"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/qpid/proton/engine/Sasl.SaslOutcome.html" title="enum in org.apache.qpid.proton.engine"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/qpid/proton/engine/Sasl.html" target="_top">Frames</a></li>
<li><a href="Sasl.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.qpid.proton.engine</div>
<h2 title="Interface Sasl" class="title">Interface Sasl</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/qpid/proton/engine/impl/SaslImpl.html" title="class in org.apache.qpid.proton.engine.impl">SaslImpl</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Sasl</span></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Interface and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Sasl.SaslOutcome.html" title="enum in org.apache.qpid.proton.engine">Sasl.SaslOutcome</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Sasl.SaslState.html" title="enum in org.apache.qpid.proton.engine">Sasl.SaslState</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/qpid/proton/engine/Sasl.SaslOutcome.html" title="enum in org.apache.qpid.proton.engine">Sasl.SaslOutcome</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Sasl.html#PN_SASL_AUTH">PN_SASL_AUTH</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/qpid/proton/engine/Sasl.SaslOutcome.html" title="enum in org.apache.qpid.proton.engine">Sasl.SaslOutcome</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Sasl.html#PN_SASL_NONE">PN_SASL_NONE</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/qpid/proton/engine/Sasl.SaslOutcome.html" title="enum in org.apache.qpid.proton.engine">Sasl.SaslOutcome</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Sasl.html#PN_SASL_OK">PN_SASL_OK</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/qpid/proton/engine/Sasl.SaslOutcome.html" title="enum in org.apache.qpid.proton.engine">Sasl.SaslOutcome</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Sasl.html#PN_SASL_PERM">PN_SASL_PERM</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/qpid/proton/engine/Sasl.SaslOutcome.html" title="enum in org.apache.qpid.proton.engine">Sasl.SaslOutcome</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Sasl.html#PN_SASL_SKIPPED">PN_SASL_SKIPPED</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/qpid/proton/engine/Sasl.SaslOutcome.html" title="enum in org.apache.qpid.proton.engine">Sasl.SaslOutcome</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Sasl.html#PN_SASL_SYS">PN_SASL_SYS</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/qpid/proton/engine/Sasl.SaslOutcome.html" title="enum in org.apache.qpid.proton.engine">Sasl.SaslOutcome</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Sasl.html#PN_SASL_TEMP">PN_SASL_TEMP</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Sasl.html#allowSkip-boolean-">allowSkip</a></span>(boolean&nbsp;allowSkip)</code>
<div class="block">Set whether servers may accept incoming connections
that skip the SASL layer negotiation.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Sasl.html#client--">client</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Sasl.html#done-org.apache.qpid.proton.engine.Sasl.SaslOutcome-">done</a></span>(<a href="../../../../../org/apache/qpid/proton/engine/Sasl.SaslOutcome.html" title="enum in org.apache.qpid.proton.engine">Sasl.SaslOutcome</a>&nbsp;outcome)</code>
<div class="block">Set the outcome of SASL negotiation
Used by the server to set the result of the negotiation process.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Sasl.html#getHostname--">getHostname</a></span>()</code>
<div class="block">Retrieve the hostname indicated by the client when sending its SaslInit.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/engine/Sasl.SaslOutcome.html" title="enum in org.apache.qpid.proton.engine">Sasl.SaslOutcome</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Sasl.html#getOutcome--">getOutcome</a></span>()</code>
<div class="block">Retrieve the outcome of SASL negotiation.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Sasl.html#getRemoteMechanisms--">getRemoteMechanisms</a></span>()</code>
<div class="block">Retrieve the list of SASL mechanisms provided by the remote.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/engine/Sasl.SaslState.html" title="enum in org.apache.qpid.proton.engine">Sasl.SaslState</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Sasl.html#getState--">getState</a></span>()</code>
<div class="block">Access the current state of the layer.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Sasl.html#pending--">pending</a></span>()</code>
<div class="block">Determine the size of the bytes available via recv().</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Sasl.html#plain-java.lang.String-java.lang.String-">plain</a></span>(java.lang.String&nbsp;username,
java.lang.String&nbsp;password)</code>
<div class="block">Configure the SASL layer to use the "PLAIN" mechanism.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Sasl.html#recv-byte:A-int-int-">recv</a></span>(byte[]&nbsp;bytes,
int&nbsp;offset,
int&nbsp;size)</code>
<div class="block">Read challenge/response/additional data sent from the peer.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Sasl.html#send-byte:A-int-int-">send</a></span>(byte[]&nbsp;bytes,
int&nbsp;offset,
int&nbsp;size)</code>
<div class="block">Send challenge/response/additional data to the peer.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Sasl.html#server--">server</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Sasl.html#setListener-org.apache.qpid.proton.engine.SaslListener-">setListener</a></span>(<a href="../../../../../org/apache/qpid/proton/engine/SaslListener.html" title="interface in org.apache.qpid.proton.engine">SaslListener</a>&nbsp;saslListener)</code>
<div class="block">Adds a listener to receive notice of frames having arrived.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Sasl.html#setMechanisms-java.lang.String...-">setMechanisms</a></span>(java.lang.String...&nbsp;mechanisms)</code>
<div class="block">Set the acceptable SASL mechanisms for the layer.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Sasl.html#setRemoteHostname-java.lang.String-">setRemoteHostname</a></span>(java.lang.String&nbsp;hostname)</code>
<div class="block">Set the remote hostname to indicate the host being connected to when
sending a SaslInit to the server.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="PN_SASL_NONE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PN_SASL_NONE</h4>
<pre>static final&nbsp;<a href="../../../../../org/apache/qpid/proton/engine/Sasl.SaslOutcome.html" title="enum in org.apache.qpid.proton.engine">Sasl.SaslOutcome</a> PN_SASL_NONE</pre>
</li>
</ul>
<a name="PN_SASL_OK">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PN_SASL_OK</h4>
<pre>static final&nbsp;<a href="../../../../../org/apache/qpid/proton/engine/Sasl.SaslOutcome.html" title="enum in org.apache.qpid.proton.engine">Sasl.SaslOutcome</a> PN_SASL_OK</pre>
</li>
</ul>
<a name="PN_SASL_AUTH">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PN_SASL_AUTH</h4>
<pre>static final&nbsp;<a href="../../../../../org/apache/qpid/proton/engine/Sasl.SaslOutcome.html" title="enum in org.apache.qpid.proton.engine">Sasl.SaslOutcome</a> PN_SASL_AUTH</pre>
</li>
</ul>
<a name="PN_SASL_SYS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PN_SASL_SYS</h4>
<pre>static final&nbsp;<a href="../../../../../org/apache/qpid/proton/engine/Sasl.SaslOutcome.html" title="enum in org.apache.qpid.proton.engine">Sasl.SaslOutcome</a> PN_SASL_SYS</pre>
</li>
</ul>
<a name="PN_SASL_PERM">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PN_SASL_PERM</h4>
<pre>static final&nbsp;<a href="../../../../../org/apache/qpid/proton/engine/Sasl.SaslOutcome.html" title="enum in org.apache.qpid.proton.engine">Sasl.SaslOutcome</a> PN_SASL_PERM</pre>
</li>
</ul>
<a name="PN_SASL_TEMP">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PN_SASL_TEMP</h4>
<pre>static final&nbsp;<a href="../../../../../org/apache/qpid/proton/engine/Sasl.SaslOutcome.html" title="enum in org.apache.qpid.proton.engine">Sasl.SaslOutcome</a> PN_SASL_TEMP</pre>
</li>
</ul>
<a name="PN_SASL_SKIPPED">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PN_SASL_SKIPPED</h4>
<pre>static final&nbsp;<a href="../../../../../org/apache/qpid/proton/engine/Sasl.SaslOutcome.html" title="enum in org.apache.qpid.proton.engine">Sasl.SaslOutcome</a> PN_SASL_SKIPPED</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getState--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getState</h4>
<pre><a href="../../../../../org/apache/qpid/proton/engine/Sasl.SaslState.html" title="enum in org.apache.qpid.proton.engine">Sasl.SaslState</a>&nbsp;getState()</pre>
<div class="block">Access the current state of the layer.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The state of the sasl layer.</dd>
</dl>
</li>
</ul>
<a name="setMechanisms-java.lang.String...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMechanisms</h4>
<pre>void&nbsp;setMechanisms(java.lang.String...&nbsp;mechanisms)</pre>
<div class="block">Set the acceptable SASL mechanisms for the layer.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mechanisms</code> - a list of acceptable SASL mechanisms</dd>
</dl>
</li>
</ul>
<a name="getRemoteMechanisms--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRemoteMechanisms</h4>
<pre>java.lang.String[]&nbsp;getRemoteMechanisms()</pre>
<div class="block">Retrieve the list of SASL mechanisms provided by the remote.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the SASL mechanisms advertised by the remote</dd>
</dl>
</li>
</ul>
<a name="setRemoteHostname-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRemoteHostname</h4>
<pre>void&nbsp;setRemoteHostname(java.lang.String&nbsp;hostname)</pre>
<div class="block">Set the remote hostname to indicate the host being connected to when
sending a SaslInit to the server.</div>
</li>
</ul>
<a name="getHostname--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHostname</h4>
<pre>java.lang.String&nbsp;getHostname()</pre>
<div class="block">Retrieve the hostname indicated by the client when sending its SaslInit.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the hostname indicated by the remote client, or null if none specified.</dd>
</dl>
</li>
</ul>
<a name="pending--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pending</h4>
<pre>int&nbsp;pending()</pre>
<div class="block">Determine the size of the bytes available via recv().
Returns the size in bytes available via recv().</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The number of bytes available, zero if no available data.</dd>
</dl>
</li>
</ul>
<a name="recv-byte:A-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>recv</h4>
<pre>int&nbsp;recv(byte[]&nbsp;bytes,
int&nbsp;offset,
int&nbsp;size)</pre>
<div class="block">Read challenge/response/additional data sent from the peer.
Use pending to determine the size of the data.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>bytes</code> - written with up to size bytes of inbound data.</dd>
<dd><code>offset</code> - the offset in the array to begin writing at</dd>
<dd><code>size</code> - maximum number of bytes that bytes can accept.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The number of bytes written to bytes, or an error code if &lt; 0.</dd>
</dl>
</li>
</ul>
<a name="send-byte:A-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>send</h4>
<pre>int&nbsp;send(byte[]&nbsp;bytes,
int&nbsp;offset,
int&nbsp;size)</pre>
<div class="block">Send challenge/response/additional data to the peer.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>bytes</code> - The challenge/response data.</dd>
<dd><code>offset</code> - the point within the array at which the data starts at</dd>
<dd><code>size</code> - The number of data octets in bytes.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The number of octets read from bytes, or an error code if &lt; 0</dd>
</dl>
</li>
</ul>
<a name="done-org.apache.qpid.proton.engine.Sasl.SaslOutcome-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>done</h4>
<pre>void&nbsp;done(<a href="../../../../../org/apache/qpid/proton/engine/Sasl.SaslOutcome.html" title="enum in org.apache.qpid.proton.engine">Sasl.SaslOutcome</a>&nbsp;outcome)</pre>
<div class="block">Set the outcome of SASL negotiation
Used by the server to set the result of the negotiation process.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>outcome</code> - the outcome of the SASL negotiation</dd>
</dl>
</li>
</ul>
<a name="plain-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>plain</h4>
<pre>void&nbsp;plain(java.lang.String&nbsp;username,
java.lang.String&nbsp;password)</pre>
<div class="block">Configure the SASL layer to use the "PLAIN" mechanism.
A utility function to configure a simple client SASL layer using
PLAIN authentication.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>username</code> - credential for the PLAIN authentication
mechanism</dd>
<dd><code>password</code> - credential for the PLAIN authentication
mechanism</dd>
</dl>
</li>
</ul>
<a name="getOutcome--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOutcome</h4>
<pre><a href="../../../../../org/apache/qpid/proton/engine/Sasl.SaslOutcome.html" title="enum in org.apache.qpid.proton.engine">Sasl.SaslOutcome</a>&nbsp;getOutcome()</pre>
<div class="block">Retrieve the outcome of SASL negotiation.</div>
</li>
</ul>
<a name="client--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>client</h4>
<pre>void&nbsp;client()</pre>
</li>
</ul>
<a name="server--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>server</h4>
<pre>void&nbsp;server()</pre>
</li>
</ul>
<a name="allowSkip-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>allowSkip</h4>
<pre>void&nbsp;allowSkip(boolean&nbsp;allowSkip)</pre>
<div class="block">Set whether servers may accept incoming connections
that skip the SASL layer negotiation.</div>
</li>
</ul>
<a name="setListener-org.apache.qpid.proton.engine.SaslListener-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setListener</h4>
<pre>void&nbsp;setListener(<a href="../../../../../org/apache/qpid/proton/engine/SaslListener.html" title="interface in org.apache.qpid.proton.engine">SaslListener</a>&nbsp;saslListener)</pre>
<div class="block">Adds a listener to receive notice of frames having arrived.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/qpid/proton/engine/RecordAccessor.html" title="interface in org.apache.qpid.proton.engine"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/qpid/proton/engine/Sasl.SaslOutcome.html" title="enum in org.apache.qpid.proton.engine"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/qpid/proton/engine/Sasl.html" target="_top">Frames</a></li>
<li><a href="Sasl.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>