Class ScpShell

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.server.command.AbstractCommandSupport

org.apache.sshd.server.command.AbstractFileSystemCommand

org.apache.sshd.scp.server.ScpShell

All Implemented Interfaces:

Runnable, FileSystemAware, SessionContextHolder, SessionHolder<ServerSession>, ExecutorServiceCarrier, ServerChannelSessionHolder, Command, CommandDirectErrorStreamAware, CommandDirectInputStreamAware, CommandDirectOutputStreamAware, CommandDirectStreamsAware, CommandLifecycle, ServerSessionAware, ServerSessionHolder

public class ScpShell
extends AbstractFileSystemCommand
implements ServerChannelSessionHolder

This command provides SCP support for a ChannelSession.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	ScpShell.PathEntry

Field Summary

Fields

Modifier and Type	Field	Description
private final ChannelSession	channelSession
protected Path	currentDir
static final String	ENV_HOME	The "HOME" environment variable
static final String	ENV_LANG	Key for the language - format "en_US.UTF-8"
static final String	ENV_PWD	The "PWD" environment variable
protected final Charset	envVarsEnodingCharset
protected Path	homeDir
protected final ScpTransferEventListener	listener
private static final int	LS_ALL
private static final int	LS_DIR_PLAIN
private static final int	LS_FULL_TIME
private static final int	LS_LONG
protected final Charset	nameEncodingCharset
protected final ScpFileOpener	opener
protected final int	receiveBufferSize
private static final int	SCP_D
private static final int	SCP_F
private static final int	SCP_P
private static final int	SCP_R
private static final int	SCP_T
protected final int	sendBufferSize
static final String	STATUS
protected final Map<String,Object>	variables

Fields inherited from class AbstractFileSystemCommand

fileSystem

Fields inherited from class AbstractCommandSupport

cbCalled, cmdRunner, executorService

Fields inherited from class AbstractLoggingBean

log

Constructor Summary

Constructors

Constructor	Description
ScpShell(ChannelSession channelSession, CloseableExecutorService executorService, int sendSize, int receiveSize, ScpFileOpener fileOpener, ScpTransferEventListener eventListener)

Method Summary

Modifier and Type	Method	Description
protected void	cd(String[] argv)
protected void	doLs(String cmd, String path, int options)
protected void	doScp(String command, String path, int options)
protected void	echo(String[] argv)
ChannelSession	getServerChannelSession()
protected boolean	handleCommandLine(String command)
protected void	handleUnsupportedCommand(String command, String[] argv)
protected void	ls(String[] argv)
protected List<String[]>	parse(String command)
protected void	prepareEnvironment(Environment environ)
protected void	printenv(String[] argv)
protected void	println(String cmd, Object x, OutputStream out, Charset cs)
protected void	pwd(String[] argv)
protected String	readLine(Reader reader)
protected String	resolveEnvironmentVariable(String varName, Map<String,String> envValues)
void	run()
protected void	scp(String command, String[] argv)
void	setFileSystemFactory(FileSystemFactory factory, SessionContext session)	Sets the FileSystemFactory used to create the FileSystem to be used by the session
protected void	signalError(String cmd, String errorMsg)
protected void	signalError(String cmd, String errorMsg, Charset cs)
private String	toScpPath(String winScpPath)
protected void	unset(String[] argv)
protected void	updatePwdEnvVariable(Path pwd)

Methods inherited from class AbstractFileSystemCommand

destroy, getFileSystem, setFileSystem

Methods inherited from class AbstractCommandSupport

getCommand, getEnvironment, getErrorStream, getExecutorService, getExitCallback, getInputStream, getOutputStream, getServerSession, getSession, getStartedCommandFuture, onExit, onExit, setErrorStream, setExitCallback, setInputStream, setOutputStream, setSession, start, toString

Methods inherited from class AbstractLoggingBean

debug, debug, debug, debug, debug, error, error, error, error, error, getSimplifiedLogger, info, info, warn, warn, warn, warn, warn, warn, warn, warn

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface SessionHolder

getSessionContext

Field Details

STATUS

public static final String STATUS

See Also:

• Constant Field Values

ENV_PWD

public static final String ENV_PWD

The "PWD" environment variable

See Also:

