com.sshtools.j2ssh.sftp.SftpSubsystemClient

public class SftpSubsystemClient extends SubsystemChannel

Version:: $Revision: 1.38 $
Author:: $author$

Field Summary

Fields

Modifier and Type

Field

Description

static final int

OPEN_APPEND

static final int

OPEN_CREATE

static final int

OPEN_EXCLUSIVE

static final int

OPEN_READ

static final int

OPEN_TRUNCATE

static final int

OPEN_WRITE

static final int

VERSION_1

static final int

VERSION_2

static final int

VERSION_3

static final int

VERSION_4

Fields inherited from class com.sshtools.j2ssh.connection.Channel
connection, localChannelId, localPacketSize, localWindow, remoteChannelId, remotePacketSize, remoteWindow, state
Constructor Summary

Constructors

Constructor

Description

SftpSubsystemClient()

Creates a new SftpSubsystemClient object.
Method Summary

Modifier and Type

Method

Description

protected long

availableWindowSpace()

void

changePermissions(SftpFile file, int permissions)

void

changePermissions(SftpFile file, String permissions)

void

changePermissions(String filename, int permissions)

void

changePermissions(String filename, String permissions)

void

closeFile(SftpFile file)

protected void

closeHandle(byte[] handle)

void

createSymbolicLink(String targetpath, String linkpath)

String

getAbsolutePath(SftpFile file)

String

getAbsolutePath(String path)

FileAttributes

getAttributes(SftpFile file)

FileAttributes

getAttributes(String path)

String

getDefaultDirectory()

protected int

getMaximumPacketSize()

protected int

getMaximumWindowSpace()

protected int

getMinimumWindowSpace()

String

getName()

String

getSymbolicLinkTarget(String linkpath)

boolean

initialize()

protected boolean

isValidHandle(byte[] handle)

int

listChildren(SftpFile file, List children)

void

makeDirectory(String path)

protected long

maximumPacketSize()

SftpFile

openDirectory(String path)

SftpFile

openFile(String filename, int flags)

SftpFile

openFile(String absolutePath, int flags, FileAttributes attrs)

protected int

readFile(byte[] handle, UnsignedInteger64 offset, byte[] output, int off, int len)

void

recurseMakeDirectory(String path)

void

removeDirectory(String path)

void

removeFile(String filename)

void

renameFile(String oldpath, String newpath)

void

setAttributes(SftpFile file, FileAttributes attrs)

void

setAttributes(String path, FileAttributes attrs)

protected void

writeFile(byte[] handle, UnsignedInteger64 offset, byte[] data, int off, int len)

Methods inherited from class com.sshtools.j2ssh.subsystem.SubsystemChannel
getChannelConfirmationData, getChannelOpenData, getChannelType, onChannelClose, onChannelData, onChannelEOF, onChannelExtData, onChannelOpen, onChannelRequest, sendMessage, startSubsystem

Methods inherited from class com.sshtools.j2ssh.connection.Channel
addEventListener, close, finalizeClose, getLocalChannelId, getLocalPacketSize, getLocalWindow, getRemoteChannelId, getRemotePacketSize, getRemoteWindow, getState, init, init, isClosed, isLocalEOF, isOpen, isRemoteEOF, open, processChannelData, processChannelData, remoteClose, sendChannelData, sendChannelExtData, setLocalEOF, setName, setRemoteEOF

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- OPEN_READ
  
  public static final int OPEN_READ
  See Also:
  
  Constant Field Values
- OPEN_WRITE
  
  public static final int OPEN_WRITE
  See Also:
  
  Constant Field Values
- OPEN_APPEND
  
  public static final int OPEN_APPEND
  See Also:
  
  Constant Field Values
- OPEN_CREATE
  
  public static final int OPEN_CREATE
  See Also:
  
  Constant Field Values
- OPEN_TRUNCATE
  
  public static final int OPEN_TRUNCATE
  See Also:
  
  Constant Field Values
