public class SftpFileObject extends AbstractFileObject<SftpFileSystem>
| Modifier | Constructor and Description |
|---|---|
protected |
SftpFileObject(AbstractFileName name,
SftpFileSystem fileSystem) |
| Modifier and Type | Method and 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.
|
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, toStringprotected SftpFileObject(AbstractFileName name, SftpFileSystem fileSystem) throws FileSystemException
FileSystemExceptionprotected void doDetach()
throws Exception
AbstractFileObjectCalled 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.
doDetach in class AbstractFileObject<SftpFileSystem>Exception - if an error occurs.public void refresh()
throws FileSystemException
AbstractFileObjectrefresh in interface FileObjectrefresh in class AbstractFileObject<SftpFileSystem>FileSystemException - if error occurs.protected FileType doGetType() throws Exception
doGetType in class AbstractFileObject<SftpFileSystem>Exception - if an error occurs.protected void onChange()
throws Exception
onChange in class AbstractFileObject<SftpFileSystem>Exception - if an error occurs.protected void doCreateFolder()
throws Exception
doCreateFolder in class AbstractFileObject<SftpFileSystem>Exception - if an error occurs.protected long doGetLastModifiedTime()
throws Exception
AbstractFileObjectAbstractFileObject.doGetType() does not return FileType.IMAGINARY.
This implementation throws an exception.
doGetLastModifiedTime in class AbstractFileObject<SftpFileSystem>Exception - if an error occurs.protected boolean doSetLastModifiedTime(long modtime)
throws Exception
doGetType() does not return FileType.IMAGINARY.doSetLastModifiedTime in class AbstractFileObject<SftpFileSystem>modtime - is modification time in milliseconds. SFTP protocol can send
times with nanosecond precision but at the moment jsch send
them with second precision.Exception - Any Exception thrown is wrapped in FileSystemException.protected void doDelete()
throws Exception
doDelete in class AbstractFileObject<SftpFileSystem>Exception - if an error occurs.protected void doRename(FileObject newFile) throws Exception
doRename in class AbstractFileObject<SftpFileSystem>newFile - A FileObject with the new file name.Exception - if an error occurs.protected PosixPermissions getPermissions(boolean checkIds) throws Exception
checkIds - true if user and group ID should be checked (needed for some access rights checks)Exception - If an error occursprotected boolean doIsReadable()
throws Exception
AbstractFileObjectAbstractFileObject.doGetType()
does not return FileType.IMAGINARY.
This implementation always returns true.
doIsReadable in class AbstractFileObject<SftpFileSystem>Exception - if an error occurs.protected boolean doSetReadable(boolean readable,
boolean ownerOnly)
throws Exception
AbstractFileObject
Only called if AbstractFileObject.doGetType() does not return FileType.IMAGINARY.
This implementation returns false.
doSetReadable in class AbstractFileObject<SftpFileSystem>readable - True to allow access, false to disallowownerOnly - If true, the permission applies only to the owner; otherwise, it applies to everybody.Exception - Any Exception thrown is wrapped in FileSystemException.AbstractFileObject.setReadable(boolean, boolean)protected boolean doIsWriteable()
throws Exception
AbstractFileObjectAbstractFileObject.doGetType() does not return FileType.IMAGINARY.
This implementation always returns true.
doIsWriteable in class AbstractFileObject<SftpFileSystem>Exception - if an error occurs.protected boolean doSetWritable(boolean writable,
boolean ownerOnly)
throws Exception
AbstractFileObject
Only called if AbstractFileObject.doGetType() does not return FileType.IMAGINARY.
doSetWritable in class AbstractFileObject<SftpFileSystem>writable - True to allow access, false to disallowownerOnly - If true, the permission applies only to the owner; otherwise, it applies to everybody.Exception - Any Exception thrown is wrapped in FileSystemException.AbstractFileObject.setWritable(boolean, boolean)protected boolean doIsExecutable()
throws Exception
AbstractFileObjectAbstractFileObject.doGetType()
does not return FileType.IMAGINARY.
This implementation always returns false.
doIsExecutable in class AbstractFileObject<SftpFileSystem>Exception - if an error occurs.protected boolean doSetExecutable(boolean executable,
boolean ownerOnly)
throws Exception
AbstractFileObject
Only called if AbstractFileObject.doGetType() does not return FileType.IMAGINARY.
This implementation returns false.
doSetExecutable in class AbstractFileObject<SftpFileSystem>executable - True to allow access, false to disallow.ownerOnly - If true, the permission applies only to the owner; otherwise, it applies to everybody.Exception - Any Exception thrown is wrapped in FileSystemException.AbstractFileObject.setExecutable(boolean, boolean)protected FileObject[] doListChildrenResolved() throws Exception
doListChildrenResolved in class AbstractFileObject<SftpFileSystem>Exception - if an error occurs.protected String[] doListChildren() throws Exception
doListChildren in class AbstractFileObject<SftpFileSystem>Exception - if an error occurs.protected long doGetContentSize()
throws Exception
doGetContentSize in class AbstractFileObject<SftpFileSystem>Exception - if an error occurs.protected RandomAccessContent doGetRandomAccessContent(RandomAccessMode mode) throws Exception
AbstractFileObjectAbstractFileObject.doGetType() returns FileType.FILE.
It is guaranteed that there are no open output streams for this file when this method is called.
doGetRandomAccessContent in class AbstractFileObject<SftpFileSystem>mode - The mode to access the file.Exception - if an error occurs.protected InputStream doGetInputStream() throws Exception
doGetInputStream in class AbstractFileObject<SftpFileSystem>Exception - if an error occurs.protected OutputStream doGetOutputStream(boolean bAppend) throws Exception
doGetOutputStream in class AbstractFileObject<SftpFileSystem>bAppend - true if the file should be appended to, false if it should be overwritten.Exception - if an error occurs.Copyright © 2002–2016 The Apache Software Foundation. All rights reserved.