• Constant Field Values

ENV_HOME

public static final String ENV_HOME

The "HOME" environment variable

See Also:

• Constant Field Values

ENV_LANG

public static final String ENV_LANG

Key for the language - format "en_US.UTF-8"

See Also:

• Constant Field Values

LS_ALL

private static final int LS_ALL

See Also:

• Constant Field Values

LS_DIR_PLAIN

private static final int LS_DIR_PLAIN

See Also:

• Constant Field Values

LS_LONG

private static final int LS_LONG

See Also:

• Constant Field Values

LS_FULL_TIME

private static final int LS_FULL_TIME

See Also:

• Constant Field Values

SCP_D

private static final int SCP_D

See Also:

• Constant Field Values

SCP_F

private static final int SCP_F

See Also:

• Constant Field Values

SCP_P

private static final int SCP_P

See Also:

• Constant Field Values

SCP_R

private static final int SCP_R

See Also:

• Constant Field Values

SCP_T

private static final int SCP_T

See Also:

• Constant Field Values

variables

protected final Map<String,Object> variables

nameEncodingCharset

protected final Charset nameEncodingCharset

envVarsEnodingCharset

protected final Charset envVarsEnodingCharset

opener

protected final ScpFileOpener opener

listener

protected final ScpTransferEventListener listener

sendBufferSize

protected final int sendBufferSize

receiveBufferSize

protected final int receiveBufferSize

currentDir

protected Path currentDir

homeDir

protected Path homeDir

channelSession

private final ChannelSession channelSession

Constructor Details

ScpShell

public ScpShell(ChannelSession channelSession,
 CloseableExecutorService executorService,
 int sendSize,
 int receiveSize,
 ScpFileOpener fileOpener,
 ScpTransferEventListener eventListener)

Method Details

getServerChannelSession

public ChannelSession getServerChannelSession()

Specified by:

getServerChannelSession in interface ServerChannelSessionHolder

setFileSystemFactory

public void setFileSystemFactory(FileSystemFactory factory,
 SessionContext session)
                          throws IOException

Description copied from interface: FileSystemAware

Sets the FileSystemFactory used to create the FileSystem to be used by the session

Specified by:

setFileSystemFactory in interface FileSystemAware

Parameters:

factory - The factory instance

session - The SessionContext

Throws:

IOException - If failed to resolve/create the file system

See Also:

• FileSystemAware.setFileSystem(FileSystem)

println

protected void println(String cmd,
 Object x,
 OutputStream out,
 Charset cs)

signalError

protected void signalError(String cmd,
 String errorMsg)

signalError

protected void signalError(String cmd,
 String errorMsg,
 Charset cs)

run

public void run()

Specified by:

run in interface Runnable

readLine

protected String readLine(Reader reader)
                   throws IOException

Throws:

IOException

handleCommandLine

protected boolean handleCommandLine(String command)
                             throws Exception

Throws:

Exception

prepareEnvironment

protected void prepareEnvironment(Environment environ)

handleUnsupportedCommand

protected void handleUnsupportedCommand(String command,
 String[] argv)
                                 throws Exception

Throws:

Exception

parse

protected List<String[]> parse(String command)

printenv

protected void printenv(String[] argv)
                 throws Exception

Throws:

Exception

resolveEnvironmentVariable

protected String resolveEnvironmentVariable(String varName,
 Map<String,String> envValues)

unset

protected void unset(String[] argv)
              throws Exception

Throws:

Exception

scp

protected void scp(String command,
 String[] argv)
            throws Exception

Throws:

Exception

doScp

protected void doScp(String command,
 String path,
 int options)
              throws Exception

Throws:

Exception

echo

protected void echo(String[] argv)
             throws Exception

Throws:

Exception

pwd

protected void pwd(String[] argv)
            throws Exception

Throws:

Exception

toScpPath

private String toScpPath(String winScpPath)

cd

protected void cd(String[] argv)
           throws Exception

Throws:

Exception

updatePwdEnvVariable

protected void updatePwdEnvVariable(Path pwd)

ls

protected void ls(String[] argv)
           throws Exception

Throws:

Exception

doLs

protected void doLs(String cmd,
 String path,
 int options)
             throws Exception

Throws:

Exception