- OPEN_EXCLUSIVE
  
  public static final int OPEN_EXCLUSIVE
  See Also:
  
  Constant Field Values
- VERSION_1
  
  public static final int VERSION_1
  See Also:
  
  Constant Field Values
- VERSION_2
  
  public static final int VERSION_2
  See Also:
  
  Constant Field Values
- VERSION_3
  
  public static final int VERSION_3
  See Also:
  
  Constant Field Values
- VERSION_4
  
  public static final int VERSION_4
  See Also:
  
  Constant Field Values
Constructor Details
- SftpSubsystemClient
  
  public SftpSubsystemClient()
  
  Creates a new SftpSubsystemClient object.
Method Details
- getName
  
  public String getName()
  
  Overrides:
  
  getName in class Channel
  
  Returns:
- availableWindowSpace
  
  protected long availableWindowSpace()
  
  Returns:
- maximumPacketSize
  
  protected long maximumPacketSize()
  
  Returns:
- closeHandle
  
  protected void closeHandle(byte[] handle) throws IOException
  
  Parameters:
  
  handle -
  
  Throws:
  
  IOException
- closeFile
  
  public void closeFile(SftpFile file) throws IOException
  
  Parameters:
  
  file -
  
  Throws:
  
  IOException
- isValidHandle
  
  protected boolean isValidHandle(byte[] handle)
  
  Parameters:
  
  handle -
  
  Returns:
- listChildren
  
  public int listChildren(SftpFile file, List children) throws IOException
  
  Parameters:
  
  file -
  
  children -
  
  Returns:
  
  Throws:
  
  IOException
- makeDirectory
  
  public void makeDirectory(String path) throws IOException
  
  Parameters:
  
  path -
  
  Throws:
  
  IOException
- recurseMakeDirectory
  
  public void recurseMakeDirectory(String path) throws IOException
  
  Parameters:
  
  path -
  
  Throws:
  
  IOException
- openDirectory
  
  public SftpFile openDirectory(String path) throws IOException
  
  Parameters:
  
  path -
  
  Returns:
  
  Throws:
  
  IOException
- getDefaultDirectory
  
  public String getDefaultDirectory() throws IOException
  
  Returns:
  
  Throws:
  
  IOException
- getAbsolutePath
  
  public String getAbsolutePath(String path) throws IOException
  
  Parameters:
  
  path -
  
  Returns:
  
  Throws:
  
  IOException
- getAbsolutePath
  
  public String getAbsolutePath(SftpFile file) throws IOException
  
  Parameters:
  
  file -
  
  Returns:
  
  Throws:
  
  IOException
- openFile
  
  public SftpFile openFile(String filename, int flags) throws IOException
  
  Parameters:
  
  filename -
  
  flags -
  
  Returns:
  
  Throws:
  
  IOException
- openFile
  
  public SftpFile openFile(String absolutePath, int flags, FileAttributes attrs) throws IOException
  
  Parameters:
  
  absolutePath -
  
  flags -
  
  attrs -
  
  Returns:
  
  Throws:
  
  IOException
- getAttributes
  
  public FileAttributes getAttributes(String path) throws IOException
  
  Parameters:
  
  path -
  
  Returns:
  
  Throws:
  
  IOException
- getAttributes
  
  public FileAttributes getAttributes(SftpFile file) throws IOException
  
  Parameters:
  
  file -
  
  Returns:
  
  Throws:
  
  IOException
- readFile
  
  protected int readFile(byte[] handle, UnsignedInteger64 offset, byte[] output, int off, int len) throws IOException
  
  Parameters:
  
  handle -
  
  offset -
  
  output -
  
  off -
  
  len -
  
  Returns:
  
  Throws:
  
  IOException
- removeDirectory
  
  public void removeDirectory(String path) throws IOException
  
  Parameters:
  
  path -
  
  Throws:
  
  IOException
- removeFile
  
  public void removeFile(String filename) throws IOException
  
  Parameters:
  
  filename -
  
  Throws:
  
  IOException
