com.sshtools.proxy

Class ProxyFile

java.lang.Object

com.sshtools.proxy.ProxyFile

All Implemented Interfaces:

AbstractFile

public class ProxyFile
extends Object
implements AbstractFile

Version:

: 1.0

Author:

: Aruna Abesekara, : Lee David Painter

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ProxyFile(com.maverick.sftp.SftpFile file, com.sshtools.sftp.SftpClient sftp, ProxyFileFactory factory)
protected	ProxyFile(String name, com.sshtools.sftp.SftpClient sftp, ProxyFileFactory factory)

Method Summary

Modifier and Type	Method and Description
void	copyFrom(AbstractFile src) Copy contain of source file to this file
boolean	createFolder() Create the folder in the server
boolean	createNewFile() Create the file in the server
boolean	delete(boolean recursive) Delete file or folder in the server
boolean	exists() Whether file or folder exist in the server
String	getAbsolutePath() Return the absolute path to the file
SftpFileAttributes	getAttributes() This method returns SftpFileAttributes of the file
String	getCanonicalPath() This method return Canonical path of the file
List<AbstractFile>	getChildren() This method return the list of Abstractfile this ProxyFile has.
AbstractFileFactory<? extends AbstractFile>	getFileFactory()
InputStream	getInputStream()
String	getName()
OutputStream	getOutputStream()
OutputStream	getOutputStream(boolean append)
boolean	isDirectory()
boolean	isFile()
boolean	isHidden()
boolean	isReadable()
boolean	isWritable()
long	lastModified() get the last modified time of the file.
long	length() get the size of the file
void	moveTo(AbstractFile destination)
AbstractFileRandomAccess	openFile(boolean writeAccess) This method is not supported
void	refresh()
AbstractFile	resolveFile(String path)
void	setAttributes(SftpFileAttributes newAtt)
boolean	supportsRandomAccess() random access is not supported
void	truncate()

Methods inherited from class java.lang.Object

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

Constructor Detail

ProxyFile

protected ProxyFile(String name,
                    com.sshtools.sftp.SftpClient sftp,
                    ProxyFileFactory factory)
             throws com.maverick.sftp.SftpStatusException,
                    SshException

Parameters:

name - : file or folder name

sftp - : SftpClient instance representing the remore file system

Throws:

SshException

com.maverick.sftp.SftpStatusException

ProxyFile

protected ProxyFile(com.maverick.sftp.SftpFile file,
                    com.sshtools.sftp.SftpClient sftp,
                    ProxyFileFactory factory)
             throws com.maverick.sftp.SftpStatusException,
                    SshException

Throws:

com.maverick.sftp.SftpStatusException

SshException

Method Detail

copyFrom

public void copyFrom(AbstractFile src)
              throws IOException,
                     PermissionDeniedException

Copy contain of source file to this file

Specified by:

copyFrom in interface AbstractFile

Parameters:

src - : source in which data to be copied. It should a file.

Throws:

: - system throws IOException if the source is not a file or unable to connect to source file.

IOException

PermissionDeniedException

createFolder

public boolean createFolder()
                     throws PermissionDeniedException,
                            IOException

Create the folder in the server

Specified by:

createFolder in interface AbstractFile

Throws:

PermissionDeniedException

IOException

createNewFile

public boolean createNewFile()
                      throws PermissionDeniedException,
                             IOException

Create the file in the server

Specified by:

createNewFile in interface AbstractFile

Throws:

PermissionDeniedException

IOException

delete

public boolean delete(boolean recursive)
               throws IOException,
                      PermissionDeniedException

Delete file or folder in the server

Specified by:

delete in interface AbstractFile

Parameters:

recrusive - : if the file is folder delete contain of folder recursively

Returns:

true if deletion is success

Throws:

throws - IOException

IOException

PermissionDeniedException

exists

public boolean exists()
               throws IOException

Whether file or folder exist in the server

Specified by:

exists in interface AbstractFile

Returns:

true if file or folder is exist.

Throws:

throws - IOException if unable to connect to the server

IOException

getAbsolutePath

