blob: e404865a101ee3f75d1541d7d3e1dbc1e3cbee3e [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>Socks4LogicHandler (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="Socks4LogicHandler (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/Socks4LogicHandler.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/handlers/socks/AbstractSocksLogicHandler.html" title="class in org.apache.mina.proxy.handlers.socks"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../org/apache/mina/proxy/handlers/socks/Socks5LogicHandler.html" title="class in org.apache.mina.proxy.handlers.socks"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/mina/proxy/handlers/socks/Socks4LogicHandler.html" target="_top">Frames</a></li>
<li><a href="Socks4LogicHandler.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><a href="#fields_inherited_from_class_org.apache.mina.proxy.handlers.socks.AbstractSocksLogicHandler">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&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><a href="#constructor_detail">Constr</a>&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.handlers.socks</div>
<h2 title="Class Socks4LogicHandler" class="title">Class Socks4LogicHandler</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../org/apache/mina/proxy/AbstractProxyLogicHandler.html" title="class in org.apache.mina.proxy">org.apache.mina.proxy.AbstractProxyLogicHandler</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../org/apache/mina/proxy/handlers/socks/AbstractSocksLogicHandler.html" title="class in org.apache.mina.proxy.handlers.socks">org.apache.mina.proxy.handlers.socks.AbstractSocksLogicHandler</a></li>
<li>
<ul class="inheritance">
<li>org.apache.mina.proxy.handlers.socks.Socks4LogicHandler</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../../org/apache/mina/proxy/ProxyLogicHandler.html" title="interface in org.apache.mina.proxy">ProxyLogicHandler</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">Socks4LogicHandler</span>
extends <a href="../../../../../../org/apache/mina/proxy/handlers/socks/AbstractSocksLogicHandler.html" title="class in org.apache.mina.proxy.handlers.socks">AbstractSocksLogicHandler</a></pre>
<div class="block">Socks4LogicHandler.java - SOCKS4/SOCKS4a authentication mechanisms logic handler.</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">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.mina.proxy.handlers.socks.AbstractSocksLogicHandler">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.mina.proxy.handlers.socks.<a href="../../../../../../org/apache/mina/proxy/handlers/socks/AbstractSocksLogicHandler.html" title="class in org.apache.mina.proxy.handlers.socks">AbstractSocksLogicHandler</a></h3>
<code><a href="../../../../../../org/apache/mina/proxy/handlers/socks/AbstractSocksLogicHandler.html#request">request</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../../org/apache/mina/proxy/handlers/socks/Socks4LogicHandler.html#Socks4LogicHandler(org.apache.mina.proxy.session.ProxyIoSession)">Socks4LogicHandler</a></strong>(<a href="../../../../../../org/apache/mina/proxy/session/ProxyIoSession.html" title="class in org.apache.mina.proxy.session">ProxyIoSession</a>&nbsp;proxyIoSession)</code></td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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/handlers/socks/Socks4LogicHandler.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">Perform the handshake.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/mina/proxy/handlers/socks/Socks4LogicHandler.html#handleResponse(org.apache.mina.core.buffer.IoBuffer)">handleResponse</a></strong>(<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 a SOCKS4/SOCKS4a response from the proxy server.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/mina/proxy/handlers/socks/Socks4LogicHandler.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>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/mina/proxy/handlers/socks/Socks4LogicHandler.html#writeRequest(org.apache.mina.core.filterchain.IoFilter.NextFilter, org.apache.mina.proxy.handlers.socks.SocksProxyRequest)">writeRequest</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/proxy/handlers/socks/SocksProxyRequest.html" title="class in org.apache.mina.proxy.handlers.socks">SocksProxyRequest</a>&nbsp;request)</code>
<div class="block">Encode a SOCKS4/SOCKS4a request and writes it to the next filter
so it can be sent to the proxy server.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.mina.proxy.AbstractProxyLogicHandler">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.mina.proxy.<a href="../../../../../../org/apache/mina/proxy/AbstractProxyLogicHandler.html" title="class in org.apache.mina.proxy">AbstractProxyLogicHandler</a></h3>
<code><a href="../../../../../../org/apache/mina/proxy/AbstractProxyLogicHandler.html#closeSession(java.lang.String)">closeSession</a>, <a href="../../../../../../org/apache/mina/proxy/AbstractProxyLogicHandler.html#closeSession(java.lang.String, java.lang.Throwable)">closeSession</a>, <a href="../../../../../../org/apache/mina/proxy/AbstractProxyLogicHandler.html#enqueueWriteRequest(org.apache.mina.core.filterchain.IoFilter.NextFilter, org.apache.mina.core.write.WriteRequest)">enqueueWriteRequest</a>, <a href="../../../../../../org/apache/mina/proxy/AbstractProxyLogicHandler.html#flushPendingWriteRequests()">flushPendingWriteRequests</a>, <a href="../../../../../../org/apache/mina/proxy/AbstractProxyLogicHandler.html#getProxyFilter()">getProxyFilter</a>, <a href="../../../../../../org/apache/mina/proxy/AbstractProxyLogicHandler.html#getProxyIoSession()">getProxyIoSession</a>, <a href="../../../../../../org/apache/mina/proxy/AbstractProxyLogicHandler.html#getSession()">getSession</a>, <a href="../../../../../../org/apache/mina/proxy/AbstractProxyLogicHandler.html#isHandshakeComplete()">isHandshakeComplete</a>, <a href="../../../../../../org/apache/mina/proxy/AbstractProxyLogicHandler.html#setHandshakeComplete()">setHandshakeComplete</a>, <a href="../../../../../../org/apache/mina/proxy/AbstractProxyLogicHandler.html#writeData(org.apache.mina.core.filterchain.IoFilter.NextFilter, org.apache.mina.core.buffer.IoBuffer)">writeData</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Socks4LogicHandler(org.apache.mina.proxy.session.ProxyIoSession)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Socks4LogicHandler</h4>
<pre>public&nbsp;Socks4LogicHandler(<a href="../../../../../../org/apache/mina/proxy/session/ProxyIoSession.html" title="class in org.apache.mina.proxy.session">ProxyIoSession</a>&nbsp;proxyIoSession)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="doHandshake(org.apache.mina.core.filterchain.IoFilter.NextFilter)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doHandshake</h4>
<pre>public&nbsp;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)</pre>
<div class="block">Perform the handshake.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>nextFilter</code> - the next filter</dd></dl>
</li>
</ul>
<a name="writeRequest(org.apache.mina.core.filterchain.IoFilter.NextFilter, org.apache.mina.proxy.handlers.socks.SocksProxyRequest)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeRequest</h4>
<pre>protected&nbsp;void&nbsp;writeRequest(<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/proxy/handlers/socks/SocksProxyRequest.html" title="class in org.apache.mina.proxy.handlers.socks">SocksProxyRequest</a>&nbsp;request)</pre>
<div class="block">Encode a SOCKS4/SOCKS4a request and writes it to the next filter
so it can be sent to the proxy server.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>nextFilter</code> - the next filter</dd><dd><code>request</code> - the request to send.</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>public&nbsp;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)</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</dd><dd><code>buf</code> - the server response data buffer</dd></dl>
</li>
</ul>
<a name="handleResponse(org.apache.mina.core.buffer.IoBuffer)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>handleResponse</h4>
<pre>protected&nbsp;void&nbsp;handleResponse(<a href="../../../../../../org/apache/mina/core/buffer/IoBuffer.html" title="class in org.apache.mina.core.buffer">IoBuffer</a>&nbsp;buf)
throws <a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Handle a SOCKS4/SOCKS4a response from the proxy server. Test
the response buffer reply code and call <a href="../../../../../../org/apache/mina/proxy/AbstractProxyLogicHandler.html#setHandshakeComplete()"><code>AbstractProxyLogicHandler.setHandshakeComplete()</code></a>
if access is granted.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>buf</code> - the buffer holding the server response data.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>exception</code> - if server response is malformed or if request is rejected
by the proxy server.</dd>
<dd><code><a href="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></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/Socks4LogicHandler.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/handlers/socks/AbstractSocksLogicHandler.html" title="class in org.apache.mina.proxy.handlers.socks"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../org/apache/mina/proxy/handlers/socks/Socks5LogicHandler.html" title="class in org.apache.mina.proxy.handlers.socks"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/mina/proxy/handlers/socks/Socks4LogicHandler.html" target="_top">Frames</a></li>
<li><a href="Socks4LogicHandler.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><a href="#fields_inherited_from_class_org.apache.mina.proxy.handlers.socks.AbstractSocksLogicHandler">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&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><a href="#constructor_detail">Constr</a>&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>