com.sshtools.client.sftp

Class SftpFile

java.lang.Object

com.sshtools.client.sftp.SftpFile

public class SftpFile
extends java.lang.Object

Represents an SFTP file object.

Constructor Summary

Constructors

Constructor and Description
SftpFile(java.lang.String path, SftpFileAttributes attrs) Creates a new SftpFile object.

Method Summary

Modifier and Type	Method and Description
boolean	canRead() Determine whether the user has read access to the file.
boolean	canWrite() Determine whether the user has write access to the file.
void	close() Close the file.
void	delete() Delete this file/directory from the remote server.
boolean	equals(java.lang.Object obj) Compares the Object to this instance and returns true if they point to the same file.
java.lang.String	getAbsolutePath() Get the absolute path
SftpFileAttributes	getAttributes() Get the files attributes.
java.lang.String	getFilename() Get the filename.
byte[]	getHandle() Get the open file handle
java.lang.String	getLongname() The longname supplied by the server.
SftpFile	getParent() Get the parent of the current file.
java.lang.Object	getProperty(java.lang.String key)
SftpChannel	getSFTPChannel() Get the SFTP subsystem channel that created this file object.
int	hashCode()
boolean	isBlock() Determine whether the file is pointing to a block special file.
boolean	isCharacter() Determine whether the file is pointing to a character mode device.
boolean	isDirectory() Determine whether the file object is pointing to a directory.
boolean	isFifo() Determine whether the file is pointing to a pipe.
boolean	isFile() Determine whether the file object is pointing to a file.
boolean	isLink() Determine whether the file object is a symbolic link.
boolean	isOpen() Determine whether the file is open.
boolean	isSocket() Determine whether the file is pointing to a socket.
int	read(long offset, byte[] output, int outputOffset, int len) Read bytes directly from this file.
void	setProperty(java.lang.String key, java.lang.Object value)
java.lang.String	toString()
void	write(long offset, byte[] input, int inputOffset, int len) Write bytes directly to this file.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SftpFile

public SftpFile(java.lang.String path,
                SftpFileAttributes attrs)

Creates a new SftpFile object.

Parameters:

path -

attrs -

Method Detail

getParent

public SftpFile getParent()
                   throws SshException,
                          SftpStatusException

Get the parent of the current file. This method determines the correct path of the parent file; if no parent exists (i.e. the current file is the root of the filesystem) then this method returns a null value.

Returns:

SftpFile

Throws:

SshException

SftpStatusException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getLongname

public java.lang.String getLongname()

The longname supplied by the server. Note this will not be present if SFTP version is > 3.

Returns:

equals

public boolean equals(java.lang.Object obj)

Compares the Object to this instance and returns true if they point to the same file. If they point to the same file but have open file handles, the handles are also used to determine the equality. Therefore two separate instances both pointing to the same file will return true, unless one or both have an open file handle in which case it will only return true if the file handles also match.

Overrides:

equals in class java.lang.Object

Parameters:

obj -

Returns:

boolean

delete

public void delete()
            throws SftpStatusException,
                   SshException

Delete this file/directory from the remote server.

Throws:

SshException

SftpStatusException

read

public int read(long offset,
                byte[] output,
                int outputOffset,
                int len)
         throws SftpStatusException,
                SshException

Read bytes directly from this file. This is a low-level operation, you may only need to use SftpClientTask.get(String) methods instead if you just want to download files.

Parameters:

offset - offset in remote file to read from

output - output buffer to place read bytes in

outputOffset - offset in output buffer to write bytes to

len - number of bytes to read

Returns:

int number of bytes read

Throws:

SftpStatusException

SshException

write

public void write(long offset,
                  byte[] input,
                  int inputOffset,
                  int len)
           throws SftpStatusException,
                  SshException

Write bytes directly to this file. This is a low-level operation, you may only need to use SftpClientTask.put(String) methods instead if you just want to upload files.

Parameters:

offset - offset in remote file to write to

input - input buffer to retrieve bytes from to write

inputOffset - offset in output buffer to write bytes to

len - number of bytes to write

Throws:

SftpStatusException

SshException

canWrite

public boolean canWrite()
                 throws SftpStatusException,
                        SshException

Determine whether the user has write access to the file. This checks the S_IWUSR flag is set in permissions.

Returns:

boolean

Throws:

SftpStatusException

SshException

canRead

public boolean canRead()
                throws SftpStatusException,
                       SshException

Determine whether the user has read access to the file. This checks the S_IRUSR flag is set in permissions.

Returns:

boolean

Throws:

SftpStatusException

SshException

isOpen

public boolean isOpen()

Determine whether the file is open.

Returns:

boolean

getHandle

public byte[] getHandle()

Get the open file handle

Returns:

byte[]

getSFTPChannel

public SftpChannel getSFTPChannel()

Get the SFTP subsystem channel that created this file object.

Returns:

SftpSubsystemChannel

getFilename

public java.lang.String getFilename()

Get the filename.

Returns:

String

getAttributes

public SftpFileAttributes getAttributes()
                                 throws SftpStatusException,
                                        SshException

Get the files attributes.

Returns:

SftpFileAttributes

Throws:

SshException

SftpStatusException

getAbsolutePath

public java.lang.String getAbsolutePath()

Get the absolute path

Returns:

String

close

public void close()
           throws SftpStatusException,
                  SshException

Close the file.

Throws:

SshException

SftpStatusException

isDirectory

public boolean isDirectory()
                    throws SftpStatusException,
                           SshException

Determine whether the file object is pointing to a directory. Note, if the file is a symbolic link pointing to a directory then false will be returned. Use com.sshtools.sftp.SftpClient#isDirectoryOrLinkedDirectory(SftpFile) instead if you wish to follow links.

Returns:

boolean

Throws:

SshException

SftpStatusException

isFile

public boolean isFile()
               throws SftpStatusException,
                      SshException

Determine whether the file object is pointing to a file.

Returns:

boolean

Throws:

SshException

SftpStatusException

isLink

public boolean isLink()
               throws SftpStatusException,
                      SshException

Determine whether the file object is a symbolic link.

Returns:

boolean

Throws:

SshException

SftpStatusException

isFifo

public boolean isFifo()
               throws SftpStatusException,
                      SshException

Determine whether the file is pointing to a pipe.

Returns:

boolean

Throws:

SshException

SftpStatusException

isBlock

public boolean isBlock()
                throws SftpStatusException,
                       SshException

Determine whether the file is pointing to a block special file.

Returns:

boolean

Throws:

SshException

SftpStatusException

isCharacter

public boolean isCharacter()
                    throws SftpStatusException,
                           SshException

Determine whether the file is pointing to a character mode device.

Returns:

boolean

Throws:

SshException

SftpStatusException

isSocket

public boolean isSocket()
                 throws SftpStatusException,
                        SshException

Determine whether the file is pointing to a socket.

Returns:

boolean

Throws:

SshException

SftpStatusException

setProperty

public void setProperty(java.lang.String key,
                        java.lang.Object value)

getProperty

public java.lang.Object getProperty(java.lang.String key)