- renameFile
  
  public void renameFile(String oldpath, String newpath) throws IOException
  
  Parameters:
  
  oldpath -
  
  newpath -
  
  Throws:
  
  IOException
- writeFile
  
  protected void writeFile(byte[] handle, UnsignedInteger64 offset, byte[] data, int off, int len) throws IOException
  
  Parameters:
  
  handle -
  
  offset -
  
  data -
  
  off -
  
  len -
  
  Throws:
  
  IOException
- createSymbolicLink
  
  public void createSymbolicLink(String targetpath, String linkpath) throws IOException
  
  Parameters:
  
  targetpath -
  
  linkpath -
  
  Throws:
  
  IOException
- getSymbolicLinkTarget
  
  public String getSymbolicLinkTarget(String linkpath) throws IOException
  
  Parameters:
  
  linkpath -
  
  Returns:
  
  Throws:
  
  IOException
- setAttributes
  
  public void setAttributes(String path, FileAttributes attrs) throws IOException
  
  Parameters:
  
  path -
  
  attrs -
  
  Throws:
  
  IOException
- setAttributes
  
  public void setAttributes(SftpFile file, FileAttributes attrs) throws IOException
  
  Parameters:
  
  file -
  
  attrs -
  
  Throws:
  
  IOException
- changePermissions
  
  public void changePermissions(SftpFile file, String permissions) throws IOException
  
  Parameters:
  
  file -
  
  permissions -
  
  Throws:
  
  IOException
- changePermissions
  
  public void changePermissions(SftpFile file, int permissions) throws IOException
  
  Parameters:
  
  file -
  
  permissions -
  
  Throws:
  
  IOException
- changePermissions
  
  public void changePermissions(String filename, int permissions) throws IOException
  
  Parameters:
  
  filename -
  
  permissions -
  
  Throws:
  
  IOException
- changePermissions
  
  public void changePermissions(String filename, String permissions) throws IOException
  
  Parameters:
  
  filename -
  
  permissions -
  
  Throws:
  
  IOException
- initialize
  
  public boolean initialize() throws IOException
  
  Returns:
  
  Throws:
  
  IOException
- getMinimumWindowSpace
  
  protected int getMinimumWindowSpace()
  
  Specified by:
  
  getMinimumWindowSpace in class Channel
  
  Returns:
- getMaximumWindowSpace
  
  protected int getMaximumWindowSpace()
  
  Specified by:
  
  getMaximumWindowSpace in class Channel
  
  Returns:
- getMaximumPacketSize
  
  protected int getMaximumPacketSize()
  
  Specified by:
  
  getMaximumPacketSize in class Channel
  
  Returns:

Class SftpSubsystemClient

Field Summary

Fields inherited from class com.sshtools.j2ssh.connection.Channel

Constructor Summary

Method Summary

Methods inherited from class com.sshtools.j2ssh.subsystem.SubsystemChannel

Methods inherited from class com.sshtools.j2ssh.connection.Channel

Methods inherited from class java.lang.Object

Field Details

OPEN_READ

OPEN_WRITE

OPEN_APPEND

OPEN_CREATE

OPEN_TRUNCATE

OPEN_EXCLUSIVE

VERSION_1

VERSION_2

VERSION_3

VERSION_4

Constructor Details

SftpSubsystemClient

Method Details

getName

availableWindowSpace

maximumPacketSize

closeHandle

closeFile

isValidHandle

listChildren

makeDirectory

recurseMakeDirectory

openDirectory

getDefaultDirectory

getAbsolutePath

getAbsolutePath

openFile

openFile

getAttributes

getAttributes

readFile

removeDirectory

removeFile

renameFile

writeFile

createSymbolicLink

getSymbolicLinkTarget

setAttributes

setAttributes

changePermissions

changePermissions

changePermissions

changePermissions

initialize

getMinimumWindowSpace

getMaximumWindowSpace

getMaximumPacketSize