blob: e6059d20df0d2cddff33cac5bbd99be39aa372a9 [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>ProxyConnector (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="ProxyConnector (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/ProxyConnector.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/ProxyAuthException.html" title="class in org.apache.mina.proxy"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/mina/proxy/ProxyLogicHandler.html" title="interface in org.apache.mina.proxy"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/mina/proxy/ProxyConnector.html" target="_top">Frames</a></li>
<li><a href="ProxyConnector.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><a href="#nested_classes_inherited_from_class_org.apache.mina.core.service.AbstractIoService">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#fields_inherited_from_class_org.apache.mina.core.service.AbstractIoService">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</div>
<h2 title="Class ProxyConnector" class="title">Class ProxyConnector</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/core/service/AbstractIoService.html" title="class in org.apache.mina.core.service">org.apache.mina.core.service.AbstractIoService</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/apache/mina/core/service/AbstractIoConnector.html" title="class in org.apache.mina.core.service">org.apache.mina.core.service.AbstractIoConnector</a></li>
<li>
<ul class="inheritance">
<li>org.apache.mina.proxy.ProxyConnector</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/core/service/IoConnector.html" title="interface in org.apache.mina.core.service">IoConnector</a>, <a href="../../../../org/apache/mina/core/service/IoService.html" title="interface in org.apache.mina.core.service">IoService</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">ProxyConnector</span>
extends <a href="../../../../org/apache/mina/core/service/AbstractIoConnector.html" title="class in org.apache.mina.core.service">AbstractIoConnector</a></pre>
<div class="block">ProxyConnector.java - Decorator for <a href="../../../../org/apache/mina/transport/socket/SocketConnector.html" title="interface in org.apache.mina.transport.socket"><code>SocketConnector</code></a> to provide proxy support,
as suggested by MINA list discussions.
<p>
Operates by intercepting connect requests and replacing the endpoint address with the
proxy address, then adding a <a href="../../../../org/apache/mina/proxy/filter/ProxyFilter.html" title="class in org.apache.mina.proxy.filter"><code>ProxyFilter</code></a> as the first <a href="../../../../org/apache/mina/core/filterchain/IoFilter.html" title="interface in org.apache.mina.core.filterchain"><code>IoFilter</code></a> which
performs any necessary handshaking with the proxy before allowing data to flow
normally. During the handshake, any outgoing write requests are buffered.</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>
<dt><span class="strong">See Also:</span></dt><dd><code>http://www.nabble.com/Meta-Transport%3A-an-idea-on-implementing-reconnection-and-proxy-td12969001.html</code>,
<code>http://issues.apache.org/jira/browse/DIRMINA-415</code></dd></dl>
</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>
<ul class="blockList">
<li class="blockList"><a name="nested_classes_inherited_from_class_org.apache.mina.core.service.AbstractIoService">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.apache.mina.core.service.<a href="../../../../org/apache/mina/core/service/AbstractIoService.html" title="class in org.apache.mina.core.service">AbstractIoService</a></h3>
<code><a href="../../../../org/apache/mina/core/service/AbstractIoService.ServiceOperationFuture.html" title="class in org.apache.mina.core.service">AbstractIoService.ServiceOperationFuture</a></code></li>
</ul>
</li>
</ul>
<!-- =========== 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.core.service.AbstractIoService">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.mina.core.service.<a href="../../../../org/apache/mina/core/service/AbstractIoService.html" title="class in org.apache.mina.core.service">AbstractIoService</a></h3>
<code><a href="../../../../org/apache/mina/core/service/AbstractIoService.html#disposalLock">disposalLock</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/ProxyConnector.html#ProxyConnector()">ProxyConnector</a></strong>()</code>
<div class="block">Creates a new proxy connector.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/mina/proxy/ProxyConnector.html#ProxyConnector(org.apache.mina.transport.socket.SocketConnector)">ProxyConnector</a></strong>(<a href="../../../../org/apache/mina/transport/socket/SocketConnector.html" title="interface in org.apache.mina.transport.socket">SocketConnector</a>&nbsp;connector)</code>
<div class="block">Creates a new proxy connector.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/mina/proxy/ProxyConnector.html#ProxyConnector(org.apache.mina.transport.socket.SocketConnector, org.apache.mina.core.session.IoSessionConfig, java.util.concurrent.Executor)">ProxyConnector</a></strong>(<a href="../../../../org/apache/mina/transport/socket/SocketConnector.html" title="interface in org.apache.mina.transport.socket">SocketConnector</a>&nbsp;connector,
<a href="../../../../org/apache/mina/core/session/IoSessionConfig.html" title="interface in org.apache.mina.core.session">IoSessionConfig</a>&nbsp;config,
<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/concurrent/Executor.html?is-external=true" title="class or interface in java.util.concurrent">Executor</a>&nbsp;executor)</code>
<div class="block">Creates a new proxy connector.</div>
</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/ProxyConnector.html#cancelConnectFuture()">cancelConnectFuture</a></strong>()</code>
<div class="block">Cancels the real connection when reconnection is in use.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../org/apache/mina/core/future/ConnectFuture.html" title="interface in org.apache.mina.core.future">ConnectFuture</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/mina/proxy/ProxyConnector.html#connect0(java.net.SocketAddress, java.net.SocketAddress, org.apache.mina.core.session.IoSessionInitializer)">connect0</a></strong>(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/net/SocketAddress.html?is-external=true" title="class or interface in java.net">SocketAddress</a>&nbsp;remoteAddress,
<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/net/SocketAddress.html?is-external=true" title="class or interface in java.net">SocketAddress</a>&nbsp;localAddress,
<a href="../../../../org/apache/mina/core/session/IoSessionInitializer.html" title="interface in org.apache.mina.core.session">IoSessionInitializer</a>&lt;? extends <a href="../../../../org/apache/mina/core/future/ConnectFuture.html" title="interface in org.apache.mina.core.future">ConnectFuture</a>&gt;&nbsp;sessionInitializer)</code>
<div class="block">Connects to the specified <code>address</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/mina/proxy/ProxyConnector.html#dispose0()">dispose0</a></strong>()</code>
<div class="block">Implement this method to release any acquired resources.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../org/apache/mina/core/future/ConnectFuture.html" title="interface in org.apache.mina.core.future">ConnectFuture</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/mina/proxy/ProxyConnector.html#fireConnected(org.apache.mina.core.session.IoSession)">fireConnected</a></strong>(<a href="../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session">IoSession</a>&nbsp;session)</code>
<div class="block">Fires the connection event on the real future to notify the client.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/mina/transport/socket/SocketConnector.html" title="interface in org.apache.mina.transport.socket">SocketConnector</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/mina/proxy/ProxyConnector.html#getConnector()">getConnector</a></strong>()</code>
<div class="block">Get the <a href="../../../../org/apache/mina/transport/socket/SocketConnector.html" title="interface in org.apache.mina.transport.socket"><code>SocketConnector</code></a> to be used for connections
to the proxy server.</div>
</td>
</tr>
<tr class="rowColor">
<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/ProxyConnector.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> linked with this connector.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/mina/core/session/IoSessionConfig.html" title="interface in org.apache.mina.core.session">IoSessionConfig</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/mina/proxy/ProxyConnector.html#getSessionConfig()">getSessionConfig</a></strong>()</code>
<div class="block">Returns the default configuration of the new <a href="../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session"><code>IoSession</code></a>s
created by this service.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/mina/core/service/TransportMetadata.html" title="interface in org.apache.mina.core.service">TransportMetadata</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/mina/proxy/ProxyConnector.html#getTransportMetadata()">getTransportMetadata</a></strong>()</code>
<div class="block">Returns the <a href="../../../../org/apache/mina/core/service/TransportMetadata.html" title="interface in org.apache.mina.core.service"><code>TransportMetadata</code></a> that this service runs on.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/mina/proxy/ProxyConnector.html#setProxyIoSession(org.apache.mina.proxy.session.ProxyIoSession)">setProxyIoSession</a></strong>(<a href="../../../../org/apache/mina/proxy/session/ProxyIoSession.html" title="class in org.apache.mina.proxy.session">ProxyIoSession</a>&nbsp;proxyIoSession)</code>
<div class="block">Sets the proxy session object of this connector.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.mina.core.service.AbstractIoConnector">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.mina.core.service.<a href="../../../../org/apache/mina/core/service/AbstractIoConnector.html" title="class in org.apache.mina.core.service">AbstractIoConnector</a></h3>
<code><a href="../../../../org/apache/mina/core/service/AbstractIoConnector.html#connect()">connect</a>, <a href="../../../../org/apache/mina/core/service/AbstractIoConnector.html#connect(org.apache.mina.core.session.IoSessionInitializer)">connect</a>, <a href="../../../../org/apache/mina/core/service/AbstractIoConnector.html#connect(java.net.SocketAddress)">connect</a>, <a href="../../../../org/apache/mina/core/service/AbstractIoConnector.html#connect(java.net.SocketAddress, org.apache.mina.core.session.IoSessionInitializer)">connect</a>, <a href="../../../../org/apache/mina/core/service/AbstractIoConnector.html#connect(java.net.SocketAddress, java.net.SocketAddress)">connect</a>, <a href="../../../../org/apache/mina/core/service/AbstractIoConnector.html#connect(java.net.SocketAddress, java.net.SocketAddress, org.apache.mina.core.session.IoSessionInitializer)">connect</a>, <a href="../../../../org/apache/mina/core/service/AbstractIoConnector.html#finishSessionInitialization0(org.apache.mina.core.session.IoSession, org.apache.mina.core.future.IoFuture)">finishSessionInitialization0</a>, <a href="../../../../org/apache/mina/core/service/AbstractIoConnector.html#getConnectTimeout()">getConnectTimeout</a>, <a href="../../../../org/apache/mina/core/service/AbstractIoConnector.html#getConnectTimeoutCheckInterval()">getConnectTimeoutCheckInterval</a>, <a href="../../../../org/apache/mina/core/service/AbstractIoConnector.html#getConnectTimeoutMillis()">getConnectTimeoutMillis</a>, <a href="../../../../org/apache/mina/core/service/AbstractIoConnector.html#getDefaultRemoteAddress()">getDefaultRemoteAddress</a>, <a href="../../../../org/apache/mina/core/service/AbstractIoConnector.html#setConnectTimeout(int)">setConnectTimeout</a>, <a href="../../../../org/apache/mina/core/service/AbstractIoConnector.html#setConnectTimeoutCheckInterval(long)">setConnectTimeoutCheckInterval</a>, <a href="../../../../org/apache/mina/core/service/AbstractIoConnector.html#setConnectTimeoutMillis(long)">setConnectTimeoutMillis</a>, <a href="../../../../org/apache/mina/core/service/AbstractIoConnector.html#setDefaultRemoteAddress(java.net.SocketAddress)">setDefaultRemoteAddress</a>, <a href="../../../../org/apache/mina/core/service/AbstractIoConnector.html#toString()">toString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.mina.core.service.AbstractIoService">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.mina.core.service.<a href="../../../../org/apache/mina/core/service/AbstractIoService.html" title="class in org.apache.mina.core.service">AbstractIoService</a></h3>
<code><a href="../../../../org/apache/mina/core/service/AbstractIoService.html#addListener(org.apache.mina.core.service.IoServiceListener)">addListener</a>, <a href="../../../../org/apache/mina/core/service/AbstractIoService.html#broadcast(java.lang.Object)">broadcast</a>, <a href="../../../../org/apache/mina/core/service/AbstractIoService.html#dispose()">dispose</a>, <a href="../../../../org/apache/mina/core/service/AbstractIoService.html#dispose(boolean)">dispose</a>, <a href="../../../../org/apache/mina/core/service/AbstractIoService.html#executeWorker(java.lang.Runnable)">executeWorker</a>, <a href="../../../../org/apache/mina/core/service/AbstractIoService.html#executeWorker(java.lang.Runnable, java.lang.String)">executeWorker</a>, <a href="../../../../org/apache/mina/core/service/AbstractIoService.html#getActivationTime()">getActivationTime</a>, <a href="../../../../org/apache/mina/core/service/AbstractIoService.html#getFilterChain()">getFilterChain</a>, <a href="../../../../org/apache/mina/core/service/AbstractIoService.html#getFilterChainBuilder()">getFilterChainBuilder</a>, <a href="../../../../org/apache/mina/core/service/AbstractIoService.html#getHandler()">getHandler</a>, <a href="../../../../org/apache/mina/core/service/AbstractIoService.html#getListeners()">getListeners</a>, <a href="../../../../org/apache/mina/core/service/AbstractIoService.html#getManagedSessionCount()">getManagedSessionCount</a>, <a href="../../../../org/apache/mina/core/service/AbstractIoService.html#getManagedSessions()">getManagedSessions</a>, <a href="../../../../org/apache/mina/core/service/AbstractIoService.html#getScheduledWriteBytes()">getScheduledWriteBytes</a>, <a href="../../../../org/apache/mina/core/service/AbstractIoService.html#getScheduledWriteMessages()">getScheduledWriteMessages</a>, <a href="../../../../org/apache/mina/core/service/AbstractIoService.html#getSessionDataStructureFactory()">getSessionDataStructureFactory</a>, <a href="../../../../org/apache/mina/core/service/AbstractIoService.html#getStatistics()">getStatistics</a>, <a href="../../../../org/apache/mina/core/service/AbstractIoService.html#initSession(org.apache.mina.core.session.IoSession, org.apache.mina.core.future.IoFuture, org.apache.mina.core.session.IoSessionInitializer)">initSession</a>, <a href="../../../../org/apache/mina/core/service/AbstractIoService.html#isActive()">isActive</a>, <a href="../../../../org/apache/mina/core/service/AbstractIoService.html#isDisposed()">isDisposed</a>, <a href="../../../../org/apache/mina/core/service/AbstractIoService.html#isDisposing()">isDisposing</a>, <a href="../../../../org/apache/mina/core/service/AbstractIoService.html#removeListener(org.apache.mina.core.service.IoServiceListener)">removeListener</a>, <a href="../../../../org/apache/mina/core/service/AbstractIoService.html#setFilterChainBuilder(org.apache.mina.core.filterchain.IoFilterChainBuilder)">setFilterChainBuilder</a>, <a href="../../../../org/apache/mina/core/service/AbstractIoService.html#setHandler(org.apache.mina.core.service.IoHandler)">setHandler</a>, <a href="../../../../org/apache/mina/core/service/AbstractIoService.html#setSessionDataStructureFactory(org.apache.mina.core.session.IoSessionDataStructureFactory)">setSessionDataStructureFactory</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#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>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.mina.core.service.IoService">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.mina.core.service.<a href="../../../../org/apache/mina/core/service/IoService.html" title="interface in org.apache.mina.core.service">IoService</a></h3>
<code><a href="../../../../org/apache/mina/core/service/IoService.html#addListener(org.apache.mina.core.service.IoServiceListener)">addListener</a>, <a href="../../../../org/apache/mina/core/service/IoService.html#broadcast(java.lang.Object)">broadcast</a>, <a href="../../../../org/apache/mina/core/service/IoService.html#dispose()">dispose</a>, <a href="../../../../org/apache/mina/core/service/IoService.html#dispose(boolean)">dispose</a>, <a href="../../../../org/apache/mina/core/service/IoService.html#getActivationTime()">getActivationTime</a>, <a href="../../../../org/apache/mina/core/service/IoService.html#getFilterChain()">getFilterChain</a>, <a href="../../../../org/apache/mina/core/service/IoService.html#getFilterChainBuilder()">getFilterChainBuilder</a>, <a href="../../../../org/apache/mina/core/service/IoService.html#getHandler()">getHandler</a>, <a href="../../../../org/apache/mina/core/service/IoService.html#getManagedSessionCount()">getManagedSessionCount</a>, <a href="../../../../org/apache/mina/core/service/IoService.html#getManagedSessions()">getManagedSessions</a>, <a href="../../../../org/apache/mina/core/service/IoService.html#getScheduledWriteBytes()">getScheduledWriteBytes</a>, <a href="../../../../org/apache/mina/core/service/IoService.html#getScheduledWriteMessages()">getScheduledWriteMessages</a>, <a href="../../../../org/apache/mina/core/service/IoService.html#getSessionDataStructureFactory()">getSessionDataStructureFactory</a>, <a href="../../../../org/apache/mina/core/service/IoService.html#getStatistics()">getStatistics</a>, <a href="../../../../org/apache/mina/core/service/IoService.html#isActive()">isActive</a>, <a href="../../../../org/apache/mina/core/service/IoService.html#isDisposed()">isDisposed</a>, <a href="../../../../org/apache/mina/core/service/IoService.html#isDisposing()">isDisposing</a>, <a href="../../../../org/apache/mina/core/service/IoService.html#removeListener(org.apache.mina.core.service.IoServiceListener)">removeListener</a>, <a href="../../../../org/apache/mina/core/service/IoService.html#setFilterChainBuilder(org.apache.mina.core.filterchain.IoFilterChainBuilder)">setFilterChainBuilder</a>, <a href="../../../../org/apache/mina/core/service/IoService.html#setHandler(org.apache.mina.core.service.IoHandler)">setHandler</a>, <a href="../../../../org/apache/mina/core/service/IoService.html#setSessionDataStructureFactory(org.apache.mina.core.session.IoSessionDataStructureFactory)">setSessionDataStructureFactory</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="ProxyConnector()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ProxyConnector</h4>
<pre>public&nbsp;ProxyConnector()</pre>
<div class="block">Creates a new proxy connector.</div>
</li>
</ul>
<a name="ProxyConnector(org.apache.mina.transport.socket.SocketConnector)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ProxyConnector</h4>
<pre>public&nbsp;ProxyConnector(<a href="../../../../org/apache/mina/transport/socket/SocketConnector.html" title="interface in org.apache.mina.transport.socket">SocketConnector</a>&nbsp;connector)</pre>
<div class="block">Creates a new proxy connector.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>connector</code> - Connector used to establish proxy connections.</dd></dl>
</li>
</ul>
<a name="ProxyConnector(org.apache.mina.transport.socket.SocketConnector, org.apache.mina.core.session.IoSessionConfig, java.util.concurrent.Executor)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ProxyConnector</h4>
<pre>public&nbsp;ProxyConnector(<a href="../../../../org/apache/mina/transport/socket/SocketConnector.html" title="interface in org.apache.mina.transport.socket">SocketConnector</a>&nbsp;connector,
<a href="../../../../org/apache/mina/core/session/IoSessionConfig.html" title="interface in org.apache.mina.core.session">IoSessionConfig</a>&nbsp;config,
<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/util/concurrent/Executor.html?is-external=true" title="class or interface in java.util.concurrent">Executor</a>&nbsp;executor)</pre>
<div class="block">Creates a new proxy connector.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><code>AbstractIoConnector(IoSessionConfig, Executor).</code></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getSessionConfig()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSessionConfig</h4>
<pre>public&nbsp;<a href="../../../../org/apache/mina/core/session/IoSessionConfig.html" title="interface in org.apache.mina.core.session">IoSessionConfig</a>&nbsp;getSessionConfig()</pre>
<div class="block">Returns the default configuration of the new <a href="../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session"><code>IoSession</code></a>s
created by this service.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/mina/core/service/IoService.html#getSessionConfig()">getSessionConfig</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/mina/core/service/IoService.html" title="interface in org.apache.mina.core.service">IoService</a></code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../org/apache/mina/core/service/AbstractIoService.html#getSessionConfig()">getSessionConfig</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/mina/core/service/AbstractIoService.html" title="class in org.apache.mina.core.service">AbstractIoService</a></code></dd>
</dl>
</li>
</ul>
<a name="getProxyIoSession()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProxyIoSession</h4>
<pre>public&nbsp;<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> linked with this connector.</div>
</li>
</ul>
<a name="setProxyIoSession(org.apache.mina.proxy.session.ProxyIoSession)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setProxyIoSession</h4>
<pre>public&nbsp;void&nbsp;setProxyIoSession(<a href="../../../../org/apache/mina/proxy/session/ProxyIoSession.html" title="class in org.apache.mina.proxy.session">ProxyIoSession</a>&nbsp;proxyIoSession)</pre>
<div class="block">Sets the proxy session object of this connector.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>proxyIoSession</code> - the configuration of this connector.</dd></dl>
</li>
</ul>
<a name="connect0(java.net.SocketAddress, java.net.SocketAddress, org.apache.mina.core.session.IoSessionInitializer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connect0</h4>
<pre>protected&nbsp;<a href="../../../../org/apache/mina/core/future/ConnectFuture.html" title="interface in org.apache.mina.core.future">ConnectFuture</a>&nbsp;connect0(<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/net/SocketAddress.html?is-external=true" title="class or interface in java.net">SocketAddress</a>&nbsp;remoteAddress,
<a href="http://download.oracle.com/javase/1.5.0/docs/api/java/net/SocketAddress.html?is-external=true" title="class or interface in java.net">SocketAddress</a>&nbsp;localAddress,
<a href="../../../../org/apache/mina/core/session/IoSessionInitializer.html" title="interface in org.apache.mina.core.session">IoSessionInitializer</a>&lt;? extends <a href="../../../../org/apache/mina/core/future/ConnectFuture.html" title="interface in org.apache.mina.core.future">ConnectFuture</a>&gt;&nbsp;sessionInitializer)</pre>
<div class="block">Connects to the specified <code>address</code>. If communication starts
successfully, events are fired to the connector's <code>handler</code>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/mina/core/service/AbstractIoConnector.html#connect0(java.net.SocketAddress, java.net.SocketAddress, org.apache.mina.core.session.IoSessionInitializer)">connect0</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/mina/core/service/AbstractIoConnector.html" title="class in org.apache.mina.core.service">AbstractIoConnector</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>remoteAddress</code> - the remote address to connect to</dd><dd><code>localAddress</code> - the local address</dd><dd><code>sessionInitializer</code> - the session initializer</dd>
<dt><span class="strong">Returns:</span></dt><dd><a href="../../../../org/apache/mina/core/future/ConnectFuture.html" title="interface in org.apache.mina.core.future"><code>ConnectFuture</code></a> that will tell the result of the connection attempt</dd></dl>
</li>
</ul>
<a name="cancelConnectFuture()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cancelConnectFuture</h4>
<pre>public&nbsp;void&nbsp;cancelConnectFuture()</pre>
<div class="block">Cancels the real connection when reconnection is in use.</div>
</li>
</ul>
<a name="fireConnected(org.apache.mina.core.session.IoSession)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fireConnected</h4>
<pre>protected&nbsp;<a href="../../../../org/apache/mina/core/future/ConnectFuture.html" title="interface in org.apache.mina.core.future">ConnectFuture</a>&nbsp;fireConnected(<a href="../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session">IoSession</a>&nbsp;session)</pre>
<div class="block">Fires the connection event on the real future to notify the client.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>session</code> - the current session</dd>
<dt><span class="strong">Returns:</span></dt><dd>the future holding the connected session</dd></dl>
</li>
</ul>
<a name="getConnector()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConnector</h4>
<pre>public final&nbsp;<a href="../../../../org/apache/mina/transport/socket/SocketConnector.html" title="interface in org.apache.mina.transport.socket">SocketConnector</a>&nbsp;getConnector()</pre>
<div class="block">Get the <a href="../../../../org/apache/mina/transport/socket/SocketConnector.html" title="interface in org.apache.mina.transport.socket"><code>SocketConnector</code></a> to be used for connections
to the proxy server.</div>
</li>
</ul>
<a name="dispose0()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dispose0</h4>
<pre>protected&nbsp;void&nbsp;dispose0()
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">Implement this method to release any acquired resources. This method
is invoked only once by <a href="../../../../org/apache/mina/core/service/AbstractIoService.html#dispose()"><code>AbstractIoService.dispose()</code></a>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/mina/core/service/AbstractIoService.html#dispose0()">dispose0</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/mina/core/service/AbstractIoService.html" title="class in org.apache.mina.core.service">AbstractIoService</a></code></dd>
<dt><span class="strong">Throws:</span></dt>
<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>
<a name="getTransportMetadata()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getTransportMetadata</h4>
<pre>public&nbsp;<a href="../../../../org/apache/mina/core/service/TransportMetadata.html" title="interface in org.apache.mina.core.service">TransportMetadata</a>&nbsp;getTransportMetadata()</pre>
<div class="block">Returns the <a href="../../../../org/apache/mina/core/service/TransportMetadata.html" title="interface in org.apache.mina.core.service"><code>TransportMetadata</code></a> that this service runs on.</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><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/ProxyConnector.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/ProxyAuthException.html" title="class in org.apache.mina.proxy"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/mina/proxy/ProxyLogicHandler.html" title="interface in org.apache.mina.proxy"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/mina/proxy/ProxyConnector.html" target="_top">Frames</a></li>
<li><a href="ProxyConnector.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><a href="#nested_classes_inherited_from_class_org.apache.mina.core.service.AbstractIoService">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#fields_inherited_from_class_org.apache.mina.core.service.AbstractIoService">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>