public String getAbsolutePath()
                       throws IOException,
                              PermissionDeniedException

Return the absolute path to the file

Specified by:

getAbsolutePath in interface AbstractFile

Returns:

absolute path

Throws:

IOException

PermissionDeniedException

getAttributes

public SftpFileAttributes getAttributes()
                                 throws FileNotFoundException,
                                        IOException,
                                        PermissionDeniedException

This method returns SftpFileAttributes of the file

Specified by:

getAttributes in interface AbstractFile

Returns:

SftpFileAttributes

Throws:

FileNotFoundException

IOException

PermissionDeniedException

getCanonicalPath

public String getCanonicalPath()
                        throws IOException,
                               PermissionDeniedException

This method return Canonical path of the file

Specified by:

getCanonicalPath in interface AbstractFile

Throws:

IOException

PermissionDeniedException

getChildren

public List<AbstractFile> getChildren()
                               throws IOException,
                                      PermissionDeniedException

This method return the list of Abstractfile this ProxyFile has. If the ProxyFile represent not a directory this returns null;

Specified by:

getChildren in interface AbstractFile

Returns:

Throws:

IOException

PermissionDeniedException

getFileFactory

public AbstractFileFactory<? extends AbstractFile> getFileFactory()

Specified by:

getFileFactory in interface AbstractFile

getInputStream

public InputStream getInputStream()
                           throws IOException

Specified by:

getInputStream in interface AbstractFile

Throws:

IOException

getName

public String getName()

Specified by:

getName in interface AbstractFile

getOutputStream

public OutputStream getOutputStream()
                             throws IOException

Specified by:

getOutputStream in interface AbstractFile

Throws:

IOException

getOutputStream

public OutputStream getOutputStream(boolean append)
                             throws IOException

Specified by:

getOutputStream in interface AbstractFile

Throws:

IOException

isDirectory

public boolean isDirectory()
                    throws IOException

Specified by:

isDirectory in interface AbstractFile

Throws:

IOException

isFile

public boolean isFile()
               throws IOException

Specified by:

isFile in interface AbstractFile

Throws:

IOException

isHidden

public boolean isHidden()
                 throws IOException

Specified by:

isHidden in interface AbstractFile

Throws:

IOException

isReadable

public boolean isReadable()
                   throws IOException

Specified by:

isReadable in interface AbstractFile

Throws:

IOException

isWritable

public boolean isWritable()
                   throws IOException

Specified by:

isWritable in interface AbstractFile

Throws:

IOException

lastModified

public long lastModified()
                  throws IOException

get the last modified time of the file.

Specified by:

lastModified in interface AbstractFile

Returns:

: last modified time of file in seconds.

Throws:

IOException

length

public long length()
            throws IOException

get the size of the file

Specified by:

length in interface AbstractFile

Returns:

: the size of the file in bytes

Throws:

: - IOException if unable to access remote file

IOException

moveTo

public void moveTo(AbstractFile destination)
            throws IOException,
                   PermissionDeniedException

Specified by:

moveTo in interface AbstractFile

Throws:

IOException

PermissionDeniedException

openFile

public AbstractFileRandomAccess openFile(boolean writeAccess)
                                  throws IOException

This method is not supported

Specified by:

openFile in interface AbstractFile

Throws:

IOException

refresh

public void refresh()

Specified by:

refresh in interface AbstractFile

resolveFile

public AbstractFile resolveFile(String path)
                         throws IOException,
                                PermissionDeniedException

Specified by:

resolveFile in interface AbstractFile

Throws:

IOException

PermissionDeniedException

setAttributes

public void setAttributes(SftpFileAttributes newAtt)
                   throws IOException

Specified by:

setAttributes in interface AbstractFile

Throws:

IOException

supportsRandomAccess

public boolean supportsRandomAccess()

random access is not supported

Specified by:

supportsRandomAccess in interface AbstractFile

truncate

public void truncate()
              throws PermissionDeniedException,
                     IOException

Specified by:

truncate in interface AbstractFile

Throws:

PermissionDeniedException

IOException