blob: 0f242e9d482c4e4f58c961643718111863a3b89c [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 (1.8.0_92) on Thu Jun 07 14:26:31 EDT 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ProxyConfiguration.Proxy (Jetty :: Project 9.3.24.v20180605 API)</title>
<meta name="date" content="2018-06-07">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ProxyConfiguration.Proxy (Jetty :: Project 9.3.24.v20180605 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":6,"i7":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ProxyConfiguration.Proxy.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/eclipse/jetty/client/ProxyConfiguration.html" title="class in org.eclipse.jetty.client"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/eclipse/jetty/client/RedirectProtocolHandler.html" title="class in org.eclipse.jetty.client"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/eclipse/jetty/client/ProxyConfiguration.Proxy.html" target="_top">Frames</a></li>
<li><a href="ProxyConfiguration.Proxy.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&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.eclipse.jetty.client</div>
<h2 title="Class ProxyConfiguration.Proxy" class="title">Class ProxyConfiguration.Proxy</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.eclipse.jetty.client.ProxyConfiguration.Proxy</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../org/eclipse/jetty/client/HttpProxy.html" title="class in org.eclipse.jetty.client">HttpProxy</a>, <a href="../../../../org/eclipse/jetty/client/Socks4Proxy.html" title="class in org.eclipse.jetty.client">Socks4Proxy</a></dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../../../../org/eclipse/jetty/client/ProxyConfiguration.html" title="class in org.eclipse.jetty.client">ProxyConfiguration</a></dd>
</dl>
<hr>
<br>
<pre>public abstract static class <span class="typeNameLabel">ProxyConfiguration.Proxy</span>
extends java.lang.Object</pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" 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="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/client/ProxyConfiguration.Proxy.html#Proxy-org.eclipse.jetty.client.Origin.Address-boolean-">Proxy</a></span>(<a href="../../../../org/eclipse/jetty/client/Origin.Address.html" title="class in org.eclipse.jetty.client">Origin.Address</a>&nbsp;address,
boolean&nbsp;secure)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../org/eclipse/jetty/client/Origin.Address.html" title="class in org.eclipse.jetty.client">Origin.Address</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/client/ProxyConfiguration.Proxy.html#getAddress--">getAddress</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.util.Set&lt;java.lang.String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/client/ProxyConfiguration.Proxy.html#getExcludedAddresses--">getExcludedAddresses</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.util.Set&lt;java.lang.String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/client/ProxyConfiguration.Proxy.html#getIncludedAddresses--">getIncludedAddresses</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.net.URI</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/client/ProxyConfiguration.Proxy.html#getURI--">getURI</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/client/ProxyConfiguration.Proxy.html#isSecure--">isSecure</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/client/ProxyConfiguration.Proxy.html#matches-org.eclipse.jetty.client.Origin-">matches</a></span>(<a href="../../../../org/eclipse/jetty/client/Origin.html" title="class in org.eclipse.jetty.client">Origin</a>&nbsp;origin)</code>
<div class="block">Matches the given <code>origin</code> with the included and excluded addresses,
returning true if the given <code>origin</code> is to be proxied.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>abstract <a href="../../../../org/eclipse/jetty/io/ClientConnectionFactory.html" title="interface in org.eclipse.jetty.io">ClientConnectionFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/client/ProxyConfiguration.Proxy.html#newClientConnectionFactory-org.eclipse.jetty.io.ClientConnectionFactory-">newClientConnectionFactory</a></span>(<a href="../../../../org/eclipse/jetty/io/ClientConnectionFactory.html" title="interface in org.eclipse.jetty.io">ClientConnectionFactory</a>&nbsp;connectionFactory)</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/jetty/client/ProxyConfiguration.Proxy.html#toString--">toString</a></span>()</code>&nbsp;</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.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</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="Proxy-org.eclipse.jetty.client.Origin.Address-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Proxy</h4>
<pre>protected&nbsp;Proxy(<a href="../../../../org/eclipse/jetty/client/Origin.Address.html" title="class in org.eclipse.jetty.client">Origin.Address</a>&nbsp;address,
boolean&nbsp;secure)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getAddress--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAddress</h4>
<pre>public&nbsp;<a href="../../../../org/eclipse/jetty/client/Origin.Address.html" title="class in org.eclipse.jetty.client">Origin.Address</a>&nbsp;getAddress()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the address of this proxy</dd>
</dl>
</li>
</ul>
<a name="isSecure--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSecure</h4>
<pre>public&nbsp;boolean&nbsp;isSecure()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether the connection to the proxy must be secured via TLS</dd>
</dl>
</li>
</ul>
<a name="getIncludedAddresses--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIncludedAddresses</h4>
<pre>public&nbsp;java.util.Set&lt;java.lang.String&gt;&nbsp;getIncludedAddresses()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the list of origins that must be proxied</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/eclipse/jetty/client/ProxyConfiguration.Proxy.html#matches-org.eclipse.jetty.client.Origin-"><code>matches(Origin)</code></a>,
<a href="../../../../org/eclipse/jetty/client/ProxyConfiguration.Proxy.html#getExcludedAddresses--"><code>getExcludedAddresses()</code></a></dd>
</dl>
</li>
</ul>
<a name="getExcludedAddresses--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExcludedAddresses</h4>
<pre>public&nbsp;java.util.Set&lt;java.lang.String&gt;&nbsp;getExcludedAddresses()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the list of origins that must not be proxied.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/eclipse/jetty/client/ProxyConfiguration.Proxy.html#matches-org.eclipse.jetty.client.Origin-"><code>matches(Origin)</code></a>,
<a href="../../../../org/eclipse/jetty/client/ProxyConfiguration.Proxy.html#getIncludedAddresses--"><code>getIncludedAddresses()</code></a></dd>
</dl>
</li>
</ul>
<a name="getURI--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getURI</h4>
<pre>public&nbsp;java.net.URI&nbsp;getURI()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an URI representing this proxy, or null if no URI can represent this proxy</dd>
</dl>
</li>
</ul>
<a name="matches-org.eclipse.jetty.client.Origin-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>matches</h4>
<pre>public&nbsp;boolean&nbsp;matches(<a href="../../../../org/eclipse/jetty/client/Origin.html" title="class in org.eclipse.jetty.client">Origin</a>&nbsp;origin)</pre>
<div class="block">Matches the given <code>origin</code> with the included and excluded addresses,
returning true if the given <code>origin</code> is to be proxied.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>origin</code> - the origin to test for proxying</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the origin must be proxied, false otherwise</dd>
</dl>
</li>
</ul>
<a name="newClientConnectionFactory-org.eclipse.jetty.io.ClientConnectionFactory-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newClientConnectionFactory</h4>
<pre>public abstract&nbsp;<a href="../../../../org/eclipse/jetty/io/ClientConnectionFactory.html" title="interface in org.eclipse.jetty.io">ClientConnectionFactory</a>&nbsp;newClientConnectionFactory(<a href="../../../../org/eclipse/jetty/io/ClientConnectionFactory.html" title="interface in org.eclipse.jetty.io">ClientConnectionFactory</a>&nbsp;connectionFactory)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>connectionFactory</code> - the nested <a href="../../../../org/eclipse/jetty/io/ClientConnectionFactory.html" title="interface in org.eclipse.jetty.io"><code>ClientConnectionFactory</code></a></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new <a href="../../../../org/eclipse/jetty/io/ClientConnectionFactory.html" title="interface in org.eclipse.jetty.io"><code>ClientConnectionFactory</code></a> for this <a href="../../../../org/eclipse/jetty/client/ProxyConfiguration.Proxy.html" title="class in org.eclipse.jetty.client"><code>ProxyConfiguration.Proxy</code></a></dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</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>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ProxyConfiguration.Proxy.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/eclipse/jetty/client/ProxyConfiguration.html" title="class in org.eclipse.jetty.client"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/eclipse/jetty/client/RedirectProtocolHandler.html" title="class in org.eclipse.jetty.client"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/eclipse/jetty/client/ProxyConfiguration.Proxy.html" target="_top">Frames</a></li>
<li><a href="ProxyConfiguration.Proxy.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&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; 1995&#x2013;2018 <a href="http://webtide.com">Webtide</a>. All rights reserved.</small></p>
</body>
</html>