Modifier and Type	Class and Description
protected static class	ScpShell.PathEntry

Field Summary

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

Inherited from org.apache.sshd.server.command.AbstractFileSystemCommand:: fileSystem

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

Method Summary

Modifier and Type	Method and Description
protected void	cd(String[] argv)
protected void	doLs(String cmd, String path, boolean optListAll, boolean optLong, boolean optFullTime)
protected void	doScp(String command, String path, boolean optR, boolean optT, boolean optF, boolean optD, boolean optP)
protected void	echo(String[] argv)
public ChannelSession	getServerChannelSession() Implements org.apache.sshd.server.channel.ServerChannelSessionHolder.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)
public void	run() Implements java.lang.Runnable.run. Runs this operation.
protected void	scp(String command, String[] argv)
public void	setFileSystemFactory(FileSystemFactory The factory instance factory, SessionContext The `SessionContext` session) Overrides default org.apache.sshd.common.file.FileSystemAware.setFileSystemFactory. 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)
protected void	unset(String[] argv)
protected void	updatePwdEnvVariable(Path pwd)

Inherited from org.apache.sshd.server.command.AbstractFileSystemCommand:: destroy getFileSystem setFileSystem

Field Detail

channelSession	back to summary
private final ChannelSession channelSession

currentDir	back to summary
protected Path currentDir

ENV_HOME	back to summary
public static final String ENV_HOME The "HOME" environment variable

ENV_LANG	back to summary
public static final String ENV_LANG Key for the language - format "en_US.UTF-8"

ENV_PWD	back to summary
public static final String ENV_PWD The "PWD" environment variable

envVarsEnodingCharset	back to summary
protected final Charset envVarsEnodingCharset

homeDir	back to summary
protected Path homeDir

listener	back to summary
protected final ScpTransferEventListener listener

nameEncodingCharset	back to summary
protected final Charset nameEncodingCharset

opener	back to summary
protected final ScpFileOpener opener

receiveBufferSize	back to summary
protected final int receiveBufferSize

sendBufferSize	back to summary
protected final int sendBufferSize

STATUS	back to summary
public static final String STATUS

variables	back to summary
protected final Map<String, Object> variables

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

Method Detail

cd	back to summary
protected void cd(String[] argv) throws Exception

doLs	back to summary
protected void doLs(String cmd, String path, boolean optListAll, boolean optLong, boolean optFullTime) throws Exception

doScp	back to summary
protected void doScp(String command, String path, boolean optR, boolean optT, boolean optF, boolean optD, boolean optP) throws Exception

echo	back to summary
protected void echo(String[] argv) throws Exception

getServerChannelSession	back to summary
public ChannelSession getServerChannelSession() Implements org.apache.sshd.server.channel.ServerChannelSessionHolder.getServerChannelSession. Annotations @Override

getServerChannelSession

back to summary

public ChannelSession getServerChannelSession()

Implements org.apache.sshd.server.channel.ServerChannelSessionHolder.getServerChannelSession.

Annotations

@Override

handleCommandLine	back to summary
protected boolean handleCommandLine(String command) throws Exception

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

ls	back to summary
protected void ls(String[] argv) throws Exception

parse	back to summary
protected List<String[]> parse(String command)

prepareEnvironment	back to summary
protected void prepareEnvironment(Environment environ)

printenv	back to summary
protected void printenv(String[] argv) throws Exception

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

pwd	back to summary
protected void pwd(String[] argv) throws Exception

readLine	back to summary
protected String readLine(Reader reader) throws IOException

resolveEnvironmentVariable	back to summary
protected String resolveEnvironmentVariable(String varName, Map<String, String> envValues)

run	back to summary
public void run() Implements java.lang.Runnable.run. Doc from java.lang.Runnable.run. Runs this operation. Annotations @Override

run

back to summary

public void run()

Implements java.lang.Runnable.run.

Doc from java.lang.Runnable.run.

Runs this operation.

Annotations

@Override

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

setFileSystemFactory back to summary

