Package com.sshtools.common.sftp

Class AbstractFileSystem

java.lang.Object

com.sshtools.common.sftp.AbstractFileSystem

public final class AbstractFileSystem
extends Object

This class is final. It may not be extended.

Author:

Lee David Painter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	AbstractFileSystem.OpenDirectory

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUTHORIZED_KEYS_STORE
static final int	BLOCK_ADVISORY
static final int	BLOCK_DELETE
static final int	BLOCK_READ
static final int	BLOCK_WRITE
protected AbstractFileFactory<?>	fileFactory
static final int	OPEN_APPEND	File open flag, forces all writes to append data at the end of the file.
static final int	OPEN_CREATE	File open flag, if specified a new file will be created if one does not already exist.
static final int	OPEN_EXCLUSIVE	File open flag, causes an open request to fail if the named file already exists.
static final int	OPEN_READ	File open flag, opens the file for reading.
static final int	OPEN_TEXT	Indicates the server should treat the file as text and convert it to the canoncial newline convention in use.
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.
static final int	OPEN_WRITE	File open flag, opens the file for writing.
protected Map<String,AbstractFileSystem.OpenDirectory>	openDirectories
protected Map<String,OpenFile>	openFiles
static final String	SCP
static final String	SFTP
static final String	SHELL

Constructor Summary

Constructors

Constructor	Description
AbstractFileSystem(SshConnection con, String protocolInUse)

Method Summary

Modifier and Type	Method	Description
protected void	checkOpenFlagsAndFileState(String path, com.sshtools.common.util.UnsignedInteger32 flags, AbstractFile f)	Deprecated.
void	closeFile(byte[] handle)
void	closeFile(String handle)
void	closeFilesystem()
void	copyData(byte[] handle, com.sshtools.common.util.UnsignedInteger64 offset, com.sshtools.common.util.UnsignedInteger64 length, byte[] toHandle, com.sshtools.common.util.UnsignedInteger64 toOffset)
void	copyFile(String oldpath, String newpath, boolean overwrite)
void	createLink(String link, String target)
void	createSymbolicLink(String link, String target)
boolean	fileExists(String path)
boolean	fileExists(String path, boolean followLinks)
void	freeHandle(byte[] handle)
SshConnection	getConnection()
String	getDefaultPath()
SftpFileAttributes	getFileAttributes(byte[] handle)
SftpFileAttributes	getFileAttributes(String path)
SftpFileAttributes	getFileAttributes(String path, boolean followSymlinks)
AbstractFileFactory<?>	getFileFactory()
AbstractFile	getFileForHandle(byte[] handle)
String	getPathForHandle(byte[] handle)
String	getRealPath(String path)
FileVolume	getVolume(String path)
String	handleToString(byte[] b)
void	init(SshConnection con, String protocolInUse)
boolean	isMultipartTransferSupported(String path)
boolean	makeDirectory(String path, SftpFileAttributes attrs)
byte[]	openDirectory(String path)
byte[]	openDirectory(String path, SftpFileFilter filter)
byte[]	openFile(String path, com.sshtools.common.util.UnsignedInteger32 flags, SftpFileAttributes attrs)	Deprecated.
byte[]	openFile(String path, com.sshtools.common.util.UnsignedInteger32 flags, Optional<com.sshtools.common.util.UnsignedInteger32> accessFlags, SftpFileAttributes attrs)
byte[]	openPart(String uuid, Multipart part)
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(String link)
void	removeDirectory(String path)
void	removeFile(String path)
void	renameFile(String oldpath, String newpath)
protected AbstractFile	resolveFile(String path, SshConnection con)
void	setFileAttributes(byte[] handle, SftpFileAttributes attrs)
void	setFileAttributes(String path, SftpFileAttributes attrs)
MultipartTransfer	startMultipartUpload(AbstractFile targetFile)
byte[]	stringToHandle(String handle)
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 Details

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

BLOCK_READ

public static final int BLOCK_READ

See Also:

• Constant Field Values

BLOCK_WRITE

public static final int BLOCK_WRITE

See Also:

• Constant Field Values

BLOCK_DELETE

public static final int BLOCK_DELETE

See Also:

• Constant Field Values

BLOCK_ADVISORY

public static final int BLOCK_ADVISORY

See Also:

• Constant Field Values

AUTHORIZED_KEYS_STORE

public static final String AUTHORIZED_KEYS_STORE

See Also:

• Constant Field Values

SFTP

public static final String SFTP

See Also:

• Constant Field Values

SCP

public static final String SCP

See Also:

• Constant Field Values

SHELL

public static final String SHELL

See Also:

• Constant Field Values

openFiles

protected Map<String,OpenFile> openFiles

openDirectories

protected Map<String,AbstractFileSystem.OpenDirectory> openDirectories

fileFactory

protected AbstractFileFactory<?> fileFactory

Constructor Details

AbstractFileSystem

public AbstractFileSystem(SshConnection con,
 String protocolInUse)
                   throws IOException,
PermissionDeniedException

Throws:

IOException

PermissionDeniedException

Method Details

getFileFactory

public AbstractFileFactory<?> getFileFactory()

init

public void init(SshConnection con,
 String protocolInUse)

resolveFile

protected AbstractFile resolveFile(String path,
 SshConnection con)
                            throws PermissionDeniedException,
IOException

Throws:

PermissionDeniedException

IOException

closeFilesystem

public void closeFilesystem()

makeDirectory

public boolean makeDirectory(String path,
 SftpFileAttributes attrs)
                      throws PermissionDeniedException,
FileNotFoundException,
IOException

Throws:

PermissionDeniedException

FileNotFoundException

IOException

getFileAttributes

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

Throws:

IOException

InvalidHandleException

PermissionDeniedException

getFileAttributes

public SftpFileAttributes getFileAttributes(String path)
                                     throws FileNotFoundException,
IOException,
PermissionDeniedException

Throws:

FileNotFoundException

IOException

PermissionDeniedException

getFileAttributes

public SftpFileAttributes getFileAttributes(String path,
 boolean followSymlinks)
                                     throws IOException,
FileNotFoundException,
PermissionDeniedException

Throws:

IOException

FileNotFoundException

PermissionDeniedException

openDirectory

public byte[] openDirectory(String path)
                     throws PermissionDeniedException,
FileNotFoundException,
IOException

Throws:

PermissionDeniedException

FileNotFoundException

IOException

openDirectory

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

Throws:

PermissionDeniedException

FileNotFoundException

IOException

stringToHandle

public byte[] stringToHandle(String handle)

handleToString

public String handleToString(byte[] b)

readDirectory

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

Throws:

InvalidHandleException

EOFException

IOException

PermissionDeniedException

openFile

@Deprecated(since="3.1.0")
public byte[] openFile(String path,
 com.sshtools.common.util.UnsignedInteger32 flags,
 SftpFileAttributes attrs)
                throws PermissionDeniedException,
FileNotFoundException,
IOException

Deprecated.

Throws:

PermissionDeniedException

FileNotFoundException

IOException

openFile

public byte[] openFile(String path,
 com.sshtools.common.util.UnsignedInteger32 flags,
 Optional<com.sshtools.common.util.UnsignedInteger32> accessFlags,
 SftpFileAttributes attrs)
                throws PermissionDeniedException,
FileNotFoundException,
IOException

Throws:

PermissionDeniedException

FileNotFoundException

IOException

checkOpenFlagsAndFileState

@Deprecated
protected void checkOpenFlagsAndFileState(String path,
 com.sshtools.common.util.UnsignedInteger32 flags,
 AbstractFile f)
                                   throws IOException,
PermissionDeniedException,
FileNotFoundException

Deprecated.

Throws:

IOException

PermissionDeniedException

FileNotFoundException

readFile

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

Throws:

InvalidHandleException

EOFException

IOException

PermissionDeniedException

writeFile

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

Throws:

InvalidHandleException

IOException

PermissionDeniedException

closeFile

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

Throws:

InvalidHandleException

IOException

freeHandle

public void freeHandle(byte[] handle)

closeFile

public void closeFile(String handle)
               throws InvalidHandleException,
IOException

Throws:

