Class SftpFileObject
- All Implemented Interfaces:
Closeable,AutoCloseable,Comparable<FileObject>,Iterable<FileObject>,FileObject
-
Field Summary
Fields inherited from class org.apache.commons.vfs2.provider.AbstractFileObject
DEFAULT_BUFFER_SIZEFields inherited from interface org.apache.commons.vfs2.FileObject
EMPTY_ARRAY -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedSftpFileObject(AbstractFileName fileName, SftpFileSystem fileSystem) Constructs a new instance. -
Method Summary
Modifier and TypeMethodDescriptionprotected voidCreates this file as a folder.protected voiddoDelete()Deletes the file.protected voiddoDetach()Detaches this file object from its file resource.protected longReturns the size of the file content (in bytes).protected InputStreamdoGetInputStream(int bufferSize) Creates an input stream to read the file content from.protected longReturns the last modified time of this file.protected OutputStreamdoGetOutputStream(boolean bAppend) Creates an output stream to write the file content to.protected RandomAccessContentCreates access to the file for random i/o.protected FileTypeDetermines the type of this file, returns null if the file does not exist.protected booleanDetermines if this file is executable.protected booleanDetermines if this file can be read.protected booleanDetermines if this file can be written to.protected String[]Lists the children of this file.protected FileObject[]Lists the children of this file.protected voiddoRename(FileObject newFile) Renames the file.protected booleandoSetExecutable(boolean executable, boolean ownerOnly) Make the file executable.protected booleandoSetLastModifiedTime(long modtime) Sets the last modified time of this file.protected booleandoSetReadable(boolean readable, boolean ownerOnly) Make the file or folder readable.protected booleandoSetWritable(boolean writable, boolean ownerOnly) Make the file or folder writable.protected PosixPermissionsgetPermissions(boolean checkIds) Returns the POSIX type permissions of the file.protected voidonChange()Called when the type or content of this file changes.Methods inherited from class org.apache.commons.vfs2.provider.AbstractFileObject
canRenameTo, childrenChanged, close, compareTo, copyFrom, createFile, createFolder, delete, delete, deleteAll, doAttach, doCreateFileContent, doGetAttributes, doGetCertificates, doGetInputStream, doIsHidden, doIsSameFile, doIsSymbolicLink, doRemoveAttribute, doSetAttribute, endOutput, exists, finalize, findFiles, findFiles, getAbstractFileSystem, getChild, getChildren, getContent, getFileContentInfoFactory, getFileOperations, getFileSystem, getInputStream, getInputStream, getName, getOutputStream, getOutputStream, getParent, getPublicURIString, getRandomAccessContent, getType, getURL, handleChanged, handleCreate, handleDelete, holdObject, injectType, isAttached, isContentOpen, isExecutable, isFile, isFolder, isHidden, isReadable, isSameFile, isSymbolicLink, isWriteable, iterator, listFiles, moveTo, notifyAllStreamsClosed, onChildrenChanged, refresh, resolveFile, resolveFile, setExecutable, setReadable, setWritable, toStringMethods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.commons.vfs2.FileObject
getPath, getURIMethods inherited from interface java.lang.Iterable
forEach, spliterator
-
Constructor Details
-
SftpFileObject
protected SftpFileObject(AbstractFileName fileName, SftpFileSystem fileSystem) throws FileSystemException Constructs a new instance.- Parameters:
fileName- the file name.fileSystem- the file system.- Throws:
FileSystemException- if a file system error occurs.
-
-
Method Details
-
doCreateFolder
Creates this file as a folder.- Overrides:
doCreateFolderin classAbstractFileObject<SftpFileSystem>- Throws:
Exception- if an error occurs.
-
doDelete
Deletes the file.- Overrides:
doDeletein classAbstractFileObject<SftpFileSystem>- Throws:
Exception- if an error occurs.
-
doDetach
Description copied from class:AbstractFileObjectDetaches 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:
doDetachin classAbstractFileObject<SftpFileSystem>- Throws:
Exception- if an error occurs.- Since:
- 2.0
-
doGetContentSize
Returns the size of the file content (in bytes).- Specified by:
doGetContentSizein classAbstractFileObject<SftpFileSystem>- Returns:
- The size of the file in bytes.
- Throws:
Exception- if an error occurs.
-
doGetInputStream
Creates an input stream to read the file content from.- Overrides:
doGetInputStreamin classAbstractFileObject<SftpFileSystem>- Parameters:
bufferSize- Buffer size hint.- Returns:
- An InputStream to read the file content.
- Throws:
Exception- if an error occurs.
-
doGetLastModifiedTime
Description copied from class:AbstractFileObjectReturns the last modified time of this file. Is only called ifAbstractFileObject.doGetType()does not returnThis implementation throws an exception.
- Overrides:
doGetLastModifiedTimein classAbstractFileObject<SftpFileSystem>- Returns:
- The last modification time.
- Throws:
Exception- if an error occurs.
-
doGetOutputStream
Creates an output stream to write the file content to.- Overrides:
doGetOutputStreamin classAbstractFileObject<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.
-
doGetRandomAccessContent
Description copied from class:AbstractFileObjectCreates access to the file for random i/o. Is only called ifAbstractFileObject.doGetType()returnsFileType.FILE.It is guaranteed that there are no open output streams for this file when this method is called.
- Overrides:
doGetRandomAccessContentin classAbstractFileObject<SftpFileSystem>- Parameters:
mode- The mode to access the file.- Returns:
- The RandomAccessContext.
- Throws:
Exception- if an error occurs.
-
doGetType
Determines the type of this file, returns null if the file does not exist.- Specified by:
doGetTypein classAbstractFileObject<SftpFileSystem>- Returns:
- the type of the file.
- Throws:
Exception- if an error occurs.
-
doIsExecutable
Description copied from class:AbstractFileObjectDetermines if this file is executable. Is only called ifAbstractFileObject.doGetType()does not returnFileType.IMAGINARY.This implementation always returns false.
- Overrides:
doIsExecutablein classAbstractFileObject<SftpFileSystem>- Returns:
- true if the file is executable, false otherwise.
- Throws:
Exception- if an error occurs.
-
doIsReadable
Description copied from class:AbstractFileObjectDetermines if this file can be read. Is only called ifAbstractFileObject.doGetType()does not returnFileType.IMAGINARY.This implementation always returns true.
- Overrides:
doIsReadablein classAbstractFileObject<SftpFileSystem>- Returns:
- true if the file is readable, false otherwise.
- Throws:
Exception- if an error occurs.
-
doIsWriteable
Description copied from class:AbstractFileObjectDetermines if this file can be written to. Is only called ifAbstractFileObject.doGetType()does not returnFileType.IMAGINARY.This implementation always returns true.
- Overrides:
doIsWriteablein classAbstractFileObject<SftpFileSystem>- Returns:
- true if the file is writable.
- Throws:
Exception- if an error occurs.
-
doListChildren
Lists the children of this file.- Specified by:
doListChildrenin classAbstractFileObject<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.
-
doListChildrenResolved
Lists the children of this file.- Overrides:
doListChildrenResolvedin classAbstractFileObject<SftpFileSystem>- Returns:
- The children of this FileObject.
- Throws:
Exception- if an error occurs.
-
doRename
Renames the file.- Overrides:
doRenamein classAbstractFileObject<SftpFileSystem>- Parameters:
newFile- A FileObject with the new file name.- Throws:
Exception- if an error occurs.
-
doSetExecutable
Description copied from class:AbstractFileObjectMake the file executable.Only called if
AbstractFileObject.doGetType()does not returnFileType.IMAGINARY.This implementation returns false.
- Overrides:
doSetExecutablein classAbstractFileObject<SftpFileSystem>- Parameters:
executable- True to allow access, false to disallow.ownerOnly- Iftrue, 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:
-
doSetLastModifiedTime
Sets the last modified time of this file. Is only called ifdoGetType()does not returnFileType.IMAGINARY.- Overrides:
doSetLastModifiedTimein classAbstractFileObject<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.
-
doSetReadable
Description copied from class:AbstractFileObjectMake the file or folder readable.Only called if
AbstractFileObject.doGetType()does not returnFileType.IMAGINARY.This implementation returns false.
- Overrides:
doSetReadablein classAbstractFileObject<SftpFileSystem>- Parameters:
readable- True to allow access, false to disallowownerOnly- Iftrue, 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:
-
doSetWritable
Description copied from class:AbstractFileObjectMake the file or folder writable.Only called if
AbstractFileObject.doGetType()does not returnFileType.IMAGINARY.- Overrides:
doSetWritablein classAbstractFileObject<SftpFileSystem>- Parameters:
writable- True to allow access, false to disallowownerOnly- Iftrue, 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:
-
getPermissions
Returns the POSIX type permissions of the file.- Parameters:
checkIds-trueif 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
-
onChange
Called when the type or content of this file changes.- Overrides:
onChangein classAbstractFileObject<SftpFileSystem>- Throws:
Exception- if an error occurs.
-