Class SftpFileObject
- java.lang.Object
-
- org.apache.commons.vfs.provider.AbstractFileObject
-
- org.apache.commons.vfs.provider.sftp.SftpFileObject
-
- All Implemented Interfaces:
FileObject
public class SftpFileObject extends AbstractFileObject implements FileObject
An SFTP file.- Version:
- $Revision: 480428 $ $Date: 2005-10-14 19:59:47 +0200 (Fr, 14 Okt 2005) $
- Author:
- Adam Murdoch
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
SftpFileObject(FileName name, SftpFileSystem fileSystem)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
doCreateFolder()
Creates this file as a folder.protected void
doDelete()
Deletes the file.protected long
doGetContentSize()
Returns the size of the file content (in bytes).protected java.io.InputStream
doGetInputStream()
Creates an input stream to read the file content from.protected long
doGetLastModifiedTime()
Returns the last modified time of this file.protected java.io.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 java.lang.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 void
doSetLastModifiedTime(long modtime)
Sets the last modified time of this file.protected void
onChange()
Called when the type or content of this file changes.-
Methods inherited from class org.apache.commons.vfs.provider.AbstractFileObject
canRenameTo, childrenChanged, childrenChanged, close, copyFrom, createFile, createFolder, delete, delete, doAttach, doDetach, doGetAttributes, doGetCertificates, doIsHidden, doIsReadable, doIsSameFile, doIsWriteable, 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, refresh, resolveFile, resolveFile, toString
-
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.commons.vfs.FileObject
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, refresh, resolveFile, resolveFile
-
-
-
-
Constructor Detail
-
SftpFileObject
protected SftpFileObject(FileName name, SftpFileSystem fileSystem) throws FileSystemException
- Throws:
FileSystemException
-
-
Method Detail
-
doGetType
protected FileType doGetType() throws java.lang.Exception
Determines the type of this file, returns null if the file does not exist.- Specified by:
doGetType
in classAbstractFileObject
- Throws:
java.lang.Exception
-
onChange
protected void onChange() throws java.lang.Exception
Called when the type or content of this file changes.- Overrides:
onChange
in classAbstractFileObject
- Throws:
java.lang.Exception
-
doCreateFolder
protected void doCreateFolder() throws java.lang.Exception
Creates this file as a folder.- Overrides:
doCreateFolder
in classAbstractFileObject
- Throws:
java.lang.Exception
-
doGetLastModifiedTime
protected long doGetLastModifiedTime() throws java.lang.Exception
Description copied from class:AbstractFileObject
Returns the last modified time of this file. Is only called ifAbstractFileObject.doGetType()
does not returnFileType.IMAGINARY
. This implementation throws an exception.- Overrides:
doGetLastModifiedTime
in classAbstractFileObject
- Throws:
java.lang.Exception
-
doSetLastModifiedTime
protected void doSetLastModifiedTime(long modtime) throws java.lang.Exception
Sets the last modified time of this file. Is only called ifdoGetType()
does not returnFileType.IMAGINARY
.- Overrides:
doSetLastModifiedTime
in classAbstractFileObject
- 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.- Throws:
java.lang.Exception
-
doDelete
protected void doDelete() throws java.lang.Exception
Deletes the file.- Overrides:
doDelete
in classAbstractFileObject
- Throws:
java.lang.Exception
-
doRename
protected void doRename(FileObject newfile) throws java.lang.Exception
Rename the file.- Overrides:
doRename
in classAbstractFileObject
- Throws:
java.lang.Exception
-
doListChildrenResolved
protected FileObject[] doListChildrenResolved() throws java.lang.Exception
Lists the children of this file.- Overrides:
doListChildrenResolved
in classAbstractFileObject
- Throws:
java.lang.Exception
-
doListChildren
protected java.lang.String[] doListChildren() throws java.lang.Exception
Lists the children of this file.- Specified by:
doListChildren
in classAbstractFileObject
- Throws:
java.lang.Exception
-
doGetContentSize
protected long doGetContentSize() throws java.lang.Exception
Returns the size of the file content (in bytes).- Specified by:
doGetContentSize
in classAbstractFileObject
- Throws:
java.lang.Exception
-
doGetRandomAccessContent
protected RandomAccessContent doGetRandomAccessContent(RandomAccessMode mode) throws java.lang.Exception
Description copied from class:AbstractFileObject
Creates 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:
doGetRandomAccessContent
in classAbstractFileObject
- Throws:
java.lang.Exception
-
doGetInputStream
protected java.io.InputStream doGetInputStream() throws java.lang.Exception
Creates an input stream to read the file content from.- Specified by:
doGetInputStream
in classAbstractFileObject
- Throws:
java.lang.Exception
-
doGetOutputStream
protected java.io.OutputStream doGetOutputStream(boolean bAppend) throws java.lang.Exception
Creates an output stream to write the file content to.- Overrides:
doGetOutputStream
in classAbstractFileObject
- Throws:
java.lang.Exception
-
-