setFileSystemFactory	back to summary
public void setFileSystemFactory(FileSystemFactory factory, SessionContext session) throws IOException Overrides default org.apache.sshd.common.file.FileSystemAware.setFileSystemFactory. Doc from org.apache.sshd.common.file.FileSystemAware.setFileSystemFactory. Sets the `FileSystemFactory` used to create the `FileSystem` to be used by the session Parameters factory:FileSystemFactory The factory instance session:SessionContext The `SessionContext` Annotations @Override Exceptions IOException: If failed to resolve/create the file system

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

Overrides default org.apache.sshd.common.file.FileSystemAware.setFileSystemFactory.

Doc from org.apache.sshd.common.file.FileSystemAware.setFileSystemFactory.

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

Parameters

factory:FileSystemFactory: The factory instance
session:SessionContext: The SessionContext

Annotations

@Override

Exceptions

IOException:: If failed to resolve/create the file system

signalError	back to summary
protected void signalError(String cmd, String errorMsg)

signalError	back to summary
protected void signalError(String cmd, String errorMsg, Charset cs)

unset	back to summary
protected void unset(String[] argv) throws Exception

updatePwdEnvVariable	back to summary
protected void updatePwdEnvVariable(Path pwd)

org.apache.sshd.scp.server back to summary

protected Class ScpShell.PathEntry

Class Inheritance

extends Object
implements Comparable<ScpShell.PathEntry>

java.lang.Object
org.apache.sshd.scp.server.ScpShell.PathEntry

All Implemented Interfaces

java.lang.Comparable

Field Summary

Modifier and Type	Field and Description
protected final Path	abs
protected final Map<String, Object>	attributes
public static final DateTimeFormatter	FULL_TIME_VALUE_FORMATTER
protected final Path	path
public static final DateTimeFormatter	TIME_ONLY_VALUE_FORMATTER
public static final DateTimeFormatter	YEAR_VALUE_FORMATTER

Constructor Summary

Access	Constructor and Description
public	PathEntry(Path abs, Path root)

Method Summary

Modifier and Type	Method and Description
protected StringBuilder	appendOwnerInformation(StringBuilder sb, String attr, String defaultValue)
public int	compareTo(ScpShell.PathEntry the object to be compared. o) Implements java.lang.Comparable.compareTo. Compares this object with the specified object for order.
public String	display(boolean optLongDisplay, boolean optFullTime)
protected boolean	is(String attr)
protected static Map<String, Object>	readAttributes(Path path)
protected String	shortDisplay()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
protected static String	toString(FileTime time, boolean optFullTime)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

abs	back to summary
protected final Path abs

attributes	back to summary
protected final Map<String, Object> attributes

FULL_TIME_VALUE_FORMATTER	back to summary
public static final DateTimeFormatter FULL_TIME_VALUE_FORMATTER

path	back to summary
protected final Path path

TIME_ONLY_VALUE_FORMATTER	back to summary
public static final DateTimeFormatter TIME_ONLY_VALUE_FORMATTER

YEAR_VALUE_FORMATTER	back to summary
public static final DateTimeFormatter YEAR_VALUE_FORMATTER

Constructor Detail

PathEntry	back to summary
public PathEntry(Path abs, Path root)

Method Detail

appendOwnerInformation	back to summary
protected StringBuilder appendOwnerInformation(StringBuilder sb, String attr, String defaultValue)

compareTo back to summary

public int compareTo(ScpShell.PathEntry o)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters

o:ScpShell.PathEntry: the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations

@Override

display	back to summary
public String display(boolean optLongDisplay, boolean optFullTime) throws NoSuchFileException

is	back to summary
protected boolean is(String attr)

readAttributes	back to summary
protected static Map<String, Object> readAttributes(Path path)

shortDisplay	back to summary
protected String shortDisplay()

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

toString	back to summary
protected static String toString(FileTime time, boolean optFullTime)

public Class ScpShell

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected Class ScpShell.PathEntry

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail