com.sshtools.common.sftp

Class AbstractFileSystem

java.lang.Object

com.sshtools.common.sftp.AbstractFileSystem

public final class AbstractFileSystem
extends java.lang.Object

This class is final. It may not be extended.

Author:

Lee David Painter

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractFileSystem.OpenDirectory
protected class	AbstractFileSystem.OpenFile

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AUTHORIZED_KEYS_STORE
protected AbstractFileFactory<?>	fileFactory
static int	OPEN_APPEND File open flag, forces all writes to append data at the end of the file.
static int	OPEN_CREATE File open flag, if specified a new file will be created if one does not already exist.
static int	OPEN_EXCLUSIVE File open flag, causes an open request to fail if the named file already exists.
static int	OPEN_READ File open flag, opens the file for reading.
static int	OPEN_TEXT Indicates the server should treat the file as text and convert it to the canoncial newline convention in use.
static int	OPEN_TRUNCATE File open flag, forces an existing file with the same name to be truncated to zero length when creating a file by specifying OPEN_CREATE.
static int	OPEN_WRITE File open flag, opens the file for writing.
protected java.util.Map<java.lang.String,AbstractFileSystem.OpenDirectory>	openDirectories
protected java.util.Map<java.lang.String,AbstractFileSystem.OpenFile>	openFiles
static java.lang.String	SCP
static java.lang.String	SFTP
static java.lang.String	SHELL

Constructor Summary

Constructors

Constructor and Description
AbstractFileSystem(SshConnection con, java.lang.String protocolInUse)

Method Summary

Modifier and Type	Method and Description
void	closeFile(byte[] handle)
boolean	closeFile(byte[] handle, boolean remove)
protected boolean	closeFile(java.lang.String handle, boolean remove)
void	closeFilesystem()
void	copyFile(java.lang.String oldpath, java.lang.String newpath, boolean overwrite)
void	createSymbolicLink(java.lang.String link, java.lang.String target)
boolean	fileExists(java.lang.String path)
SshConnection	getConnection()
java.lang.String	getDefaultPath()
SftpFileAttributes	getFileAttributes(byte[] handle)
SftpFileAttributes	getFileAttributes(java.lang.String path)
AbstractFileFactory<?>	getFileFactory()
AbstractFile	getFileForHandle(byte[] handle)
protected java.lang.String	getHandle(byte[] b)
protected byte[]	getHandle(java.lang.String handle)
java.lang.String	getPathForHandle(byte[] handle)
java.lang.String	getRealPath(java.lang.String path)
void	init(SshConnection con, java.lang.String protocolInUse)
boolean	makeDirectory(java.lang.String path, SftpFileAttributes attrs)
byte[]	openDirectory(java.lang.String path)
byte[]	openDirectory(java.lang.String path, SftpFileFilter filter)
byte[]	openFile(java.lang.String path, com.sshtools.common.util.UnsignedInteger32 flags, SftpFileAttributes attrs)
void	populateEvent(Event evt)
SftpFile[]	readDirectory(byte[] handle)
int	readFile(byte[] handle, com.sshtools.common.util.UnsignedInteger64 offset, byte[] buf, int start, int numBytesToRead)
SftpFile	readSymbolicLink(java.lang.String link)
void	removeDirectory(java.lang.String path)
void	removeFile(java.lang.String path)
void	renameFile(java.lang.String oldpath, java.lang.String newpath)
protected AbstractFile	resolveFile(java.lang.String path, SshConnection con)
void	setFileAttributes(byte[] handle, SftpFileAttributes attrs)
void	setFileAttributes(java.lang.String path, SftpFileAttributes attrs)
void	writeFile(byte[] handle, com.sshtools.common.util.UnsignedInteger64 offset, byte[] data, int off, int len)

Methods inherited from class java.lang.Object

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

Field Detail

OPEN_READ

public static final int OPEN_READ

File open flag, opens the file for reading.

See Also:

Constant Field Values

OPEN_WRITE

public static final int OPEN_WRITE

File open flag, opens the file for writing.

See Also:

Constant Field Values

OPEN_APPEND

public static final int OPEN_APPEND

File open flag, forces all writes to append data at the end of the file.

See Also:

Constant Field Values

OPEN_CREATE

public static final int OPEN_CREATE

File open flag, if specified a new file will be created if one does not already exist.

See Also:

Constant Field Values

OPEN_TRUNCATE

public static final int OPEN_TRUNCATE

File open flag, forces an existing file with the same name to be truncated to zero length when creating a file by specifying OPEN_CREATE.

See Also:

Constant Field Values

OPEN_EXCLUSIVE

public static final int OPEN_EXCLUSIVE

File open flag, causes an open request to fail if the named file already exists. OPEN_CREATE must also be specified if this flag is used.

See Also:

Constant Field Values

OPEN_TEXT

public static final int OPEN_TEXT

Indicates the server should treat the file as text and convert it to the canoncial newline convention in use.

See Also:

Constant Field Values

AUTHORIZED_KEYS_STORE

public static final java.lang.String AUTHORIZED_KEYS_STORE

See Also:

Constant Field Values

SFTP

public static final java.lang.String SFTP

See Also:

Constant Field Values

SCP

public static final java.lang.String SCP

See Also:

Constant Field Values

SHELL

public static final java.lang.String SHELL

See Also:

Constant Field Values

openFiles

protected java.util.Map<java.lang.String,AbstractFileSystem.OpenFile> openFiles

openDirectories

protected java.util.Map<java.lang.String,AbstractFileSystem.OpenDirectory> openDirectories

fileFactory

protected AbstractFileFactory<?> fileFactory

Constructor Detail

AbstractFileSystem

public AbstractFileSystem(SshConnection con,
                          java.lang.String protocolInUse)
                   throws java.io.IOException,
                          PermissionDeniedException

Throws:

java.io.IOException

PermissionDeniedException

Method Detail

getFileFactory

public AbstractFileFactory<?> getFileFactory()

init

public void init(SshConnection con,
                 java.lang.String protocolInUse)

resolveFile

protected AbstractFile resolveFile(java.lang.String path,
                                   SshConnection con)
                            throws PermissionDeniedException,
                                   java.io.IOException

Throws:

PermissionDeniedException

java.io.IOException

closeFilesystem

public void closeFilesystem()

makeDirectory

public boolean makeDirectory(java.lang.String path,
                             SftpFileAttributes attrs)
                      throws PermissionDeniedException,
                             java.io.FileNotFoundException,
                             java.io.IOException

Throws:

PermissionDeniedException

java.io.FileNotFoundException

java.io.IOException

getFileAttributes

public SftpFileAttributes getFileAttributes(byte[] handle)
                                     throws java.io.IOException,
                                            InvalidHandleException,
                                            PermissionDeniedException

Throws:

java.io.IOException

InvalidHandleException

PermissionDeniedException

getFileAttributes

public SftpFileAttributes getFileAttributes(java.lang.String path)
                                     throws java.io.IOException,
                                            java.io.FileNotFoundException,
                                            PermissionDeniedException

Throws:

java.io.IOException

java.io.FileNotFoundException

PermissionDeniedException

openDirectory

public byte[] openDirectory(java.lang.String path)
                     throws PermissionDeniedException,
                            java.io.FileNotFoundException,
                            java.io.IOException

Throws:

PermissionDeniedException

java.io.FileNotFoundException

java.io.IOException

openDirectory

public byte[] openDirectory(java.lang.String path,
                            SftpFileFilter filter)
                     throws PermissionDeniedException,
                            java.io.FileNotFoundException,
                            java.io.IOException

Throws:

PermissionDeniedException

java.io.FileNotFoundException

java.io.IOException

getHandle

protected byte[] getHandle(java.lang.String handle)

getHandle

protected java.lang.String getHandle(byte[] b)

readDirectory

public SftpFile[] readDirectory(byte[] handle)
                         throws InvalidHandleException,
                                java.io.EOFException,
                                java.io.IOException,
                                PermissionDeniedException

Throws:

InvalidHandleException

java.io.EOFException

java.io.IOException

PermissionDeniedException

openFile

public byte[] openFile(java.lang.String path,
                       com.sshtools.common.util.UnsignedInteger32 flags,
                       SftpFileAttributes attrs)
                throws PermissionDeniedException,
                       java.io.FileNotFoundException,
                       java.io.IOException

Throws:

PermissionDeniedException

java.io.FileNotFoundException

java.io.IOException

readFile

public int readFile(byte[] handle,
                    com.sshtools.common.util.UnsignedInteger64 offset,
                    byte[] buf,
                    int start,
                    int numBytesToRead)
             throws InvalidHandleException,
                    java.io.EOFException,
                    java.io.IOException,
                    PermissionDeniedException

Throws:

InvalidHandleException

java.io.EOFException

java.io.IOException

PermissionDeniedException

writeFile

public void writeFile(byte[] handle,
                      com.sshtools.common.util.UnsignedInteger64 offset,
                      byte[] data,
                      int off,
                      int len)
               throws InvalidHandleException,
                      java.io.IOException,
                      PermissionDeniedException

Throws:

InvalidHandleException

java.io.IOException

PermissionDeniedException

closeFile

public void closeFile(byte[] handle)
               throws InvalidHandleException,
                      java.io.IOException

Throws:

InvalidHandleException

java.io.IOException

closeFile

public boolean closeFile(byte[] handle,
                         boolean remove)
                  throws InvalidHandleException,
                         java.io.IOException

Throws:

InvalidHandleException

java.io.IOException

closeFile

protected boolean closeFile(java.lang.String handle,
                            boolean remove)
                     throws InvalidHandleException,
                            java.io.IOException

Throws:

InvalidHandleException

java.io.IOException

removeFile

public void removeFile(java.lang.String path)
                throws PermissionDeniedException,
                       java.io.IOException,
                       java.io.FileNotFoundException

Throws:

PermissionDeniedException

java.io.IOException

java.io.FileNotFoundException

renameFile

public void renameFile(java.lang.String oldpath,
                       java.lang.String newpath)
                throws PermissionDeniedException,
                       java.io.FileNotFoundException,
                       java.io.IOException

Throws:

PermissionDeniedException

java.io.FileNotFoundException

java.io.IOException

copyFile

public void copyFile(java.lang.String oldpath,
                     java.lang.String newpath,
                     boolean overwrite)
              throws PermissionDeniedException,
                     java.io.FileNotFoundException,
                     java.io.IOException

Throws:

PermissionDeniedException

java.io.FileNotFoundException

java.io.IOException

getDefaultPath

public java.lang.String getDefaultPath()
                                throws java.io.IOException,
                                       PermissionDeniedException

Throws:

java.io.IOException

PermissionDeniedException

removeDirectory

public void removeDirectory(java.lang.String path)
                     throws PermissionDeniedException,
                            java.io.FileNotFoundException,
                            java.io.IOException

Throws:

PermissionDeniedException

java.io.FileNotFoundException

java.io.IOException

setFileAttributes

public void setFileAttributes(java.lang.String path,
                              SftpFileAttributes attrs)
                       throws PermissionDeniedException,
                              java.io.IOException,
                              java.io.FileNotFoundException

Throws:

PermissionDeniedException

java.io.IOException

java.io.FileNotFoundException

setFileAttributes

public void setFileAttributes(byte[] handle,
                              SftpFileAttributes attrs)
                       throws PermissionDeniedException,
                              java.io.IOException,
                              InvalidHandleException

Throws:

PermissionDeniedException

java.io.IOException

InvalidHandleException

readSymbolicLink

public SftpFile readSymbolicLink(java.lang.String link)
                          throws UnsupportedFileOperationException,
                                 java.io.FileNotFoundException,
                                 java.io.IOException,
                                 PermissionDeniedException

Throws:

UnsupportedFileOperationException

java.io.FileNotFoundException

java.io.IOException

PermissionDeniedException

createSymbolicLink

public void createSymbolicLink(java.lang.String link,
                               java.lang.String target)
                        throws UnsupportedFileOperationException,
                               java.io.FileNotFoundException,
                               java.io.IOException,
                               PermissionDeniedException

Throws:

UnsupportedFileOperationException

java.io.FileNotFoundException

java.io.IOException

PermissionDeniedException

fileExists

public boolean fileExists(java.lang.String path)
                   throws java.io.IOException,
                          PermissionDeniedException

Throws:

java.io.IOException

PermissionDeniedException

getRealPath

public java.lang.String getRealPath(java.lang.String path)
                             throws java.io.IOException,
                                    java.io.FileNotFoundException,
                                    PermissionDeniedException

Throws:

java.io.IOException

java.io.FileNotFoundException

PermissionDeniedException

getFileForHandle

public AbstractFile getFileForHandle(byte[] handle)
                              throws java.io.IOException,
                                     InvalidHandleException

Throws:

java.io.IOException

InvalidHandleException

populateEvent

public void populateEvent(Event evt)

getConnection

public SshConnection getConnection()

getPathForHandle

public java.lang.String getPathForHandle(byte[] handle)
                                  throws java.io.IOException,
                                         InvalidHandleException

Throws:

java.io.IOException

InvalidHandleException