Package com.sshtools.client.sftp

Class SftpFile

java.lang.Object

com.sshtools.client.sftp.SftpFile

public final class SftpFile
extends Object

Represents an SFTP file object.

Method Summary

Modifier and Type	Method	Description
SftpFileAttributes	attributes()	Get the attributes for this file as they were when this file object was obtained.
SftpFile	attributes(SftpFileAttributes attributes)	Set the given attributes on the remote file represented by this SftpFile.
boolean	canRead()	Deprecated, for removal: This API element is subject to removal in a future version.
boolean	canWrite()	Deprecated, for removal: This API element is subject to removal in a future version.
void	delete()	Delete this file/directory from the remote server.
boolean	equals(Object obj)
String	getAbsolutePath()	Get the absolute path
SftpFileAttributes	getAttributes()	Deprecated, for removal: This API element is subject to removal in a future version.
String	getFilename()	Get the filename.
String	getLongname()	The longname supplied by the server.
SftpFile	getParent()	Get the parent of the current file.
Object	getProperty(String key)	Deprecated, for removal: This API element is subject to removal in a future version.
SftpChannel	getSFTPChannel()	Get the SFTP subsystem channel that created this file object.
SftpHandle	handle(byte[] handle)	Create a new handle for this file given the handle data.
int	hashCode()
boolean	isBlock()	Deprecated, for removal: This API element is subject to removal in a future version.
boolean	isCharacter()	Deprecated, for removal: This API element is subject to removal in a future version.
boolean	isDirectory()	Deprecated, for removal: This API element is subject to removal in a future version.
boolean	isFifo()	Deprecated, for removal: This API element is subject to removal in a future version.
boolean	isFile()	Deprecated, for removal: This API element is subject to removal in a future version.
boolean	isLink()	Determine whether the file object is a symbolic link.
boolean	isSocket()	Deprecated, for removal: This API element is subject to removal in a future version.
SftpFile	refresh()	Refresh the SftpFileAttributes from the the remote file.
void	setProperty(String key, Object value)	Deprecated, for removal: This API element is subject to removal in a future version.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

handle

public SftpHandle handle(byte[] handle)

Create a new handle for this file given the handle data.

Parameters:

handle -

attributes

public SftpFileAttributes attributes()

Get the attributes for this file as they were when this file object was obtained. To get the latest attributes, call refresh() to obtain a new SftpFile instance.

Returns:

attributes

attributes

public SftpFile attributes(SftpFileAttributes attributes)
                    throws SftpStatusException,
SshException

Set the given attributes on the remote file represented by this SftpFile.

Parameters:

attributes -

Returns:

this

Throws:

SftpStatusException

SshException

refresh

public SftpFile refresh()
                 throws SftpStatusException,
SshException

Refresh the SftpFileAttributes from the the remote file.

Returns:

file new file instance

Throws:

SftpStatusException

SshException

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 String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getLongname

public String getLongname()

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

Returns:

delete

public void delete()
            throws SftpStatusException,
SshException

Delete this file/directory from the remote server.

Throws:

SshException

SftpStatusException

canWrite

@Deprecated(since="3.1.0",
            forRemoval=true)
public boolean canWrite()
                 throws SftpStatusException,
SshException

Deprecated, for removal: This API element is subject to removal in a future version.

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

@Deprecated(since="3.1.0",
            forRemoval=true)
public boolean canRead()
                throws SftpStatusException,
SshException

Deprecated, for removal: This API element is subject to removal in a future version.

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

getSFTPChannel

public SftpChannel getSFTPChannel()

Get the SFTP subsystem channel that created this file object.

Returns:

SftpSubsystemChannel

getFilename

public String getFilename()

Get the filename.

Returns:

String

getAttributes

@Deprecated(since="3.1.0",
            forRemoval=true)
public SftpFileAttributes getAttributes()
                                 throws SshException,
SftpStatusException

Deprecated, for removal: This API element is subject to removal in a future version.

Get the files attributes.

Returns:

SftpFileAttributes

Throws:

SshException

SftpStatusException

See Also:

• attributes()

getAbsolutePath

public String getAbsolutePath()

Get the absolute path

Returns:

String

isDirectory

@Deprecated(since="3.1.0",
            forRemoval=true)
public boolean isDirectory()
                    throws SftpStatusException,
SshException

Deprecated, for removal: This API element is subject to removal in a future version.

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.

Deprecated, see SftpFileAttributes.isDirectory().

Returns:

is directory

Throws:

SshException - on SSH error

SftpStatusException - on SFTP error

isFile

@Deprecated(since="3.1.0",
            forRemoval=true)
public boolean isFile()
               throws SftpStatusException,
SshException

Deprecated, for removal: This API element is subject to removal in a future version.

Determine whether the file object is pointing to a file.

Deprecated, see SftpFileAttributes.isDirectory().

Returns:

is file

Throws:

SshException - on SSH error

SftpStatusException - on SFTP error

isLink

public boolean isLink()
               throws SftpStatusException,
SshException

Determine whether the file object is a symbolic link.

Returns:

is link

Throws:

SshException - on SSH error

SftpStatusException - on SFTP error

isFifo

@Deprecated(since="3.1.0",
            forRemoval=true)
public boolean isFifo()
               throws SftpStatusException,
SshException

Deprecated, for removal: This API element is subject to removal in a future version.

Determine whether the file is pointing to a pipe.

Returns:

is fifo

Throws:

SshException - on SSH error

SftpStatusException - on SFTP error

isBlock

@Deprecated(since="3.1.0",
            forRemoval=true)
public boolean isBlock()
                throws SftpStatusException,
SshException

Deprecated, for removal: This API element is subject to removal in a future version.

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

Returns:

is block special file

Throws:

SshException - on SSH error

SftpStatusException - on SFTP error

isCharacter

@Deprecated(since="3.1.0",
            forRemoval=true)
public boolean isCharacter()
                    throws SftpStatusException,
SshException

Deprecated, for removal: This API element is subject to removal in a future version.

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

Returns:

is character mode device

Throws:

SshException - on SSH error

SftpStatusException - on SFTP error

isSocket

@Deprecated(since="3.1.0",
            forRemoval=true)
public boolean isSocket()
                 throws SftpStatusException,
SshException

Deprecated, for removal: This API element is subject to removal in a future version.

Determine whether the file is pointing to a socket.

Returns:

is socket file

Throws:

SshException - on SSH error

SftpStatusException - on SFTP error

setProperty

@Deprecated(since="3.1.0",
            forRemoval=true)
public void setProperty(String key,
 Object value)

Deprecated, for removal: This API element is subject to removal in a future version.

Set an arbitrary property in this file object.

Deprecated, no replacement.

Parameters:

key - key

value - vlaue

getProperty

@Deprecated(since="3.1.0",
            forRemoval=true)
public Object getProperty(String key)

Deprecated, for removal: This API element is subject to removal in a future version.

Get an arbitrary property stored in this file object.

Deprecated, no replacement.

Parameters:

key - key

Returns:

value