Apache Mina SSHD 2.15.0 · org.apache.sshd.sftp.server.SftpSubsystem

Modifier and Type	Field and Description
protected final Buffer	buffer
protected ExitCallback	callback
protected static final Buffer	CLOSE
protected final AtomicBoolean	closed
protected Path	defaultDir
protected Environment	env
protected CloseableExecutorService	executorService
protected final Map<String, byte[]>	extensions
protected int	fileHandleSize
protected FileSystem	fileSystem
protected final Map<String, Handle>	handles
protected int	maxFileHandleRounds
protected int	maxHandleCount
protected IoOutputStream	out
protected Future<?>	pendingFuture
protected Random	randomizer
protected final BlockingQueue<Buffer>	requests
protected final AtomicLong	requestsCount
private final ServerSession	serverSession
protected Deque<String>	unusedHandles
protected int	version
protected byte[]	workBuf

Access	Constructor and Description
public	SftpSubsystem(ChannelSession The `ChannelSession` through which the command was received channel, SftpSubsystemConfigurator The `SftpSubsystemConfigurator` to use configurator)

Method Summary

Modifier and Type	Method and Description
public void	close() Implements java.io.Closeable.close. Closes this stream and releases any system resources associated with it.
protected void	closeAllHandles()
protected void	createLink(int id, String existingPath, String linkPath, boolean symLink) Implements abstract org.apache.sshd.sftp.server.AbstractSftpSubsystemHelper.createLink.
public int	data(ChannelSession The caller to which this `ChannelDataReceiver` is assigned. Never null. channel, byte[] Holds the bytes received. This buffer belongs to the caller, and it might get reused by the caller as soon as this method returns. buf, int buf[start] is the first byte that received from the client. start, int the length of the bytes received. Can be zero. len) Implements org.apache.sshd.server.channel.ChannelDataReceiver.data. Called when the server receives additional bytes from the client.
public void	destroy(ChannelSession The `ChannelSession` through which the command has been received channel) Implements org.apache.sshd.server.command.CommandLifecycle.destroy. This method is called by the SSH server to destroy the command because the client has disconnected somehow.
protected void	doBlock(int id, String handle, long offset, long length, int mask) Implements abstract org.apache.sshd.sftp.server.AbstractSftpSubsystemHelper.doBlock.
protected void	doCheckFileHash(int id, String targetType, String target, Collection<String> algos, long startOffset, long length, int blockSize, Buffer buffer) Implements abstract org.apache.sshd.sftp.server.AbstractSftpSubsystemHelper.doCheckFileHash.
protected void	doClose(int id, String handle) Implements abstract org.apache.sshd.sftp.server.AbstractSftpSubsystemHelper.doClose.
protected void	doCopyData(int id, String readHandle, long readOffset, long readLength, String writeHandle, long writeOffset) Implements abstract org.apache.sshd.sftp.server.AbstractSftpSubsystemHelper.doCopyData.
protected void	doFSetStat(int id, String handle, Map<String, ?> attrs) Implements abstract org.apache.sshd.sftp.server.AbstractSftpSubsystemHelper.doFSetStat.
protected Map<String, Object>	doFStat(int id, String handle, int flags) Implements abstract org.apache.sshd.sftp.server.AbstractSftpSubsystemHelper.doFStat.
protected void	doInit(Buffer buffer, int id) Implements abstract org.apache.sshd.sftp.server.AbstractSftpSubsystemHelper.doInit.
protected byte[]	doMD5Hash(int id, String targetType, String target, long startOffset, long length, byte[] quickCheckHash) Implements abstract org.apache.sshd.sftp.server.AbstractSftpSubsystemHelper.doMD5Hash.
protected String	doOpen(int Request id id, String Path path, int Open mode flags - see `SSH_FXF_XXX` flags pflags, int Access mode flags - see `ACE4_XXX` flags access, Map<String, Object> Requested attributes attrs) Implements abstract org.apache.sshd.sftp.server.AbstractSftpSubsystemHelper.doOpen.
protected String	doOpenDir(int id, String path, Path dir, LinkOption... options) Implements abstract org.apache.sshd.sftp.server.AbstractSftpSubsystemHelper.doOpenDir.
protected void	doOpenSSHFsync(int id, String handle) Implements abstract org.apache.sshd.sftp.server.AbstractSftpSubsystemHelper.doOpenSSHFsync.
protected void	doProcess(Buffer buffer, int length, int type, int id) Overrides org.apache.sshd.sftp.server.AbstractSftpSubsystemHelper.doProcess.
protected int	doRead(int id, String handle, long offset, int length, byte[] data, int doff, AtomicReference<Boolean> eof) Implements abstract org.apache.sshd.sftp.server.AbstractSftpSubsystemHelper.doRead.
protected void	doReadDir(Buffer buffer, int id) Implements abstract org.apache.sshd.sftp.server.AbstractSftpSubsystemHelper.doReadDir.
protected void	doTextSeek(int id, String handle, long line) Implements abstract org.apache.sshd.sftp.server.AbstractSftpSubsystemHelper.doTextSeek.
protected void	doUnblock(int id, String handle, long offset, long length) Implements abstract org.apache.sshd.sftp.server.AbstractSftpSubsystemHelper.doUnblock.
protected void	doVersionSelect(Buffer buffer, int id, String proposed) Implements abstract org.apache.sshd.sftp.server.AbstractSftpSubsystemHelper.doVersionSelect.
protected void	doWrite(int id, String handle, long offset, int length, byte[] data, int doff, int remaining) Implements abstract org.apache.sshd.sftp.server.AbstractSftpSubsystemHelper.doWrite.
protected String	Returns: the file handle generateFileHandle(Path to generate a handle for file) Generates a file handle, which is used as key in a `Map` to record open file handles across requests.
public Path	getDefaultDirectory() Implements org.apache.sshd.sftp.server.SftpSubsystemEnvironment.getDefaultDirectory.
public CloseableExecutorService	getExecutorService() Implements org.apache.sshd.common.util.threads.ExecutorServiceCarrier.getExecutorService.
public ServerSession	getServerSession() Implements org.apache.sshd.server.session.ServerSessionHolder.getServerSession.
public int	getVersion() Implements org.apache.sshd.sftp.server.SftpSubsystemEnvironment.getVersion.
protected void	initializeSessionRelatedMember(ServerSession session, ChannelSession channel)
protected Buffer	prepareReply(Buffer buffer) Implements abstract org.apache.sshd.sftp.server.AbstractSftpSubsystemHelper.prepareReply.
protected ChannelDataReceiver	resolveErrorDataChannelReceiver(ChannelSession channelSession, ChannelDataReceiver receiver)
public void	run() Implements java.lang.Runnable.run. Runs this operation.
protected void	send(Buffer buffer) Implements abstract org.apache.sshd.sftp.server.AbstractSftpSubsystemHelper.send.
public void	setErrorStream(OutputStream The `OutputStream` used by the shell to write its errors err) Implements org.apache.sshd.server.command.CommandDirectErrorStreamAware.setErrorStream. Set the error stream that can be used by the shell to write its errors.
public void	setExitCallback(ExitCallback The `ExitCallback` to call when shell is closed callback) Implements org.apache.sshd.server.command.Command.setExitCallback. Set the callback that the shell has to call when it is closed.
public void	setFileSystem(FileSystem the file system fileSystem) Implements org.apache.sshd.common.file.FileSystemAware.setFileSystem. Set the file system in which this shell will be executed.
public void	setInputStream(InputStream The `InputStream` used by the shell to read input. in) Implements org.apache.sshd.server.command.CommandDirectInputStreamAware.setInputStream. Set the input stream that can be used by the shell to read input.
public void	setIoErrorStream(IoOutputStream The `IoOutputStream` used by the shell to write its errors err) Implements org.apache.sshd.server.command.AsyncCommandErrorStreamAware.setIoErrorStream. Set the error stream that can be used by the shell to write its errors.
public void	setIoInputStream(IoInputStream The `IoInputStream` used by the shell to read input in) Implements org.apache.sshd.server.command.AsyncCommandInputStreamAware.setIoInputStream. Set the input stream that can be used by the shell to read input.
public void	setIoOutputStream(IoOutputStream The `IoOutputStream` used by the shell to write its output out) Implements org.apache.sshd.server.command.AsyncCommandOutputStreamAware.setIoOutputStream. Set the output stream that can be used by the shell to write its output.
public void	setOutputStream(OutputStream The `OutputStream` used by the shell to write its output out) Implements org.apache.sshd.server.command.CommandDirectOutputStreamAware.setOutputStream. Set the output stream that can be used by the shell to write its output.
public void	start(ChannelSession The `ChannelSession` through which the command has been received channel, Environment The `Environment` env) Implements org.apache.sshd.server.command.CommandLifecycle.start. Starts the command execution.

