Package org.apache.commons.vfs2.provider.sftp

Class SftpFileObject

java.lang.Object

org.apache.commons.vfs2.provider.AbstractFileObject<SftpFileSystem>

org.apache.commons.vfs2.provider.sftp.SftpFileObject

All Implemented Interfaces:

Closeable, AutoCloseable, Comparable<FileObject>, Iterable<FileObject>, FileObject

public class SftpFileObject
extends AbstractFileObject<SftpFileSystem>

An SFTP file.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SftpFileObject(AbstractFileName name, SftpFileSystem fileSystem)

Method Summary

Modifier and Type	Method	Description
protected void	doCreateFolder()	Creates this file as a folder.
protected void	doDelete()	Deletes the file.
protected void	doDetach()	Detaches this file object from its file resource.
protected long	doGetContentSize()	Returns the size of the file content (in bytes).
protected InputStream	doGetInputStream()	Creates an input stream to read the file content from.
protected long	doGetLastModifiedTime()	Returns the last modified time of this file.
protected OutputStream	doGetOutputStream(boolean bAppend)	Creates an output stream to write the file content to.
protected RandomAccessContent	doGetRandomAccessContent(RandomAccessMode mode)	Creates access to the file for random i/o.
protected FileType	doGetType()	Determines the type of this file, returns null if the file does not exist.
protected boolean	doIsExecutable()	Determines if this file is executable.
protected boolean	doIsReadable()	Determines if this file can be read.
protected boolean	doIsWriteable()	Determines if this file can be written to.
protected String[]	doListChildren()	Lists the children of this file.
protected FileObject[]	doListChildrenResolved()	Lists the children of this file.
protected void	doRename(FileObject newFile)	Rename the file.
protected boolean	doSetExecutable(boolean executable, boolean ownerOnly)	Make the file executable.
protected boolean	doSetLastModifiedTime(long modtime)	Sets the last modified time of this file.
protected boolean	doSetReadable(boolean readable, boolean ownerOnly)	Make the file or folder readable.
protected boolean	doSetWritable(boolean writable, boolean ownerOnly)	Make the file or folder writeable.
protected PosixPermissions	getPermissions(boolean checkIds)	Returns the POSIX type permissions of the file.
protected void	onChange()	Called when the type or content of this file changes.
void	refresh()	This will prepare the fileObject to get resynchronized with the underlying filesystem if required.

Methods inherited from class org.apache.commons.vfs2.provider.AbstractFileObject

canRenameTo, childrenChanged, close, compareTo, copyFrom, createFile, createFolder, delete, delete, deleteAll, doAttach, doCreateFileContent, doGetAttributes, doGetCertificates, doIsHidden, doIsSameFile, doRemoveAttribute, doSetAttribute, endOutput, exists, finalize, findFiles, findFiles, getAbstractFileSystem, getChild, getChildren, getContent, getFileContentInfoFactory, getFileOperations, getFileSystem, getInputStream, getName, getOutputStream, getOutputStream, getParent, getPublicURIString, getRandomAccessContent, getType, getURL, handleChanged, handleCreate, handleDelete, holdObject, injectType, isAttached, isContentOpen, isExecutable, isFile, isFolder, isHidden, isReadable, isSameFile, isWriteable, iterator, listFiles, moveTo, notifyAllStreamsClosed, onChildrenChanged, resolveFile, resolveFile, setExecutable, setReadable, setWritable, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

SftpFileObject

protected SftpFileObject(AbstractFileName name,
 SftpFileSystem fileSystem)
                  throws FileSystemException

Throws:

FileSystemException

Method Details

doDetach

protected void doDetach()
                 throws Exception

Description copied from class: AbstractFileObject

Detaches this file object from its file resource.

Called when this file is closed. Note that the file object may be reused later, so should be able to be reattached.

This implementation does nothing.

Overrides:

doDetach in class AbstractFileObject<SftpFileSystem>

Throws:

Exception - if an error occurs.

Since:

2.0

refresh

public void refresh()
             throws FileSystemException

Description copied from class: AbstractFileObject

This will prepare the fileObject to get resynchronized with the underlying filesystem if required.

