public class SftpFileObject extends AbstractFileObject implements FileObject
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 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 |
doSetLastModifiedTime(long modtime)
Sets the last modified time of this 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 underlaying filesystem if required.
|
canRenameTo, childrenChanged, close, copyFrom, createFile, createFolder, delete, delete, doAttach, doCreateFileContent, doGetAttributes, doGetCertificates, doIsHidden, doIsReadable, doIsSameFile, doIsWriteable, doRemoveAttribute, doSetAttribute, endOutput, exists, finalize, findFiles, findFiles, getChild, getChildren, getContent, getFileContentInfoFactory, getFileOperations, getFileSystem, getInputStream, getName, getOutputStream, getOutputStream, getParent, getRandomAccessContent, getType, getURL, handleChanged, handleCreate, handleDelete, holdObject, injectType, isAttached, isContentOpen, isHidden, isReadable, isSameFile, isWriteable, moveTo, notifyAllStreamsClosed, onChildrenChanged, resolveFile, resolveFile, toString
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
canRenameTo, close, copyFrom, createFile, createFolder, delete, delete, exists, findFiles, findFiles, getChild, getChildren, getContent, getFileOperations, getFileSystem, getName, getParent, getType, getURL, isAttached, isContentOpen, isHidden, isReadable, isWriteable, moveTo, resolveFile, resolveFile
protected SftpFileObject(AbstractFileName name, SftpFileSystem fileSystem) throws FileSystemException
FileSystemException
protected void doDetach() throws Exception
AbstractFileObject
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.doDetach
in class AbstractFileObject
Exception
- if an error occurs.public void refresh() throws FileSystemException
AbstractFileObject
refresh
in interface FileObject
refresh
in class AbstractFileObject
FileSystemException
- if an error occurs.protected FileType doGetType() throws Exception
doGetType
in class AbstractFileObject
Exception
- if an error occurs.protected void onChange() throws Exception
onChange
in class AbstractFileObject
Exception
- if an error occurs.protected void doCreateFolder() throws Exception
doCreateFolder
in class AbstractFileObject
Exception
- if an error occurs.protected long doGetLastModifiedTime() throws Exception
AbstractFileObject
AbstractFileObject.doGetType()
does not return FileType.IMAGINARY
.
This implementation throws an exception.doGetLastModifiedTime
in class AbstractFileObject
Exception
- if an error occurs.protected boolean doSetLastModifiedTime(long modtime) throws Exception
doGetType()
does not return FileType.IMAGINARY
. doSetLastModifiedTime
in class AbstractFileObject
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
- if an error occurs.protected void doDelete() throws Exception
doDelete
in class AbstractFileObject
Exception
- if an error occurs.protected void doRename(FileObject newfile) throws Exception
doRename
in class AbstractFileObject
newfile
- A FileObject with the new file name.Exception
- if an error occurs.protected FileObject[] doListChildrenResolved() throws Exception
doListChildrenResolved
in class AbstractFileObject
Exception
- if an error occurs.protected String[] doListChildren() throws Exception
doListChildren
in class AbstractFileObject
Exception
- if an error occurs.protected long doGetContentSize() throws Exception
doGetContentSize
in class AbstractFileObject
Exception
- if an error occurs.protected RandomAccessContent doGetRandomAccessContent(RandomAccessMode mode) throws Exception
AbstractFileObject
AbstractFileObject.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
mode
- The mode to access the file.Exception
- if an error occurs.protected InputStream doGetInputStream() throws Exception
doGetInputStream
in class AbstractFileObject
Exception
- if an error occurs.protected OutputStream doGetOutputStream(boolean bAppend) throws Exception
doGetOutputStream
in class AbstractFileObject
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.