InvalidHandleException

IOException

getVolume

public FileVolume getVolume(String path)
                     throws IOException,
PermissionDeniedException

Throws:

IOException

PermissionDeniedException

removeFile

public void removeFile(String path)
                throws PermissionDeniedException,
IOException,
FileNotFoundException

Throws:

PermissionDeniedException

IOException

FileNotFoundException

renameFile

public void renameFile(String oldpath,
 String newpath)
                throws PermissionDeniedException,
FileNotFoundException,
IOException

Throws:

PermissionDeniedException

FileNotFoundException

IOException

copyFile

public void copyFile(String oldpath,
 String newpath,
 boolean overwrite)
              throws PermissionDeniedException,
FileNotFoundException,
FileAlreadyExistsException,
IOException

Throws:

PermissionDeniedException

FileNotFoundException

FileAlreadyExistsException

IOException

getDefaultPath

public String getDefaultPath()
                      throws IOException,
PermissionDeniedException

Throws:

IOException

PermissionDeniedException

removeDirectory

public void removeDirectory(String path)
                     throws PermissionDeniedException,
FileNotFoundException,
IOException

Throws:

PermissionDeniedException

FileNotFoundException

IOException

setFileAttributes

public void setFileAttributes(String path,
 SftpFileAttributes attrs)
                       throws PermissionDeniedException,
IOException,
FileNotFoundException

Throws:

PermissionDeniedException

IOException

FileNotFoundException

setFileAttributes

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

Throws:

PermissionDeniedException

IOException

InvalidHandleException

readSymbolicLink

public SftpFile readSymbolicLink(String link)
                          throws UnsupportedFileOperationException,
FileNotFoundException,
IOException,
PermissionDeniedException

Throws:

UnsupportedFileOperationException

FileNotFoundException

IOException

PermissionDeniedException

createSymbolicLink

public void createSymbolicLink(String link,
 String target)
                        throws UnsupportedFileOperationException,
FileNotFoundException,
IOException,
PermissionDeniedException

Throws:

UnsupportedFileOperationException

FileNotFoundException

IOException

PermissionDeniedException

createLink

public void createLink(String link,
 String target)
                throws UnsupportedFileOperationException,
FileNotFoundException,
IOException,
PermissionDeniedException

Throws:

UnsupportedFileOperationException

FileNotFoundException

IOException

PermissionDeniedException

fileExists

public boolean fileExists(String path)
                   throws IOException,
PermissionDeniedException

Throws:

IOException

PermissionDeniedException

fileExists

public boolean fileExists(String path,
 boolean followLinks)
                   throws IOException,
PermissionDeniedException

Throws:

IOException

PermissionDeniedException

getRealPath

public String getRealPath(String path)
                   throws IOException,
FileNotFoundException,
PermissionDeniedException

Throws:

IOException

FileNotFoundException

PermissionDeniedException

getFileForHandle

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

Throws:

IOException

InvalidHandleException

populateEvent

public void populateEvent(Event evt)

getConnection

public SshConnection getConnection()

getPathForHandle

public String getPathForHandle(byte[] handle)
                        throws IOException,
InvalidHandleException

Throws:

IOException

InvalidHandleException

copyData

public void copyData(byte[] handle,
 com.sshtools.common.util.UnsignedInteger64 offset,
 com.sshtools.common.util.UnsignedInteger64 length,
 byte[] toHandle,
 com.sshtools.common.util.UnsignedInteger64 toOffset)
              throws IOException,
PermissionDeniedException,
InvalidHandleException

Throws:

IOException

PermissionDeniedException

InvalidHandleException

isMultipartTransferSupported

public boolean isMultipartTransferSupported(String path)
                                     throws PermissionDeniedException,
IOException

Throws:

PermissionDeniedException

IOException

startMultipartUpload

public MultipartTransfer startMultipartUpload(AbstractFile targetFile)
                                       throws PermissionDeniedException,
IOException

Throws:

PermissionDeniedException

IOException

openPart

public byte[] openPart(String uuid,
 Multipart part)
                throws IOException,
PermissionDeniedException

Throws:

IOException

PermissionDeniedException