Specified by:

refresh in interface FileObject

Overrides:

refresh in class AbstractFileObject<SftpFileSystem>

Throws:

FileSystemException - if error occurs.

Since:

2.0

doGetType

protected FileType doGetType()
                      throws Exception

Determines the type of this file, returns null if the file does not exist.

Specified by:

doGetType in class AbstractFileObject<SftpFileSystem>

Returns:

the type of the file.

Throws:

Exception - if an error occurs.

onChange

protected void onChange()
                 throws Exception

Called when the type or content of this file changes.

Overrides:

onChange in class AbstractFileObject<SftpFileSystem>

Throws:

Exception - if an error occurs.

doCreateFolder

protected void doCreateFolder()
                       throws Exception

Creates this file as a folder.

Overrides:

doCreateFolder in class AbstractFileObject<SftpFileSystem>

Throws:

Exception - if an error occurs.

doGetLastModifiedTime

protected long doGetLastModifiedTime()
                              throws Exception

Description copied from class: AbstractFileObject

Returns the last modified time of this file. Is only called if AbstractFileObject.doGetType() does not return FileType.IMAGINARY.

This implementation throws an exception.

Overrides:

doGetLastModifiedTime in class AbstractFileObject<SftpFileSystem>

Returns:

The last modification time.

Throws:

Exception - if an error occurs.

doSetLastModifiedTime

protected boolean doSetLastModifiedTime(long modtime)
                                 throws Exception

Sets the last modified time of this file. Is only called if doGetType() does not return FileType.IMAGINARY.

Overrides:

doSetLastModifiedTime in class AbstractFileObject<SftpFileSystem>

Parameters:

modtime - is modification time in milliseconds. SFTP protocol can send times with nanosecond precision but at the moment jsch send them with second precision.

Returns:

true if the time was set.

Throws:

Exception - Any Exception thrown is wrapped in FileSystemException.

doDelete

protected void doDelete()
                 throws Exception

Deletes the file.

Overrides:

doDelete in class AbstractFileObject<SftpFileSystem>

Throws:

Exception - if an error occurs.

doRename

protected void doRename(FileObject newFile)
                 throws Exception

Rename the file.

Overrides:

doRename in class AbstractFileObject<SftpFileSystem>

Parameters:

newFile - A FileObject with the new file name.

Throws:

Exception - if an error occurs.

getPermissions

protected PosixPermissions getPermissions(boolean checkIds)
                                   throws Exception

Returns the POSIX type permissions of the file.

Parameters:

checkIds - true if user and group ID should be checked (needed for some access rights checks)

Returns:

A PosixPermission object

Throws:

Exception - If an error occurs

Since:

2.1

doIsReadable

protected boolean doIsReadable()
                        throws Exception

Description copied from class: AbstractFileObject

Determines if this file can be read. Is only called if AbstractFileObject.doGetType() does not return FileType.IMAGINARY.

This implementation always returns true.

Overrides:

doIsReadable in class AbstractFileObject<SftpFileSystem>

Returns:

true if the file is readable, false otherwise.

Throws:

Exception - if an error occurs.

doSetReadable

protected boolean doSetReadable(boolean readable,
 boolean ownerOnly)
                         throws Exception

Description copied from class: AbstractFileObject

Make the file or folder readable.

Only called if AbstractFileObject.doGetType() does not return FileType.IMAGINARY.

This implementation returns false.

Overrides:

doSetReadable in class AbstractFileObject<SftpFileSystem>

Parameters:

readable - True to allow access, false to disallow

ownerOnly - If true, the permission applies only to the owner; otherwise, it applies to everybody.

Returns:

true if the operation succeeded

Throws:

Exception - Any Exception thrown is wrapped in FileSystemException.

See Also:

• AbstractFileObject.setReadable(boolean, boolean)

doIsWriteable

protected boolean doIsWriteable()
                         throws Exception

Description copied from class: AbstractFileObject

Determines if this file can be written to. Is only called if AbstractFileObject.doGetType() does not return FileType.IMAGINARY.

This implementation always returns true.

Overrides:

