SftpFileObject (commons-vfs API)

java.lang.Object
- org.apache.commons.vfs2.provider.AbstractFileObject
- - org.apache.commons.vfs2.provider.sftp.SftpFileObject

All Implemented Interfaces:: FileObject

public class SftpFileObject
extends AbstractFileObject
implements FileObject

An SFTP file.

Author:: Commons VFS team 2005) $

Constructor Summary

Constructors
Modifier Constructor and Description

protected SftpFileObject(AbstractFileName name, SftpFileSystem fileSystem)

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

Method Summary

All Methods Instance Methods Concrete Methods
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 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 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.

Methods inherited from class org.apache.commons.vfs2.provider.AbstractFileObject
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

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.commons.vfs2.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, resolveFile, resolveFile

- Constructor Detail
  - SftpFileObject
```
protected SftpFileObject(AbstractFileName name,
                         SftpFileSystem fileSystem)
                  throws FileSystemException
```
    Throws:
    
    FileSystemException
- Method Detail
  - doDetach
```
protected void doDetach()
                 throws java.lang.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
    
    Throws:
    
    java.lang.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 underlaying filesystem if required.
    
    Specified by:
    
    refresh in interface FileObject
    
    Overrides:
    
    refresh in class AbstractFileObject
    
    Throws:
    
    FileSystemException - if an error occurs.
    
    Since:
    
    2.0
  - 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 class AbstractFileObject
    
    Returns:
    
    the type of the file.
    
    Throws:
    
    java.lang.Exception - if an error occurs.
  - onChange
```
protected void onChange()
                 throws java.lang.Exception
```
    Called when the type or content of this file changes.
    
    Overrides:
    
    onChange in class AbstractFileObject
    
    Throws:
    
    java.lang.Exception - if an error occurs.
  - doCreateFolder
```
protected void doCreateFolder()
                       throws java.lang.Exception
```
    Creates this file as a folder.
    
    Overrides:
    
    doCreateFolder in class AbstractFileObject
    
    Throws:
    
    java.lang.Exception - if an error occurs.
  - doGetLastModifiedTime
```
protected long doGetLastModifiedTime()
                              throws java.lang.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
    
    Returns:
    
    The last modification time.
    
    Throws:
    
    java.lang.Exception - if an error occurs.
  - doSetLastModifiedTime
```
protected boolean doSetLastModifiedTime(long modtime)
                                 throws java.lang.Exception
```
    Sets the last modified time of this file. Is only called if doGetType() does not return FileType.IMAGINARY.
    
    Overrides:
    
    doSetLastModifiedTime in class AbstractFileObject
    
    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:
    
    java.lang.Exception - if an error occurs.
  - doDelete
```
protected void doDelete()
                 throws java.lang.Exception
```
    Deletes the file.
    
    Overrides:
    
    doDelete in class AbstractFileObject
    
    Throws:
    
    java.lang.Exception - if an error occurs.
  - doRename
```
protected void doRename(FileObject newfile)
                 throws java.lang.Exception
```
    Rename the file.
    
    Overrides:
    
    doRename in class AbstractFileObject
    
    Parameters:
    
    newfile - A FileObject with the new file name.
    
    Throws:
    
    java.lang.Exception - if an error occurs.
  - doListChildrenResolved
```
protected FileObject[] doListChildrenResolved()
                                       throws java.lang.Exception
```
    Lists the children of this file.
    
    Overrides:
    
    doListChildrenResolved in class AbstractFileObject
    
    Returns:
    
    The children of this FileObject.
    
    Throws:
    
    java.lang.Exception - if an error occurs.
  - doListChildren
```
protected java.lang.String[] doListChildren()
                                     throws java.lang.Exception
```
    Lists the children of this file.
    
    Specified by:
    
    doListChildren in class AbstractFileObject
    
    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:
    
    java.lang.Exception - if an error occurs.
  - doGetContentSize
```
protected long doGetContentSize()
                         throws java.lang.Exception
```
    Returns the size of the file content (in bytes).
    
    Specified by:
    
    doGetContentSize in class AbstractFileObject
    
    Returns:
    
    The size of the file in bytes.
    
    Throws:
    
    java.lang.Exception - if an error occurs.
  - 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 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
    
    Parameters:
    
    mode - The mode to access the file.
    
    Returns:
    
    The RandomAccessContext.
    
    Throws:
    
    java.lang.Exception - if an error occurs.
  - doGetInputStream
```
protected java.io.InputStream doGetInputStream()
                                        throws java.lang.Exception
```
    Creates an input stream to read the file content from.
    
    Specified by:
    
    doGetInputStream in class AbstractFileObject
    
    Returns:
    
    An InputStream to read the file content.
    
    Throws:
    
    java.lang.Exception - if an error occurs.
  - 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 class AbstractFileObject
    
    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:
    
    java.lang.Exception - if an error occurs.

Class SftpFileObject

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.commons.vfs2.FileObject

Constructor Detail

SftpFileObject

Method Detail

doDetach

refresh

doGetType

onChange

doCreateFolder

doGetLastModifiedTime

doSetLastModifiedTime

doDelete

doRename

doListChildrenResolved

doListChildren

doGetContentSize

doGetRandomAccessContent

doGetInputStream

doGetOutputStream