net.scharlie.lj4l.core.io.remote.sftp

Class SftpFileProxy

java.lang.Object

net.scharlie.lj4l.core.io.remote.sftp.SftpFileProxy

public final class SftpFileProxy
extends Object

This class is a proxy for a remote file accessed via SFTP.

Instances of this class are not safe for use by multiple threads.

Constructor Summary

Constructors

Constructor and Description
SftpFileProxy(SftpChannel channel, String path) Create a SFTP file proxy.

Method Summary

Modifier and Type	Method and Description
SftpFileProxy	getChild(String name) Get the child with the given name.
Collection<SftpFileProxy>	getChildren() Get the list of children.
SftpFileProxy	getParent() Get the parent.
boolean	isDirectory() Answer whether this is a directory.
boolean	isRootDirectory() Answer whether this is the root directory.
long	lastModifiedInMillis() Get the time stamp of the last file modification in milliseconds since 1.1.1970.
long	lengthInBytes() Get the current length of the file in bytes.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SftpFileProxy

public SftpFileProxy(SftpChannel channel,
                     String path)
              throws NotConnectedException

Create a SFTP file proxy.

Parameters:

channel - The SFTP channel

path - The path to the file on the remote machine

Throws:

IllegalArgumentException - if the SFTP channel is null

IllegalArgumentException - if the path is null or blank

NotConnectedException - if the SFTP channel is not connected

Method Detail

getChild

public final SftpFileProxy getChild(String name)
                             throws NotConnectedException

Get the child with the given name.

Parameters:

name - The name of the child

Returns:

The child or null

Throws:

NotConnectedException - if the list of children cannot be fetched

getChildren

public final Collection<SftpFileProxy> getChildren()
                                            throws NotConnectedException

Get the list of children.

Returns:

The list of children

Throws:

NotConnectedException - if the list of children cannot be fetched

isDirectory

public final boolean isDirectory()
                          throws NotConnectedException

Answer whether this is a directory.

Returns:

answer

Throws:

NotConnectedException - if the file attributes cannot be fetched

isRootDirectory

public final boolean isRootDirectory()

Answer whether this is the root directory.

Returns:

answer

lengthInBytes

public final long lengthInBytes()
                         throws NotConnectedException

Get the current length of the file in bytes.

Returns:

length in bytes

Throws:

NotConnectedException - if the file attributes cannot be fetched

lastModifiedInMillis

public final long lastModifiedInMillis()
                                throws NotConnectedException

Get the time stamp of the last file modification in milliseconds since 1.1.1970.

Returns:

time stamp in milliseconds

Throws:

NotConnectedException - if the file attributes cannot be fetched

getParent

public final SftpFileProxy getParent()
                              throws NotConnectedException

Get the parent.

Returns:

The parent or null if this is the root directory

Throws:

NotConnectedException - in case of being not connected

toString

public final String toString()

Overrides:

toString in class Object