Google Git
Sign in
apache / mina-site / refs/heads/mina-gen-docs / . / 2.0.7 / apidocs / org / apache / mina / proxy / ProxyLogicHandler.html
blob: ee291858067f7e62016e669e1cf4f489878b75eb [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 (version 1.7.0_07) on Sat Oct 06 02:25:59 CEST 2012 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>ProxyLogicHandler (Apache MINA 2.0.7 API)</title>
<meta name="date" content="2012-10-06">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ProxyLogicHandler (Apache MINA 2.0.7 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="class-use/ProxyLogicHandler.html">Use</a></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/mina/proxy/ProxyConnector.html" title="class in org.apache.mina.proxy"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/mina/proxy/ProxyLogicHandler.html" target="_top">Frames</a></li>
<li><a href="ProxyLogicHandler.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All 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>Nested&nbsp;|&nbsp;</li>
<li>Field&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>Field&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.mina.proxy</div>
<h2 title="Interface ProxyLogicHandler" class="title">Interface ProxyLogicHandler</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/mina/proxy/handlers/http/AbstractHttpLogicHandler.html" title="class in org.apache.mina.proxy.handlers.http">AbstractHttpLogicHandler</a>, <a href="../../../../org/apache/mina/proxy/AbstractProxyLogicHandler.html" title="class in org.apache.mina.proxy">AbstractProxyLogicHandler</a>, <a href="../../../../org/apache/mina/proxy/handlers/socks/AbstractSocksLogicHandler.html" title="class in org.apache.mina.proxy.handlers.socks">AbstractSocksLogicHandler</a>, <a href="../../../../org/apache/mina/proxy/handlers/http/HttpSmartProxyHandler.html" title="class in org.apache.mina.proxy.handlers.http">HttpSmartProxyHandler</a>, <a href="../../../../org/apache/mina/proxy/handlers/socks/Socks4LogicHandler.html" title="class in org.apache.mina.proxy.handlers.socks">Socks4LogicHandler</a>, <a href="../../../../org/apache/mina/proxy/handlers/socks/Socks5LogicHandler.html" title="class in org.apache.mina.proxy.handlers.socks">Socks5LogicHandler</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">ProxyLogicHandler</span></pre>
<div class="block">ProxyLogicHandler.java - Interface implemented by classes containing proxy type specific logic.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>MINA 2.0.0-M3</dd>
<dt><span class="strong">Author:</span></dt>
<dd><a href="http://mina.apache.org">Apache MINA Project</a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/mina/proxy/ProxyLogicHandler.html#doHandshake(org.apache.mina.core.filterchain.IoFilter.NextFilter)">doHandshake</a></strong>(<a href="../../../../org/apache/mina/core/filterchain/IoFilter.NextFilter.html" title="interface in org.apache.mina.core.filterchain">IoFilter.NextFilter</a>&nbsp;nextFilter)</code>
<div class="block">Called at each step of the handshake procedure.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/mina/proxy/ProxyLogicHandler.html#enqueueWriteRequest(org.apache.mina.core.filterchain.IoFilter.NextFilter, org.apache.mina.core.write.WriteRequest)">enqueueWriteRequest</a></strong>(<a href="../../../../org/apache/mina/core/filterchain/IoFilter.NextFilter.html" title="interface in org.apache.mina.core.filterchain">IoFilter.NextFilter</a>&nbsp;nextFilter,
<a href="../../../../org/apache/mina/core/write/WriteRequest.html" title="interface in org.apache.mina.core.write">WriteRequest</a>&nbsp;writeRequest)</code>
<div class="block">Enqueue a message to be written once handshaking is complete.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/mina/proxy/session/ProxyIoSession.html" title="class in org.apache.mina.proxy.session">ProxyIoSession</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/mina/proxy/ProxyLogicHandler.html#getProxyIoSession()">getProxyIoSession</a></strong>()</code>
<div class="block">Returns the <a href="../../../../org/apache/mina/proxy/session/ProxyIoSession.html" title="class in org.apache.mina.proxy.session"><code>ProxyIoSession</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/mina/proxy/ProxyLogicHandler.html#isHandshakeComplete()">isHandshakeComplete</a></strong>()</code>
<div class="block">Tests if handshake process is complete.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/mina/proxy/ProxyLogicHandler.html#messageReceived(org.apache.mina.core.filterchain.IoFilter.NextFilter, org.apache.mina.core.buffer.IoBuffer)">messageReceived</a></strong>(<a href="../../../../org/apache/mina/core/filterchain/IoFilter.NextFilter.html" title="interface in org.apache.mina.core.filterchain">IoFilter.NextFilter</a>&nbsp;nextFilter,
<a href="../../../../org/apache/mina/core/buffer/IoBuffer.html" title="class in org.apache.mina.core.buffer">IoBuffer</a>&nbsp;buf)</code>
<div class="block">Handle incoming data during the handshake process.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="isHandshakeComplete()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isHandshakeComplete</h4>
<pre>boolean&nbsp;isHandshakeComplete()</pre>
<div class="block">Tests if handshake process is complete.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if handshaking is complete and
data can be sent through the proxy, false otherwise.</dd></dl>
</li>
</ul>
<a name="messageReceived(org.apache.mina.core.filterchain.IoFilter.NextFilter, org.apache.mina.core.buffer.IoBuffer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>messageReceived</h4>
<pre>void&nbsp;messageReceived(<a href="../../../../org/apache/mina/core/filterchain/IoFilter.NextFilter.html" title="interface in org.apache.mina.core.filterchain">IoFilter.NextFilter</a>&nbsp;nextFilter,
<a href="../../../../org/apache/mina/core/buffer/IoBuffer.html" title="class in org.apache.mina.core.buffer">IoBuffer</a>&nbsp;buf)
throws <a href="../../../../org/apache/mina/proxy/ProxyAuthException.html" title="class in org.apache.mina.proxy">ProxyAuthException</a></pre>
<div class="block">Handle incoming data during the handshake process. Should consume only the
handshake data from the buffer, leaving any extra data in place.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>nextFilter</code> - the next filter in the filter chain</dd><dd><code>buf</code> - the buffer holding the received data</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/mina/proxy/ProxyAuthException.html" title="class in org.apache.mina.proxy">ProxyAuthException</a></code> - if authentication fails</dd></dl>
</li>
</ul>
<a name="doHandshake(org.apache.mina.core.filterchain.IoFilter.NextFilter)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doHandshake</h4>
<pre>void&nbsp;doHandshake(<a href="../../../../org/apache/mina/core/filterchain/IoFilter.NextFilter.html" title="interface in org.apache.mina.core.filterchain">IoFilter.NextFilter</a>&nbsp;nextFilter)
throws <a href="../../../../org/apache/mina/proxy/ProxyAuthException.html" title="class in org.apache.mina.proxy">ProxyAuthException</a></pre>
<div class="block">Called at each step of the handshake procedure.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>nextFilter</code> - the next filter in filter chain</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/mina/proxy/ProxyAuthException.html" title="class in org.apache.mina.proxy">ProxyAuthException</a></code> - if authentication fails</dd></dl>
</li>
</ul>
<a name="getProxyIoSession()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProxyIoSession</h4>
<pre><a href="../../../../org/apache/mina/proxy/session/ProxyIoSession.html" title="class in org.apache.mina.proxy.session">ProxyIoSession</a>&nbsp;getProxyIoSession()</pre>
<div class="block">Returns the <a href="../../../../org/apache/mina/proxy/session/ProxyIoSession.html" title="class in org.apache.mina.proxy.session"><code>ProxyIoSession</code></a>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the proxy session object</dd></dl>
</li>
</ul>
<a name="enqueueWriteRequest(org.apache.mina.core.filterchain.IoFilter.NextFilter, org.apache.mina.core.write.WriteRequest)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>enqueueWriteRequest</h4>
<pre>void&nbsp;enqueueWriteRequest(<a href="../../../../org/apache/mina/core/filterchain/IoFilter.NextFilter.html" title="interface in org.apache.mina.core.filterchain">IoFilter.NextFilter</a>&nbsp;nextFilter,
<a href="../../../../org/apache/mina/core/write/WriteRequest.html" title="interface in org.apache.mina.core.write">WriteRequest</a>&nbsp;writeRequest)</pre>
<div class="block">Enqueue a message to be written once handshaking is complete.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>nextFilter</code> - the next filter in filter chain</dd><dd><code>writeRequest</code> - the data to be written</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="class-use/ProxyLogicHandler.html">Use</a></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/mina/proxy/ProxyConnector.html" title="class in org.apache.mina.proxy"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/mina/proxy/ProxyLogicHandler.html" target="_top">Frames</a></li>
<li><a href="ProxyLogicHandler.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All 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>Nested&nbsp;|&nbsp;</li>
<li>Field&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>Field&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 ======= -->
<p class="legalCopy"><small>Copyright &#169; 2004-2012 <a href="http://mina.apache.org/">Apache MINA Project</a>. All Rights Reserved.</small></p>
</body>
</html>