| <!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:42 CET 2016 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>ChannelRequestHandler (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="ChannelRequestHandler (Apache Mina SSHD :: Core 1.1.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":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/ChannelRequestHandler.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/common/channel/ChannelPipedSink.html" title="interface in org.apache.sshd.common.channel"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/sshd/common/channel/IoWriteFutureImpl.html" title="class in org.apache.sshd.common.channel"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/sshd/common/channel/ChannelRequestHandler.html" target="_top">Frames</a></li> |
| <li><a href="ChannelRequestHandler.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>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </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.common.channel</div> |
| <h2 title="Interface ChannelRequestHandler" class="title">Interface ChannelRequestHandler</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../../../org/apache/sshd/common/channel/RequestHandler.html" title="interface in org.apache.sshd.common.channel">RequestHandler</a><<a href="../../../../../org/apache/sshd/common/channel/Channel.html" title="interface in org.apache.sshd.common.channel">Channel</a>></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../org/apache/sshd/client/channel/exit/AbstractChannelExitRequestHandler.html" title="class in org.apache.sshd.client.channel.exit">AbstractChannelExitRequestHandler</a>, <a href="../../../../../org/apache/sshd/common/channel/AbstractChannelRequestHandler.html" title="class in org.apache.sshd.common.channel">AbstractChannelRequestHandler</a>, <a href="../../../../../org/apache/sshd/client/channel/exit/ExitSignalChannelRequestHandler.html" title="class in org.apache.sshd.client.channel.exit">ExitSignalChannelRequestHandler</a>, <a href="../../../../../org/apache/sshd/client/channel/exit/ExitStatusChannelRequestHandler.html" title="class in org.apache.sshd.client.channel.exit">ExitStatusChannelRequestHandler</a>, <a href="../../../../../org/apache/sshd/server/channel/PuttyRequestHandler.html" title="class in org.apache.sshd.server.channel">PuttyRequestHandler</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">ChannelRequestHandler</span> |
| extends <a href="../../../../../org/apache/sshd/common/channel/RequestHandler.html" title="interface in org.apache.sshd.common.channel">RequestHandler</a><<a href="../../../../../org/apache/sshd/common/channel/Channel.html" title="interface in org.apache.sshd.common.channel">Channel</a>></pre> |
| <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> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.sshd.common.channel.RequestHandler"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.apache.sshd.common.channel.<a href="../../../../../org/apache/sshd/common/channel/RequestHandler.html" title="interface in org.apache.sshd.common.channel">RequestHandler</a></h3> |
| <code><a href="../../../../../org/apache/sshd/common/channel/RequestHandler.Result.html" title="enum in org.apache.sshd.common.channel">RequestHandler.Result</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </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="../../../../../org/apache/sshd/common/util/Transformer.html" title="interface in org.apache.sshd.common.util">Transformer</a><<a href="../../../../../org/apache/sshd/common/channel/ChannelRequestHandler.html" title="interface in org.apache.sshd.common.channel">ChannelRequestHandler</a>,<a href="../../../../../org/apache/sshd/common/channel/RequestHandler.html" title="interface in org.apache.sshd.common.channel">RequestHandler</a><<a href="../../../../../org/apache/sshd/common/channel/Channel.html" title="interface in org.apache.sshd.common.channel">Channel</a>>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/channel/ChannelRequestHandler.html#CHANN2HNDLR">CHANN2HNDLR</a></span></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="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><a href="../../../../../org/apache/sshd/common/channel/RequestHandler.Result.html" title="enum in org.apache.sshd.common.channel">RequestHandler.Result</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/channel/ChannelRequestHandler.html#process-org.apache.sshd.common.channel.Channel-java.lang.String-boolean-org.apache.sshd.common.util.buffer.Buffer-">process</a></span>(<a href="../../../../../org/apache/sshd/common/channel/Channel.html" title="interface in org.apache.sshd.common.channel">Channel</a> channel, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> request, |
| boolean wantReply, |
| <a href="../../../../../org/apache/sshd/common/util/buffer/Buffer.html" title="class in org.apache.sshd.common.util.buffer">Buffer</a> buffer)</code> |
| <div class="block">Process an SSH request.</div> |
| </td> |
| </tr> |
| </table> |
| </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="CHANN2HNDLR"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>CHANN2HNDLR</h4> |
| <pre>static final <a href="../../../../../org/apache/sshd/common/util/Transformer.html" title="interface in org.apache.sshd.common.util">Transformer</a><<a href="../../../../../org/apache/sshd/common/channel/ChannelRequestHandler.html" title="interface in org.apache.sshd.common.channel">ChannelRequestHandler</a>,<a href="../../../../../org/apache/sshd/common/channel/RequestHandler.html" title="interface in org.apache.sshd.common.channel">RequestHandler</a><<a href="../../../../../org/apache/sshd/common/channel/Channel.html" title="interface in org.apache.sshd.common.channel">Channel</a>>> CHANN2HNDLR</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="process-org.apache.sshd.common.channel.Channel-java.lang.String-boolean-org.apache.sshd.common.util.buffer.Buffer-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>process</h4> |
| <pre><a href="../../../../../org/apache/sshd/common/channel/RequestHandler.Result.html" title="enum in org.apache.sshd.common.channel">RequestHandler.Result</a> process(<a href="../../../../../org/apache/sshd/common/channel/Channel.html" title="interface in org.apache.sshd.common.channel">Channel</a> channel, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> request, |
| boolean wantReply, |
| <a href="../../../../../org/apache/sshd/common/util/buffer/Buffer.html" title="class in org.apache.sshd.common.util.buffer">Buffer</a> buffer) |
| throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/sshd/common/channel/RequestHandler.html#process-T-java.lang.String-boolean-org.apache.sshd.common.util.buffer.Buffer-">RequestHandler</a></code></span></div> |
| <div class="block">Process an SSH request. If an exception is thrown, the ConnectionService |
| will send a failure message if needed and the request will be considered handled.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/sshd/common/channel/RequestHandler.html#process-T-java.lang.String-boolean-org.apache.sshd.common.util.buffer.Buffer-">process</a></code> in interface <code><a href="../../../../../org/apache/sshd/common/channel/RequestHandler.html" title="interface in org.apache.sshd.common.channel">RequestHandler</a><<a href="../../../../../org/apache/sshd/common/channel/Channel.html" title="interface in org.apache.sshd.common.channel">Channel</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>channel</code> - The input parameter</dd> |
| <dd><code>request</code> - The request string</dd> |
| <dd><code>wantReply</code> - Whether a reply is requested</dd> |
| <dd><code>buffer</code> - The <a href="../../../../../org/apache/sshd/common/util/buffer/Buffer.html" title="class in org.apache.sshd.common.util.buffer"><code>Buffer</code></a> with request specific data</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The <a href="../../../../../org/apache/sshd/common/channel/RequestHandler.Result.html" title="enum in org.apache.sshd.common.channel"><code>RequestHandler.Result</code></a></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - If failed to handle the request - <B>Note:</B> in |
| order to signal an unsupported request the <a href="../../../../../org/apache/sshd/common/channel/RequestHandler.Result.html#Unsupported"><code>RequestHandler.Result.Unsupported</code></a> |
| value should be returned</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/ChannelRequestHandler.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/common/channel/ChannelPipedSink.html" title="interface in org.apache.sshd.common.channel"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/sshd/common/channel/IoWriteFutureImpl.html" title="class in org.apache.sshd.common.channel"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/sshd/common/channel/ChannelRequestHandler.html" target="_top">Frames</a></li> |
| <li><a href="ChannelRequestHandler.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>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </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> |
