| <!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_66) on Fri Jan 15 14:33:43 CET 2016 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>ForwardingFilter (Apache Mina SSHD :: Core 1.1.0 API)</title> |
| <meta name="date" content="2016-01-15"> |
| <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="ForwardingFilter (Apache Mina SSHD :: Core 1.1.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/ForwardingFilter.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/sshd/server/forward/ForwardedTcpipFactory.html" title="class in org.apache.sshd.server.forward"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/sshd/server/forward/ForwardingFilter.Type.html" title="enum in org.apache.sshd.server.forward"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/sshd/server/forward/ForwardingFilter.html" target="_top">Frames</a></li> |
| <li><a href="ForwardingFilter.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: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.sshd.server.forward</div> |
| <h2 title="Interface ForwardingFilter" class="title">Interface ForwardingFilter</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../org/apache/sshd/server/forward/AcceptAllForwardingFilter.html" title="class in org.apache.sshd.server.forward">AcceptAllForwardingFilter</a>, <a href="../../../../../org/apache/sshd/server/forward/RejectAllForwardingFilter.html" title="class in org.apache.sshd.server.forward">RejectAllForwardingFilter</a>, <a href="../../../../../org/apache/sshd/server/forward/StaticDecisionForwardingFilter.html" title="class in org.apache.sshd.server.forward">StaticDecisionForwardingFilter</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">ForwardingFilter</span></pre> |
| <div class="block">Determines if a forwarding request will be permitted.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd><a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a></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> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Interface and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/server/forward/ForwardingFilter.Type.html" title="enum in org.apache.sshd.server.forward">ForwardingFilter.Type</a></span></code> |
| <div class="block">The type of requested connection forwarding.</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="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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </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>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/server/forward/ForwardingFilter.html#canConnect-org.apache.sshd.server.forward.ForwardingFilter.Type-org.apache.sshd.common.SshdSocketAddress-org.apache.sshd.common.session.Session-">canConnect</a></span>(<a href="../../../../../org/apache/sshd/server/forward/ForwardingFilter.Type.html" title="enum in org.apache.sshd.server.forward">ForwardingFilter.Type</a> type, |
| <a href="../../../../../org/apache/sshd/common/SshdSocketAddress.html" title="class in org.apache.sshd.common">SshdSocketAddress</a> address, |
| <a href="../../../../../org/apache/sshd/common/session/Session.html" title="interface in org.apache.sshd.common.session">Session</a> session)</code> |
| <div class="block"> |
| Determine if the session may create an outbound connection.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/server/forward/ForwardingFilter.html#canForwardAgent-org.apache.sshd.common.session.Session-">canForwardAgent</a></span>(<a href="../../../../../org/apache/sshd/common/session/Session.html" title="interface in org.apache.sshd.common.session">Session</a> session)</code> |
| <div class="block"> |
| Determine if the session may arrange for agent forwarding.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/server/forward/ForwardingFilter.html#canForwardX11-org.apache.sshd.common.session.Session-">canForwardX11</a></span>(<a href="../../../../../org/apache/sshd/common/session/Session.html" title="interface in org.apache.sshd.common.session">Session</a> session)</code> |
| <div class="block"> |
| Determine if the session may arrange for X11 forwarding.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/server/forward/ForwardingFilter.html#canListen-org.apache.sshd.common.SshdSocketAddress-org.apache.sshd.common.session.Session-">canListen</a></span>(<a href="../../../../../org/apache/sshd/common/SshdSocketAddress.html" title="class in org.apache.sshd.common">SshdSocketAddress</a> address, |
| <a href="../../../../../org/apache/sshd/common/session/Session.html" title="interface in org.apache.sshd.common.session">Session</a> session)</code> |
| <div class="block"> |
| Determine if the session may listen for inbound connections.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="canForwardAgent-org.apache.sshd.common.session.Session-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>canForwardAgent</h4> |
| <pre>boolean canForwardAgent(<a href="../../../../../org/apache/sshd/common/session/Session.html" title="interface in org.apache.sshd.common.session">Session</a> session)</pre> |
| <div class="block"><p> |
| Determine if the session may arrange for agent forwarding. |
| </p> |
| |
| <p> |
| This server process will open a new listen socket locally and export |
| the address in the <a href="../../../../../org/apache/sshd/agent/SshAgent.html#SSH_AUTHSOCKET_ENV_NAME"><code>SshAgent.SSH_AUTHSOCKET_ENV_NAME</code></a> environment |
| variable. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - The <a href="../../../../../org/apache/sshd/common/session/Session.html" title="interface in org.apache.sshd.common.session"><code>Session</code></a> requesting permission to forward the agent.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the agent forwarding is permitted, false if denied.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="canForwardX11-org.apache.sshd.common.session.Session-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>canForwardX11</h4> |
| <pre>boolean canForwardX11(<a href="../../../../../org/apache/sshd/common/session/Session.html" title="interface in org.apache.sshd.common.session">Session</a> session)</pre> |
| <div class="block"><p> |
| Determine if the session may arrange for X11 forwarding. |
| </p> |
| |
| <p> |
| This server process will open a new listen socket locally and export |
| the address in the environment so X11 clients can be tunneled to the |
| user's X11 display server. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - The <a href="../../../../../org/apache/sshd/common/session/Session.html" title="interface in org.apache.sshd.common.session"><code>Session</code></a> requesting permission to forward X11 connections.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the X11 forwarding is permitted, false if denied.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="canListen-org.apache.sshd.common.SshdSocketAddress-org.apache.sshd.common.session.Session-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>canListen</h4> |
| <pre>boolean canListen(<a href="../../../../../org/apache/sshd/common/SshdSocketAddress.html" title="class in org.apache.sshd.common">SshdSocketAddress</a> address, |
| <a href="../../../../../org/apache/sshd/common/session/Session.html" title="interface in org.apache.sshd.common.session">Session</a> session)</pre> |
| <div class="block"><p> |
| Determine if the session may listen for inbound connections. |
| </p> |
| |
| <p> |
| This server process will open a new listen socket on the address given |
| by the client (usually 127.0.0.1 but may be any address). Any inbound |
| connections to this socket will be tunneled over the session to the |
| client, which the client will then forward the connection to another |
| host on the client's side of the network. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>address</code> - address the client has requested this server listen |
| for inbound connections on, and relay them through the client.</dd> |
| <dd><code>session</code> - The <a href="../../../../../org/apache/sshd/common/session/Session.html" title="interface in org.apache.sshd.common.session"><code>Session</code></a> requesting permission to listen for connections.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the socket is permitted; false if it must be denied.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="canConnect-org.apache.sshd.server.forward.ForwardingFilter.Type-org.apache.sshd.common.SshdSocketAddress-org.apache.sshd.common.session.Session-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>canConnect</h4> |
| <pre>boolean canConnect(<a href="../../../../../org/apache/sshd/server/forward/ForwardingFilter.Type.html" title="enum in org.apache.sshd.server.forward">ForwardingFilter.Type</a> type, |
| <a href="../../../../../org/apache/sshd/common/SshdSocketAddress.html" title="class in org.apache.sshd.common">SshdSocketAddress</a> address, |
| <a href="../../../../../org/apache/sshd/common/session/Session.html" title="interface in org.apache.sshd.common.session">Session</a> session)</pre> |
| <div class="block"><p> |
| Determine if the session may create an outbound connection. |
| </p> |
| |
| <p> |
| This server process will connect to another server listening on the |
| address specified by the client. Usually this is to another port on |
| the same host (127.0.0.1) but may be to any other system this server |
| can reach on the server's side of the network. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>type</code> - The <a href="../../../../../org/apache/sshd/server/forward/ForwardingFilter.Type.html" title="enum in org.apache.sshd.server.forward"><code>ForwardingFilter.Type</code></a> of requested connection forwarding</dd> |
| <dd><code>address</code> - address the client has requested this server listen |
| for inbound connections on, and relay them through the client.</dd> |
| <dd><code>session</code> - session requesting permission to listen for connections.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the socket is permitted; false if it must be denied.</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/ForwardingFilter.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/sshd/server/forward/ForwardedTcpipFactory.html" title="class in org.apache.sshd.server.forward"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/sshd/server/forward/ForwardingFilter.Type.html" title="enum in org.apache.sshd.server.forward"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/sshd/server/forward/ForwardingFilter.html" target="_top">Frames</a></li> |
| <li><a href="ForwardingFilter.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: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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 © 2008–2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