Inherited from org.apache.sshd.sftp.server.AbstractSftpSubsystemHelper:: addMissingAttribute addSftpEventListener appendAclSupportedExtension appendExtensions appendNewlineExtension appendOpenSSHExtensions appendSupported2Extension appendSupportedExtension appendVendorIdExtension appendVersionsExtension checkSymlinkState checkVersionCompatibility doBlock doCheckFileHash doCheckFileHash doClose doCopyData doCopyFile doCopyFile doCopyFile doExtended doFSetStat doFStat doLink doLink doLStat doLStat doMakeDirectory doMakeDirectory doMD5Hash doMD5Hash doOpen doOpenDir doOpenSSHFsync doOpenSSHHardLink doOpenSSHHardLink doOpenSSHLimits doPosixRename doRead doReadDir doReadLink doReadLink doRealPath doRealPathV345 doRealPathV6 doRemove doRemove doRemoveDirectory doRemoveDirectory doRemoveFile doRename doRename doRename doSetAttributes doSetStat doSetStat doSpaceAvailable doSpaceAvailable doStat doStat doSymLink doSymLink doTextSeek doUnblock doUnsupported doUnsupportedExtension doVersionSelect doWrite executeExtendedCommand getAttributes getAttributes getErrorStatusDataHandler getFileSystemAccessor getLongName getLongName getLongName getLongName getOpenSSHLimitsExtensionInfo getPathResolutionLinkOption getServerChannelSession getSftpEventListenerProxy getShortName getSupportedClientExtensions getUnsupportedAttributePolicy handleReadFileAttributesException handleSetFileAttributeFailure handleUnknownStatusFileAttributes handleUnsupportedAttributes handleUserPrincipalLookupServiceException normalize process readAttrs readFileAttributes removeSftpEventListener resolveAclSupportedCapabilities resolveFile resolveFileAttributes resolveMissingFileAttributes resolveMissingFileAttributeValue resolveNewlineValue resolveNormalizedLocation resolveOpenSSHExtensions resolvePathResolutionFollowLinks resolveReportedFileAttributes sendAttrs sendHandle sendLink sendPath sendStatus sendStatus sendStatus setFileAccessControl setFileAttribute setFileAttributes setFileExtensions setFileOwnership setFilePermissions setFileRawViewAttribute setFileTime signalOpenFailure signalRemovalPreConditionFailure toGroup toUser validateHandle validateParentExistWithNoSymlinksIfNeverFollowSymlinks validateProposedVersion validateRealPath writeAttrs writeDirEntry writeDirEntry

public Class SftpSubsystem

Field Summary

Constructor Summary

Method Summary