org.apache.sshd.sftp.subsystem

Class SftpSubsystem

java.lang.Object

org.apache.sshd.sftp.subsystem.SftpSubsystem

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, FileSystemAware, ChannelDataReceiver, ChannelSessionAware, Command, SessionAware, SftpSession

public class SftpSubsystem
extends java.lang.Object
implements Command, SessionAware, FileSystemAware, SftpSession, ChannelDataReceiver, ChannelSessionAware

SFTP subsystem

Author:

Apache MINA SSHD Project

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SftpSubsystem.Factory

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ALL_SFTP_IMPL
static int	HIGHER_SFTP_IMPL
protected static org.slf4j.Logger	LOG
static int	LOWER_SFTP_IMPL
static java.lang.String	MAX_OPEN_HANDLES_PER_SESSION Properties key for the maximum of available open handles per session.
static int	MAX_PACKET_LENGTH

Constructor Summary

Constructors

Constructor and Description
SftpSubsystem()

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
Handle	createDirectoryHandle(SshFile file)
Handle	createFileHandle(SshFile file, int flags)
int	data(ChannelSession channel, byte[] buf, int start, int len)
void	destroy()
protected Reply	doProcess(Request request)
Handle	getHandle(java.lang.String id)
Session	getSession()
int	getVersion()
void	process(Buffer buffer)
protected boolean	receive(Buffer incoming)
protected void	send(Buffer buffer)
protected SshFxpNameReply	sendName(int id, java.util.Iterator<SshFile> files)
void	setChannelSession(ChannelSession channel)
void	setErrorStream(java.io.OutputStream err)
void	setExitCallback(ExitCallback callback)
void	setFileSystemView(FileSystemView view)
void	setInputStream(java.io.InputStream in)
void	setOutputStream(java.io.OutputStream out)
void	setSession(ServerSession session)
void	setSftpLet(Sftplet sftpLet)
void	start(Environment env)

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final org.slf4j.Logger LOG

LOWER_SFTP_IMPL

public static final int LOWER_SFTP_IMPL

See Also:

Constant Field Values

HIGHER_SFTP_IMPL

public static final int HIGHER_SFTP_IMPL

See Also:

Constant Field Values

ALL_SFTP_IMPL

public static final java.lang.String ALL_SFTP_IMPL

See Also:

Constant Field Values

MAX_PACKET_LENGTH

public static final int MAX_PACKET_LENGTH

See Also:

Constant Field Values

MAX_OPEN_HANDLES_PER_SESSION

public static final java.lang.String MAX_OPEN_HANDLES_PER_SESSION

Properties key for the maximum of available open handles per session.

See Also:

Constant Field Values

Constructor Detail

SftpSubsystem

public SftpSubsystem()

Method Detail

setSftpLet

public void setSftpLet(Sftplet sftpLet)

getVersion

public int getVersion()

Specified by:

getVersion in interface SftpSession

getSession

public Session getSession()

Specified by:

getSession in interface SftpSession

getHandle

public Handle getHandle(java.lang.String id)

Specified by:

getHandle in interface SftpSession

createFileHandle

public Handle createFileHandle(SshFile file,
                      int flags)

Specified by:

createFileHandle in interface SftpSession

createDirectoryHandle

public Handle createDirectoryHandle(SshFile file)

Specified by:

createDirectoryHandle in interface SftpSession

setChannelSession

public void setChannelSession(ChannelSession channel)

Specified by:

setChannelSession in interface ChannelSessionAware

setSession

public void setSession(ServerSession session)

Specified by:

setSession in interface SessionAware

setFileSystemView

public void setFileSystemView(FileSystemView view)

Specified by:

setFileSystemView in interface FileSystemAware

setExitCallback

public void setExitCallback(ExitCallback callback)

Specified by:

setExitCallback in interface Command

setInputStream

public void setInputStream(java.io.InputStream in)

Specified by:

setInputStream in interface Command

setOutputStream

public void setOutputStream(java.io.OutputStream out)

Specified by:

setOutputStream in interface Command

setErrorStream

public void setErrorStream(java.io.OutputStream err)

Specified by:

setErrorStream in interface Command

start

public void start(Environment env)
           throws java.io.IOException

Specified by:

start in interface Command

Throws:

java.io.IOException

data

public int data(ChannelSession channel,
       byte[] buf,
       int start,
       int len)
         throws java.io.IOException

Specified by:

data in interface ChannelDataReceiver

Throws:

java.io.IOException

receive

protected boolean receive(Buffer incoming)
                   throws java.io.IOException

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface ChannelDataReceiver

Throws:

java.io.IOException

process

public void process(Buffer buffer)
             throws java.io.IOException

Throws:

java.io.IOException

doProcess

protected Reply doProcess(Request request)
                   throws java.io.IOException

Throws:

java.io.IOException

sendName

protected SshFxpNameReply sendName(int id,
                       java.util.Iterator<SshFile> files)
                            throws java.io.IOException

Throws:

java.io.IOException

send

protected void send(Buffer buffer)
             throws java.io.IOException

Throws:

java.io.IOException

destroy

public void destroy()

Specified by:

destroy in interface Command