blob: fd5204ebec818665bf442e4d7261ff2eba554653 [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_55) on Mon Sep 15 17:28:20 CEST 2014 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>ProxyIoSession (Apache MINA 2.0.8 API)</title>
<meta name="date" content="2014-09-15">
<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="ProxyIoSession (Apache MINA 2.0.8 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/ProxyIoSession.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>Prev Class</li>
<li><a href="../../../../../org/apache/mina/proxy/session/ProxyIoSessionInitializer.html" title="class in org.apache.mina.proxy.session"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/mina/proxy/session/ProxyIoSession.html" target="_top">Frames</a></li>
<li><a href="ProxyIoSession.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="#field_summary">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><a href="#field_detail">Field</a>&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.session</div>
<h2 title="Class ProxyIoSession" class="title">Class ProxyIoSession</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.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>org.apache.mina.proxy.session.ProxyIoSession</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">ProxyIoSession</span>
extends <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">ProxyIoSession.java - Class that contains all informations for the current proxy
authentication session.</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>
<table class="overviewSummary" 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="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/mina/proxy/session/ProxyIoSession.html#PROXY_SESSION">PROXY_SESSION</a></strong></code>&nbsp;</td>
</tr>
</table>
</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/session/ProxyIoSession.html#ProxyIoSession(java.net.InetSocketAddress, org.apache.mina.proxy.handlers.ProxyRequest)">ProxyIoSession</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/net/InetSocketAddress.html?is-external=true" title="class or interface in java.net">InetSocketAddress</a>&nbsp;proxyAddress,
<a href="../../../../../org/apache/mina/proxy/handlers/ProxyRequest.html" title="class in org.apache.mina.proxy.handlers">ProxyRequest</a>&nbsp;request)</code>
<div class="block">Constructor.</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><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/mina/proxy/session/ProxyIoSession.html#getCharset()">getCharset</a></strong>()</code>
<div class="block">Returns a charset instance of the in use charset name.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/mina/proxy/session/ProxyIoSession.html#getCharsetName()">getCharsetName</a></strong>()</code>
<div class="block">Returns the used charset name or <a href="../../../../../org/apache/mina/proxy/session/ProxyIoSession.html#DEFAULT_ENCODING"><code>DEFAULT_ENCODING</code></a> if null.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/mina/proxy/ProxyConnector.html" title="class in org.apache.mina.proxy">ProxyConnector</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/mina/proxy/session/ProxyIoSession.html#getConnector()">getConnector</a></strong>()</code>
<div class="block">Returns the proxy connector.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/mina/proxy/event/IoSessionEventQueue.html" title="class in org.apache.mina.proxy.event">IoSessionEventQueue</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/mina/proxy/session/ProxyIoSession.html#getEventQueue()">getEventQueue</a></strong>()</code>
<div class="block">Returns the pending event queue.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/mina/proxy/ProxyLogicHandler.html" title="interface in org.apache.mina.proxy">ProxyLogicHandler</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/mina/proxy/session/ProxyIoSession.html#getHandler()">getHandler</a></strong>()</code>
<div class="block">Returns the <a href="../../../../../org/apache/mina/proxy/ProxyLogicHandler.html" title="interface in org.apache.mina.proxy"><code>ProxyLogicHandler</code></a> currently in use.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/apache/mina/proxy/handlers/http/HttpAuthenticationMethods.html" title="enum in org.apache.mina.proxy.handlers.http">HttpAuthenticationMethods</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/mina/proxy/session/ProxyIoSession.html#getPreferedOrder()">getPreferedOrder</a></strong>()</code>
<div class="block">Returns the list of the prefered order for the authentication methods.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/net/InetSocketAddress.html?is-external=true" title="class or interface in java.net">InetSocketAddress</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/mina/proxy/session/ProxyIoSession.html#getProxyAddress()">getProxyAddress</a></strong>()</code>
<div class="block">Returns the IP address of the proxy server.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/mina/proxy/filter/ProxyFilter.html" title="class in org.apache.mina.proxy.filter">ProxyFilter</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/mina/proxy/session/ProxyIoSession.html#getProxyFilter()">getProxyFilter</a></strong>()</code>
<div class="block">Returns the <a href="../../../../../org/apache/mina/proxy/filter/ProxyFilter.html" title="class in org.apache.mina.proxy.filter"><code>ProxyFilter</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/mina/proxy/handlers/ProxyRequest.html" title="class in org.apache.mina.proxy.handlers">ProxyRequest</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/mina/proxy/session/ProxyIoSession.html#getRequest()">getRequest</a></strong>()</code>
<div class="block">Returns the proxy request.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session">IoSession</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/mina/proxy/session/ProxyIoSession.html#getSession()">getSession</a></strong>()</code>
<div class="block">Returns the current <a href="../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session"><code>IoSession</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/mina/proxy/session/ProxyIoSession.html#isAuthenticationFailed()">isAuthenticationFailed</a></strong>()</code>
<div class="block">Returns true if authentication failed.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/mina/proxy/session/ProxyIoSession.html#isReconnectionNeeded()">isReconnectionNeeded</a></strong>()</code>
<div class="block">Returns true if the current authentication process is not finished
but the server has closed the connection.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/mina/proxy/session/ProxyIoSession.html#setAuthenticationFailed(boolean)">setAuthenticationFailed</a></strong>(boolean&nbsp;authenticationFailed)</code>
<div class="block">Sets the authentication failed flag.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/mina/proxy/session/ProxyIoSession.html#setCharsetName(java.lang.String)">setCharsetName</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;charsetName)</code>
<div class="block">Sets the charset to use.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/mina/proxy/session/ProxyIoSession.html#setConnector(org.apache.mina.proxy.ProxyConnector)">setConnector</a></strong>(<a href="../../../../../org/apache/mina/proxy/ProxyConnector.html" title="class in org.apache.mina.proxy">ProxyConnector</a>&nbsp;connector)</code>
<div class="block">Sets the connector reference of this proxy session.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/mina/proxy/session/ProxyIoSession.html#setHandler(org.apache.mina.proxy.ProxyLogicHandler)">setHandler</a></strong>(<a href="../../../../../org/apache/mina/proxy/ProxyLogicHandler.html" title="interface in org.apache.mina.proxy">ProxyLogicHandler</a>&nbsp;handler)</code>
<div class="block">Sets the <a href="../../../../../org/apache/mina/proxy/ProxyLogicHandler.html" title="interface in org.apache.mina.proxy"><code>ProxyLogicHandler</code></a> to use.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/mina/proxy/session/ProxyIoSession.html#setPreferedOrder(java.util.List)">setPreferedOrder</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/apache/mina/proxy/handlers/http/HttpAuthenticationMethods.html" title="enum in org.apache.mina.proxy.handlers.http">HttpAuthenticationMethods</a>&gt;&nbsp;preferedOrder)</code>
<div class="block">Sets the ordered list of prefered authentication mechanisms.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/mina/proxy/session/ProxyIoSession.html#setProxyFilter(org.apache.mina.proxy.filter.ProxyFilter)">setProxyFilter</a></strong>(<a href="../../../../../org/apache/mina/proxy/filter/ProxyFilter.html" title="class in org.apache.mina.proxy.filter">ProxyFilter</a>&nbsp;proxyFilter)</code>
<div class="block">Sets the <a href="../../../../../org/apache/mina/proxy/filter/ProxyFilter.html" title="class in org.apache.mina.proxy.filter"><code>ProxyFilter</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/mina/proxy/session/ProxyIoSession.html#setReconnectionNeeded(boolean)">setReconnectionNeeded</a></strong>(boolean&nbsp;reconnectionNeeded)</code>
<div class="block">Sets the reconnection needed flag.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/mina/proxy/session/ProxyIoSession.html#setSession(org.apache.mina.core.session.IoSession)">setSession</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">Sets the <a href="../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session"><code>IoSession</code></a> in use.</div>
</td>
</tr>
</table>
<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://docs.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://docs.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://docs.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://docs.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://docs.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://docs.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://docs.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://docs.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://docs.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://docs.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://docs.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://docs.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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="PROXY_SESSION">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PROXY_SESSION</h4>
<pre>public static final&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> PROXY_SESSION</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ProxyIoSession(java.net.InetSocketAddress, org.apache.mina.proxy.handlers.ProxyRequest)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ProxyIoSession</h4>
<pre>public&nbsp;ProxyIoSession(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/net/InetSocketAddress.html?is-external=true" title="class or interface in java.net">InetSocketAddress</a>&nbsp;proxyAddress,
<a href="../../../../../org/apache/mina/proxy/handlers/ProxyRequest.html" title="class in org.apache.mina.proxy.handlers">ProxyRequest</a>&nbsp;request)</pre>
<div class="block">Constructor.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>proxyAddress</code> - the IP address of the proxy server</dd><dd><code>request</code> - the proxy request</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="getEventQueue()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEventQueue</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/mina/proxy/event/IoSessionEventQueue.html" title="class in org.apache.mina.proxy.event">IoSessionEventQueue</a>&nbsp;getEventQueue()</pre>
<div class="block">Returns the pending event queue.</div>
</li>
</ul>
<a name="getPreferedOrder()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPreferedOrder</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/apache/mina/proxy/handlers/http/HttpAuthenticationMethods.html" title="enum in org.apache.mina.proxy.handlers.http">HttpAuthenticationMethods</a>&gt;&nbsp;getPreferedOrder()</pre>
<div class="block">Returns the list of the prefered order for the authentication methods.
This list is used by the <a href="../../../../../org/apache/mina/proxy/handlers/http/HttpSmartProxyHandler.html" title="class in org.apache.mina.proxy.handlers.http"><code>HttpSmartProxyHandler</code></a> to determine
which authentication mechanism to use first between those accepted by the
proxy server. This list is only used when connecting to an http proxy.</div>
</li>
</ul>
<a name="setPreferedOrder(java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPreferedOrder</h4>
<pre>public&nbsp;void&nbsp;setPreferedOrder(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../org/apache/mina/proxy/handlers/http/HttpAuthenticationMethods.html" title="enum in org.apache.mina.proxy.handlers.http">HttpAuthenticationMethods</a>&gt;&nbsp;preferedOrder)</pre>
<div class="block">Sets the ordered list of prefered authentication mechanisms.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>preferedOrder</code> - the ordered list</dd></dl>
</li>
</ul>
<a name="getHandler()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHandler</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/mina/proxy/ProxyLogicHandler.html" title="interface in org.apache.mina.proxy">ProxyLogicHandler</a>&nbsp;getHandler()</pre>
<div class="block">Returns the <a href="../../../../../org/apache/mina/proxy/ProxyLogicHandler.html" title="interface in org.apache.mina.proxy"><code>ProxyLogicHandler</code></a> currently in use.</div>
</li>
</ul>
<a name="setHandler(org.apache.mina.proxy.ProxyLogicHandler)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setHandler</h4>
<pre>public&nbsp;void&nbsp;setHandler(<a href="../../../../../org/apache/mina/proxy/ProxyLogicHandler.html" title="interface in org.apache.mina.proxy">ProxyLogicHandler</a>&nbsp;handler)</pre>
<div class="block">Sets the <a href="../../../../../org/apache/mina/proxy/ProxyLogicHandler.html" title="interface in org.apache.mina.proxy"><code>ProxyLogicHandler</code></a> to use.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>handler</code> - the <a href="../../../../../org/apache/mina/proxy/ProxyLogicHandler.html" title="interface in org.apache.mina.proxy"><code>ProxyLogicHandler</code></a> instance</dd></dl>
</li>
</ul>
<a name="getProxyFilter()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProxyFilter</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/mina/proxy/filter/ProxyFilter.html" title="class in org.apache.mina.proxy.filter">ProxyFilter</a>&nbsp;getProxyFilter()</pre>
<div class="block">Returns the <a href="../../../../../org/apache/mina/proxy/filter/ProxyFilter.html" title="class in org.apache.mina.proxy.filter"><code>ProxyFilter</code></a>.</div>
</li>
</ul>
<a name="setProxyFilter(org.apache.mina.proxy.filter.ProxyFilter)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setProxyFilter</h4>
<pre>public&nbsp;void&nbsp;setProxyFilter(<a href="../../../../../org/apache/mina/proxy/filter/ProxyFilter.html" title="class in org.apache.mina.proxy.filter">ProxyFilter</a>&nbsp;proxyFilter)</pre>
<div class="block">Sets the <a href="../../../../../org/apache/mina/proxy/filter/ProxyFilter.html" title="class in org.apache.mina.proxy.filter"><code>ProxyFilter</code></a>.
Note : Please do not call this method from your code it could result
in an unexpected behaviour.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>proxyFilter</code> - the filter</dd></dl>
</li>
</ul>
<a name="getRequest()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRequest</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/mina/proxy/handlers/ProxyRequest.html" title="class in org.apache.mina.proxy.handlers">ProxyRequest</a>&nbsp;getRequest()</pre>
<div class="block">Returns the proxy request.</div>
</li>
</ul>
<a name="getSession()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSession</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session">IoSession</a>&nbsp;getSession()</pre>
<div class="block">Returns the current <a href="../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session"><code>IoSession</code></a>.</div>
</li>
</ul>
<a name="setSession(org.apache.mina.core.session.IoSession)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSession</h4>
<pre>public&nbsp;void&nbsp;setSession(<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">Sets the <a href="../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session"><code>IoSession</code></a> in use.
Note : Please do not call this method from your code it could result in an
unexpected behaviour.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>session</code> - the current io session</dd></dl>
</li>
</ul>
<a name="getConnector()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConnector</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/mina/proxy/ProxyConnector.html" title="class in org.apache.mina.proxy">ProxyConnector</a>&nbsp;getConnector()</pre>
<div class="block">Returns the proxy connector.</div>
</li>
</ul>
<a name="setConnector(org.apache.mina.proxy.ProxyConnector)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setConnector</h4>
<pre>public&nbsp;void&nbsp;setConnector(<a href="../../../../../org/apache/mina/proxy/ProxyConnector.html" title="class in org.apache.mina.proxy">ProxyConnector</a>&nbsp;connector)</pre>
<div class="block">Sets the connector reference of this proxy session.
Note : Please do not call this method from your code it could result in an
unexpected behaviour.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>connector</code> - the proxy connector</dd></dl>
</li>
</ul>
<a name="getProxyAddress()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProxyAddress</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/net/InetSocketAddress.html?is-external=true" title="class or interface in java.net">InetSocketAddress</a>&nbsp;getProxyAddress()</pre>
<div class="block">Returns the IP address of the proxy server.</div>
</li>
</ul>
<a name="isReconnectionNeeded()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isReconnectionNeeded</h4>
<pre>public&nbsp;boolean&nbsp;isReconnectionNeeded()</pre>
<div class="block">Returns true if the current authentication process is not finished
but the server has closed the connection.</div>
</li>
</ul>
<a name="setReconnectionNeeded(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setReconnectionNeeded</h4>
<pre>public&nbsp;void&nbsp;setReconnectionNeeded(boolean&nbsp;reconnectionNeeded)</pre>
<div class="block">Sets the reconnection needed flag. If set to true, it means that an
authentication process is currently running but the proxy server did not
kept the connection alive. So we need to reconnect to the server to complete
the process.
Note : Please do not call this method from your code it could result in an
unexpected behaviour.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>reconnectionNeeded</code> - the value to set the flag to</dd></dl>
</li>
</ul>
<a name="getCharset()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCharset</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a>&nbsp;getCharset()</pre>
<div class="block">Returns a charset instance of the in use charset name.</div>
</li>
</ul>
<a name="getCharsetName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCharsetName</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getCharsetName()</pre>
<div class="block">Returns the used charset name or <a href="../../../../../org/apache/mina/proxy/session/ProxyIoSession.html#DEFAULT_ENCODING"><code>DEFAULT_ENCODING</code></a> if null.</div>
</li>
</ul>
<a name="setCharsetName(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCharsetName</h4>
<pre>public&nbsp;void&nbsp;setCharsetName(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;charsetName)</pre>
<div class="block">Sets the charset to use.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>charsetName</code> - the charset name</dd></dl>
</li>
</ul>
<a name="isAuthenticationFailed()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAuthenticationFailed</h4>
<pre>public&nbsp;boolean&nbsp;isAuthenticationFailed()</pre>
<div class="block">Returns true if authentication failed.</div>
</li>
</ul>
<a name="setAuthenticationFailed(boolean)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setAuthenticationFailed</h4>
<pre>public&nbsp;void&nbsp;setAuthenticationFailed(boolean&nbsp;authenticationFailed)</pre>
<div class="block">Sets the authentication failed flag.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>authenticationFailed</code> - the value to set the flag to</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/ProxyIoSession.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>Prev Class</li>
<li><a href="../../../../../org/apache/mina/proxy/session/ProxyIoSessionInitializer.html" title="class in org.apache.mina.proxy.session"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/mina/proxy/session/ProxyIoSession.html" target="_top">Frames</a></li>
<li><a href="ProxyIoSession.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="#field_summary">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><a href="#field_detail">Field</a>&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&#x2013;2014 <a href="http://mina.apache.org/">Apache MINA Project</a>. All rights reserved.</small></p>
</body>
</html>