blob: 705289f07b6ab9546f87f30d00bf2b0c7cb9de35 [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_66) on Fri Jan 15 14:33:43 CET 2016 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ScpCommandFactory (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="ScpCommandFactory (Apache Mina SSHD :: Core 1.1.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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/ScpCommandFactory.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/scp/ScpCommand.html" title="class in org.apache.sshd.server.scp"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/sshd/server/scp/ScpCommandFactory.Builder.html" title="class in org.apache.sshd.server.scp"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/sshd/server/scp/ScpCommandFactory.html" target="_top">Frames</a></li>
<li><a href="ScpCommandFactory.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><a href="#nested.class.summary">Nested</a>&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.apache.sshd.server.scp</div>
<h2 title="Class ScpCommandFactory" class="title">Class ScpCommandFactory</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/7/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.sshd.server.scp.ScpCommandFactory</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a>, <a href="../../../../../org/apache/sshd/common/util/threads/ExecutorServiceCarrier.html" title="interface in org.apache.sshd.common.util.threads">ExecutorServiceCarrier</a>, <a href="../../../../../org/apache/sshd/common/util/threads/ExecutorServiceConfigurer.html" title="interface in org.apache.sshd.common.util.threads">ExecutorServiceConfigurer</a>, <a href="../../../../../org/apache/sshd/server/CommandFactory.html" title="interface in org.apache.sshd.server">CommandFactory</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">ScpCommandFactory</span>
extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="../../../../../org/apache/sshd/server/CommandFactory.html" title="interface in org.apache.sshd.server">CommandFactory</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a>, <a href="../../../../../org/apache/sshd/common/util/threads/ExecutorServiceConfigurer.html" title="interface in org.apache.sshd.common.util.threads">ExecutorServiceConfigurer</a></pre>
<div class="block">This <code>CommandFactory</code> can be used as a standalone command factory
or can be used to augment another <code>CommandFactory</code> and provides
<code>SCP</code> support.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd><a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/sshd/server/scp/ScpCommand.html" title="class in org.apache.sshd.server.scp"><code>ScpCommand</code></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">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/server/scp/ScpCommandFactory.Builder.html" title="class in org.apache.sshd.server.scp">ScpCommandFactory.Builder</a></span></code>
<div class="block">A useful <a href="../../../../../org/apache/sshd/common/util/ObjectBuilder.html" title="interface in org.apache.sshd.common.util"><code>ObjectBuilder</code></a> for <a href="../../../../../org/apache/sshd/server/scp/ScpCommandFactory.html" title="class in org.apache.sshd.server.scp"><code>ScpCommandFactory</code></a></div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== 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="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/server/scp/ScpCommandFactory.html#ScpCommandFactory--">ScpCommandFactory</a></span>()</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="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>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/server/scp/ScpCommandFactory.html#addEventListener-org.apache.sshd.common.scp.ScpTransferEventListener-">addEventListener</a></span>(<a href="../../../../../org/apache/sshd/common/scp/ScpTransferEventListener.html" title="interface in org.apache.sshd.common.scp">ScpTransferEventListener</a>&nbsp;listener)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/sshd/server/scp/ScpCommandFactory.html" title="class in org.apache.sshd.server.scp">ScpCommandFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/server/scp/ScpCommandFactory.html#clone--">clone</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/sshd/server/Command.html" title="interface in org.apache.sshd.server">Command</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/server/scp/ScpCommandFactory.html#createCommand-java.lang.String-">createCommand</a></span>(<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>&nbsp;command)</code>
<div class="block">Parses a command string and verifies that the basic syntax is
correct.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/sshd/server/CommandFactory.html" title="interface in org.apache.sshd.server">CommandFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/server/scp/ScpCommandFactory.html#getDelegateCommandFactory--">getDelegateCommandFactory</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/ExecutorService.html?is-external=true" title="class or interface in java.util.concurrent">ExecutorService</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/server/scp/ScpCommandFactory.html#getExecutorService--">getExecutorService</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/server/scp/ScpCommandFactory.html#getReceiveBufferSize--">getReceiveBufferSize</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/server/scp/ScpCommandFactory.html#getSendBufferSize--">getSendBufferSize</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/server/scp/ScpCommandFactory.html#isShutdownOnExit--">isShutdownOnExit</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/server/scp/ScpCommandFactory.html#removeEventListener-org.apache.sshd.common.scp.ScpTransferEventListener-">removeEventListener</a></span>(<a href="../../../../../org/apache/sshd/common/scp/ScpTransferEventListener.html" title="interface in org.apache.sshd.common.scp">ScpTransferEventListener</a>&nbsp;listener)</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/server/scp/ScpCommandFactory.html#setDelegateCommandFactory-org.apache.sshd.server.CommandFactory-">setDelegateCommandFactory</a></span>(<a href="../../../../../org/apache/sshd/server/CommandFactory.html" title="interface in org.apache.sshd.server">CommandFactory</a>&nbsp;factory)</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/server/scp/ScpCommandFactory.html#setExecutorService-java.util.concurrent.ExecutorService-">setExecutorService</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/ExecutorService.html?is-external=true" title="class or interface in java.util.concurrent">ExecutorService</a>&nbsp;service)</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/server/scp/ScpCommandFactory.html#setReceiveBufferSize-int-">setReceiveBufferSize</a></span>(int&nbsp;receiveSize)</code>&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/server/scp/ScpCommandFactory.html#setSendBufferSize-int-">setSendBufferSize</a></span>(int&nbsp;sendSize)</code>&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/server/scp/ScpCommandFactory.html#setShutdownOnExit-boolean-">setShutdownOnExit</a></span>(boolean&nbsp;shutdown)</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.<a href="http://docs.oracle.com/javase/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ScpCommandFactory--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ScpCommandFactory</h4>
<pre>public&nbsp;ScpCommandFactory()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getDelegateCommandFactory--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDelegateCommandFactory</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/sshd/server/CommandFactory.html" title="interface in org.apache.sshd.server">CommandFactory</a>&nbsp;getDelegateCommandFactory()</pre>
</li>
</ul>
<a name="setDelegateCommandFactory-org.apache.sshd.server.CommandFactory-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDelegateCommandFactory</h4>
<pre>public&nbsp;void&nbsp;setDelegateCommandFactory(<a href="../../../../../org/apache/sshd/server/CommandFactory.html" title="interface in org.apache.sshd.server">CommandFactory</a>&nbsp;factory)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>factory</code> - A <a href="../../../../../org/apache/sshd/server/CommandFactory.html" title="interface in org.apache.sshd.server"><code>CommandFactory</code></a> to be used if the
command is not an SCP one. If <code>null</code> then an <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang"><code>IllegalArgumentException</code></a>
will be thrown when attempting to invoke <a href="../../../../../org/apache/sshd/server/scp/ScpCommandFactory.html#createCommand-java.lang.String-"><code>createCommand(String)</code></a>
with a non-SCP command</dd>
</dl>
</li>
</ul>
<a name="getExecutorService--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExecutorService</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/ExecutorService.html?is-external=true" title="class or interface in java.util.concurrent">ExecutorService</a>&nbsp;getExecutorService()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/sshd/common/util/threads/ExecutorServiceCarrier.html#getExecutorService--">getExecutorService</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/sshd/common/util/threads/ExecutorServiceCarrier.html" title="interface in org.apache.sshd.common.util.threads">ExecutorServiceCarrier</a></code></dd>
</dl>
</li>
</ul>
<a name="setExecutorService-java.util.concurrent.ExecutorService-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setExecutorService</h4>
<pre>public&nbsp;void&nbsp;setExecutorService(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/ExecutorService.html?is-external=true" title="class or interface in java.util.concurrent">ExecutorService</a>&nbsp;service)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/sshd/common/util/threads/ExecutorServiceConfigurer.html#setExecutorService-java.util.concurrent.ExecutorService-">setExecutorService</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/sshd/common/util/threads/ExecutorServiceConfigurer.html" title="interface in org.apache.sshd.common.util.threads">ExecutorServiceConfigurer</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>service</code> - An <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/ExecutorService.html?is-external=true" title="class or interface in java.util.concurrent"><code>ExecutorService</code></a> to be used when
starting <a href="../../../../../org/apache/sshd/server/scp/ScpCommand.html" title="class in org.apache.sshd.server.scp"><code>ScpCommand</code></a> execution. If <code>null</code> then a single-threaded
ad-hoc service is used. <B>Note:</B> the service will <U>not</U> be shutdown
when the command is terminated - unless it is the ad-hoc service, which will be
shutdown regardless</dd>
</dl>
</li>
</ul>
<a name="isShutdownOnExit--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isShutdownOnExit</h4>
<pre>public&nbsp;boolean&nbsp;isShutdownOnExit()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/sshd/common/util/threads/ExecutorServiceCarrier.html#isShutdownOnExit--">isShutdownOnExit</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/sshd/common/util/threads/ExecutorServiceCarrier.html" title="interface in org.apache.sshd.common.util.threads">ExecutorServiceCarrier</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>If <code>true</code> then the <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/ExecutorService.html?is-external=true#shutdownNow--" title="class or interface in java.util.concurrent"><code>ExecutorService.shutdownNow()</code></a>
will be called (unless it is an internally allocated service which is always
closed)</dd>
</dl>
</li>
</ul>
<a name="setShutdownOnExit-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setShutdownOnExit</h4>
<pre>public&nbsp;void&nbsp;setShutdownOnExit(boolean&nbsp;shutdown)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/sshd/common/util/threads/ExecutorServiceConfigurer.html#setShutdownOnExit-boolean-">setShutdownOnExit</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/sshd/common/util/threads/ExecutorServiceConfigurer.html" title="interface in org.apache.sshd.common.util.threads">ExecutorServiceConfigurer</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>shutdown</code> - If <code>true</code> the <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/ExecutorService.html?is-external=true#shutdownNow--" title="class or interface in java.util.concurrent"><code>ExecutorService.shutdownNow()</code></a>
will be called when command terminates - unless it is the ad-hoc
service, which will be shutdown regardless</dd>
</dl>
</li>
</ul>
<a name="getSendBufferSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSendBufferSize</h4>
<pre>public&nbsp;int&nbsp;getSendBufferSize()</pre>
</li>
</ul>
<a name="setSendBufferSize-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSendBufferSize</h4>
<pre>public&nbsp;void&nbsp;setSendBufferSize(int&nbsp;sendSize)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sendSize</code> - Size (in bytes) of buffer to use when sending files</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/sshd/common/scp/ScpHelper.html#MIN_SEND_BUFFER_SIZE"><code>ScpHelper.MIN_SEND_BUFFER_SIZE</code></a></dd>
</dl>
</li>
</ul>
<a name="getReceiveBufferSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReceiveBufferSize</h4>
<pre>public&nbsp;int&nbsp;getReceiveBufferSize()</pre>
</li>
</ul>
<a name="setReceiveBufferSize-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setReceiveBufferSize</h4>
<pre>public&nbsp;void&nbsp;setReceiveBufferSize(int&nbsp;receiveSize)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>receiveSize</code> - Size (in bytes) of buffer to use when receiving files</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/sshd/common/scp/ScpHelper.html#MIN_RECEIVE_BUFFER_SIZE"><code>ScpHelper.MIN_RECEIVE_BUFFER_SIZE</code></a></dd>
</dl>
</li>
</ul>
<a name="addEventListener-org.apache.sshd.common.scp.ScpTransferEventListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addEventListener</h4>
<pre>public&nbsp;boolean&nbsp;addEventListener(<a href="../../../../../org/apache/sshd/common/scp/ScpTransferEventListener.html" title="interface in org.apache.sshd.common.scp">ScpTransferEventListener</a>&nbsp;listener)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>listener</code> - The <a href="../../../../../org/apache/sshd/common/scp/ScpTransferEventListener.html" title="interface in org.apache.sshd.common.scp"><code>ScpTransferEventListener</code></a> to add</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if this is a <U>new</U> listener instance,
<code>false</code> if the listener is already registered</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if <code>null</code> listener</dd>
</dl>
</li>
</ul>
<a name="removeEventListener-org.apache.sshd.common.scp.ScpTransferEventListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeEventListener</h4>
<pre>public&nbsp;boolean&nbsp;removeEventListener(<a href="../../../../../org/apache/sshd/common/scp/ScpTransferEventListener.html" title="interface in org.apache.sshd.common.scp">ScpTransferEventListener</a>&nbsp;listener)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>listener</code> - The <a href="../../../../../org/apache/sshd/common/scp/ScpTransferEventListener.html" title="interface in org.apache.sshd.common.scp"><code>ScpTransferEventListener</code></a> to remove</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the listener was registered and removed,
<code>false</code> if the listener was not registered to begin with</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if <code>null</code> listener</dd>
</dl>
</li>
</ul>
<a name="createCommand-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createCommand</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/sshd/server/Command.html" title="interface in org.apache.sshd.server">Command</a>&nbsp;createCommand(<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>&nbsp;command)</pre>
<div class="block">Parses a command string and verifies that the basic syntax is
correct. If parsing fails the responsibility is delegated to
the configured <a href="../../../../../org/apache/sshd/server/CommandFactory.html" title="interface in org.apache.sshd.server"><code>CommandFactory</code></a> instance; if one exist.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/sshd/server/CommandFactory.html#createCommand-java.lang.String-">createCommand</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/sshd/server/CommandFactory.html" title="interface in org.apache.sshd.server">CommandFactory</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>command</code> - command to parse</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>configured <a href="../../../../../org/apache/sshd/server/Command.html" title="interface in org.apache.sshd.server"><code>Command</code></a> instance</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if not an SCP command and no
delegate command factory is available</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/sshd/common/scp/ScpHelper.html#SCP_COMMAND_PREFIX"><code>ScpHelper.SCP_COMMAND_PREFIX</code></a></dd>
</dl>
</li>
</ul>
<a name="clone--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>clone</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/sshd/server/scp/ScpCommandFactory.html" title="class in org.apache.sshd.server.scp">ScpCommandFactory</a>&nbsp;clone()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></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/ScpCommandFactory.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/scp/ScpCommand.html" title="class in org.apache.sshd.server.scp"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/sshd/server/scp/ScpCommandFactory.Builder.html" title="class in org.apache.sshd.server.scp"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/sshd/server/scp/ScpCommandFactory.html" target="_top">Frames</a></li>
<li><a href="ScpCommandFactory.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><a href="#nested.class.summary">Nested</a>&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; 2008&#x2013;2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>