doIsWriteable in class AbstractFileObject<SftpFileSystem>

Returns:

true if the file is writable.

Throws:

Exception - if an error occurs.

doSetWritable

protected boolean doSetWritable(boolean writable,
 boolean ownerOnly)
                         throws Exception

Description copied from class: AbstractFileObject

Make the file or folder writeable.

Only called if AbstractFileObject.doGetType() does not return FileType.IMAGINARY.

Overrides:

doSetWritable in class AbstractFileObject<SftpFileSystem>

Parameters:

writable - True to allow access, false to disallow

ownerOnly - If true, the permission applies only to the owner; otherwise, it applies to everybody.

Returns:

true if the operation succeeded

Throws:

Exception - Any Exception thrown is wrapped in FileSystemException.

See Also:

• AbstractFileObject.setWritable(boolean, boolean)

doIsExecutable

protected boolean doIsExecutable()
                          throws Exception

Description copied from class: AbstractFileObject

Determines if this file is executable. Is only called if AbstractFileObject.doGetType() does not return FileType.IMAGINARY.

This implementation always returns false.

Overrides:

doIsExecutable in class AbstractFileObject<SftpFileSystem>

Returns:

true if the file is executable, false otherwise.

Throws:

Exception - if an error occurs.

doSetExecutable

protected boolean doSetExecutable(boolean executable,
 boolean ownerOnly)
                           throws Exception

Description copied from class: AbstractFileObject

Make the file executable.

Only called if AbstractFileObject.doGetType() does not return FileType.IMAGINARY.

This implementation returns false.

Overrides:

doSetExecutable in class AbstractFileObject<SftpFileSystem>

Parameters:

executable - True to allow access, false to disallow.

ownerOnly - If true, the permission applies only to the owner; otherwise, it applies to everybody.

Returns:

true if the operation succeeded.

Throws:

Exception - Any Exception thrown is wrapped in FileSystemException.

See Also:

• AbstractFileObject.setExecutable(boolean, boolean)

doListChildrenResolved

protected FileObject[] doListChildrenResolved()
                                       throws Exception

Lists the children of this file.

Overrides:

doListChildrenResolved in class AbstractFileObject<SftpFileSystem>

Returns:

The children of this FileObject.

Throws:

Exception - if an error occurs.

doListChildren

protected String[] doListChildren()
                           throws Exception

Lists the children of this file.

Specified by:

doListChildren in class AbstractFileObject<SftpFileSystem>

Returns:

a possible empty String array if the file is a directory or null or an exception if the file is not a directory or can't be read.

Throws:

Exception - if an error occurs.

doGetContentSize

protected long doGetContentSize()
                         throws Exception

Returns the size of the file content (in bytes).

Specified by:

doGetContentSize in class AbstractFileObject<SftpFileSystem>

Returns:

The size of the file in bytes.

Throws:

Exception - if an error occurs.

doGetRandomAccessContent

protected RandomAccessContent doGetRandomAccessContent(RandomAccessMode mode)
                                                throws Exception

Description copied from class: AbstractFileObject

Creates access to the file for random i/o. Is only called if AbstractFileObject.doGetType() returns FileType.FILE.

It is guaranteed that there are no open output streams for this file when this method is called.

Overrides:

doGetRandomAccessContent in class AbstractFileObject<SftpFileSystem>

Parameters:

mode - The mode to access the file.

Returns:

The RandomAccessContext.

Throws:

Exception - if an error occurs.

doGetInputStream

protected InputStream doGetInputStream()
                                throws Exception

Creates an input stream to read the file content from.

Specified by:

doGetInputStream in class AbstractFileObject<SftpFileSystem>

Returns:

An InputStream to read the file content.

Throws:

Exception - if an error occurs.

doGetOutputStream

protected OutputStream doGetOutputStream(boolean bAppend)
                                  throws Exception

Creates an output stream to write the file content to.

Overrides:

doGetOutputStream in class AbstractFileObject<SftpFileSystem>

Parameters:

bAppend - true if the file should be appended to, false if it should be overwritten.

Returns:

An OutputStream to write to the file.

Throws:

Exception - if an error occurs.