Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.commons.vfs.provider.sftp
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
`protected` | `SftpFileObject(FileName name, SftpFileSystem fileSystem)`

Method Summary
`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 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 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

Method Detail

### doGetType

    protected FileType doGetType()
                          throws Exception

  Determines the type of this file, returns null if the file does not exist.

  Specified by:
    `doGetType` in class `AbstractFileObject`
  Throws:
    `Exception`

### onChange

    protected void onChange()
                     throws Exception

  Called when the type or content of this file changes.

  Overrides:
    `onChange` in class `AbstractFileObject`
  Throws:
    `Exception`

### doCreateFolder

    protected void doCreateFolder()
                           throws Exception

  Creates this file as a folder.

  Overrides:
    `doCreateFolder` in class `AbstractFileObject`
  Throws:
    `Exception`

### doGetLastModifiedTime

    protected long doGetLastModifiedTime()
                                  throws 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`
  Throws:
    `Exception`

### doSetLastModifiedTime

    protected void doSetLastModifiedTime(long modtime)
                                  throws 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.
  Throws:
    `Exception`

### doDelete

    protected void doDelete()
                     throws Exception

  Deletes the file.

  Overrides:
    `doDelete` in class `AbstractFileObject`
  Throws:
    `Exception`

### doRename

    protected void doRename(FileObject newfile)
                     throws Exception

  Rename the file.

  Overrides:
    `doRename` in class `AbstractFileObject`
  Throws:
    `Exception`

### doListChildrenResolved

    protected FileObject[] doListChildrenResolved()
                                           throws Exception

  Lists the children of this file.

  Overrides:
    `doListChildrenResolved` in class `AbstractFileObject`
  Throws:
    `Exception`

### doListChildren

    protected String[] doListChildren()
                               throws Exception

  Lists the children of this file.

  Specified by:
    `doListChildren` in class `AbstractFileObject`
  Throws:
    `Exception`

### doGetContentSize

    protected long doGetContentSize()
                             throws Exception

  Returns the size of the file content (in bytes).

  Specified by:
    `doGetContentSize` in class `AbstractFileObject`
  Throws:
    `Exception`

### doGetRandomAccessContent

    protected RandomAccessContent doGetRandomAccessContent(RandomAccessMode mode)
                                                    throws 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`
  Throws:
    `Exception`

### doGetInputStream

    protected InputStream doGetInputStream()
                                    throws Exception

  Creates an input stream to read the file content from.

  Specified by:
    `doGetInputStream` in class `AbstractFileObject`
  Throws:
    `Exception`

### doGetOutputStream

    protected OutputStream doGetOutputStream(boolean bAppend)
                                      throws Exception

  Creates an output stream to write the file content to.

  Overrides:
    `doGetOutputStream` in class `AbstractFileObject`
  Throws:
    `Exception`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2002-2006 The Apache Software Foundation. All Rights Reserved.