## org.apache.hadoop.fs.kfs
Class KosmosFileSystem

    java.lang.Object
      org.apache.hadoop.conf.Configured
          org.apache.hadoop.fs.FileSystem
              org.apache.hadoop.fs.kfs.KosmosFileSystem

All Implemented Interfaces:
  Closeable, Configurable

    public class KosmosFileSystem

extends FileSystem

A FileSystem backed by KFS.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.fs.FileSystem
`FileSystem.Statistics`

Field Summary

Fields inherited from class org.apache.hadoop.fs.FileSystem
`FS_DEFAULT_NAME_KEY, LOG, statistics`

Constructor Summary
`KosmosFileSystem()`

Method Summary
`FSDataOutputStream` `append(Path f, int bufferSize, Progressable progress)` This optional operation is not yet supported.
`void` `completeLocalOutput(Path fsOutputFile, Path tmpLocalFile)` Called when we're all done writing to the target.
`void` `copyFromLocalFile(boolean delSrc, Path src, Path dst)` The src file is on the local disk.
`void` `copyToLocalFile(boolean delSrc, Path src, Path dst)` The src file is under FS, and the dst is on the local disk.
`FSDataOutputStream` `create(Path file, FsPermission permission, boolean overwrite, int bufferSize, short replication, long blockSize, Progressable progress)` Opens an FSDataOutputStream at the indicated Path with write-progress reporting.
`boolean` `delete(Path path)` Deprecated.
`boolean` `delete(Path path, boolean recursive)` Delete a file.
`long` `getDefaultBlockSize()` Return the number of bytes that large input files should be optimally be split into to minimize i/o time.
`short` `getDefaultReplication()` Get the default replication.
`BlockLocation[]` `getFileBlockLocations(FileStatus file, long start, long len)` Return null if the file doesn't exist; otherwise, get the locations of the various chunks of the file file from KFS.
`FileStatus` `getFileStatus(Path path)` Return a file status object that represents the path.
`long` `getLength(Path path)` Deprecated.
`String` `getName()` Deprecated.
`short` `getReplication(Path path)` Deprecated.
`URI` `getUri()` Returns a URI whose scheme and authority identify this FileSystem.
`Path` `getWorkingDirectory()` Get the current working directory for the given file system
`void` `initialize(URI uri, Configuration conf)` Called after a new FileSystem instance is constructed.
`boolean` `isDirectory(Path path)` Deprecated.
`boolean` `isFile(Path path)` Deprecated.
`FileStatus[]` `listStatus(Path path)` List the statuses of the files/directories in the given path if the path is a directory.
`void` `lock(Path path, boolean shared)` Deprecated.
`boolean` `mkdirs(Path path, FsPermission permission)` Make the given file and all non-existent parents into directories.
`FSDataInputStream` `open(Path path, int bufferSize)` Opens an FSDataInputStream at the indicated Path.
`void` `release(Path path)` Deprecated.
`boolean` `rename(Path src, Path dst)` Renames Path src to Path dst.
`boolean` `setReplication(Path path, short replication)` Set replication for an existing file.
`void` `setWorkingDirectory(Path dir)` Set the current working directory for the given file system.
`Path` `startLocalOutput(Path fsOutputFile, Path tmpLocalFile)` Returns a local File that the user can write output to.

Methods inherited from class org.apache.hadoop.fs.FileSystem

`addFileSystemForTesting, append, append, checkPath, clearStatistics, close, closeAll, closeAllForUGI, copyFromLocalFile, copyFromLocalFile, copyFromLocalFile, copyToLocalFile, create, create, create, create, create, create, create, create, create, create, createNewFile, createNonRecursive, createNonRecursive, deleteOnExit, exists, get, get, get, getAllStatistics, getBlockSize, getCanonicalServiceName, getCanonicalUri, getContentSummary, getDefaultPort, getDefaultUri, getDelegationToken, getFileChecksum, getHomeDirectory, getLocal, getNamed, getStatistics, getStatistics, getUsed, globStatus, globStatus, listStatus, listStatus, listStatus, makeQualified, mkdirs, mkdirs, moveFromLocalFile, moveFromLocalFile, moveToLocalFile, open, printStatistics, processDeleteOnExit, setDefaultUri, setDefaultUri, setOwner, setPermission, setTimes, setVerifyChecksum`

Methods inherited from class org.apache.hadoop.conf.Configured
`getConf, setConf`

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

Constructor Detail

### KosmosFileSystem

    public KosmosFileSystem()

Method Detail

### getUri

    public URI getUri()

  Description copied from class: `FileSystem`
  Returns a URI whose scheme and authority identify this FileSystem.

  Specified by:
    `getUri` in class `FileSystem`

### initialize

    public void initialize(URI uri,
                           Configuration conf)
                    throws IOException

  Description copied from class: `FileSystem`
  Called after a new FileSystem instance is constructed.

  Overrides:
    `initialize` in class `FileSystem`
  Parameters:
    `uri` - a uri whose authority section names the host, port, etc. for this FileSystem
    `conf` - the configuration
  Throws:
    `IOException`

### getName

    @Deprecated
    public String getName()

  Deprecated.

  Overrides:
    `getName` in class `FileSystem`

### getWorkingDirectory

    public Path getWorkingDirectory()

  Description copied from class: `FileSystem`
  Get the current working directory for the given file system

  Specified by:
    `getWorkingDirectory` in class `FileSystem`
  Returns:
    the directory pathname

### setWorkingDirectory

    public void setWorkingDirectory(Path dir)

  Description copied from class: `FileSystem`
  Set the current working directory for the given file system. All relative paths will be resolved relative to it.

  Specified by:
    `setWorkingDirectory` in class `FileSystem`

### mkdirs

    public boolean mkdirs(Path path,
                          FsPermission permission)
                   throws IOException

  Description copied from class: `FileSystem`
  Make the given file and all non-existent parents into directories. Has the semantics of Unix 'mkdir -p'. Existence of the directory hierarchy is not an error.

  Specified by:
    `mkdirs` in class `FileSystem`
  Throws:
    `IOException`

### isDirectory

    @Deprecated
    public boolean isDirectory(Path path)
                        throws IOException

  Deprecated.

  Overrides:
    `isDirectory` in class `FileSystem`
  Throws:
    `IOException`

### isFile

    @Deprecated
    public boolean isFile(Path path)
                   throws IOException

  Deprecated.

  Description copied from class: `FileSystem`
  True iff the named path is a regular file.

  Overrides:
    `isFile` in class `FileSystem`
  Throws:
    `IOException`

### listStatus

    public FileStatus[] listStatus(Path path)
                            throws IOException

  Description copied from class: `FileSystem`
  List the statuses of the files/directories in the given path if the path is a directory.

  Specified by:
    `listStatus` in class `FileSystem`
  Parameters:
    `path` - given path
  Returns:
    the statuses of the files/directories in the given patch returns null, if Path f does not exist in the FileSystem
  Throws:
    `IOException`

### getFileStatus

    public FileStatus getFileStatus(Path path)
                             throws IOException

  Description copied from class: `FileSystem`
  Return a file status object that represents the path.

  Specified by:
    `getFileStatus` in class `FileSystem`
  Parameters:
    `path` - The path we want information from
  Returns:
    a FileStatus object
  Throws:
    `FileNotFoundException` - when the path does not exist; IOException see specific implementation
    `IOException`

### append

    public FSDataOutputStream append(Path f,
                                     int bufferSize,
                                     Progressable progress)
                              throws IOException

  This optional operation is not yet supported.

  Specified by:
    `append` in class `FileSystem`
  Parameters:
    `f` - the existing file to be appended.
    `bufferSize` - the size of the buffer to be used.
    `progress` - for reporting progress if it is not null.
  Throws:
    `IOException`

### create

    public FSDataOutputStream create(Path file,
                                     FsPermission permission,
                                     boolean overwrite,
                                     int bufferSize,
                                     short replication,
                                     long blockSize,
                                     Progressable progress)
                              throws IOException

  Description copied from class: `FileSystem`
  Opens an FSDataOutputStream at the indicated Path with write-progress reporting.

  Specified by:
    `create` in class `FileSystem`
  Parameters:
    `file` - the file name to open
    `overwrite` - if a file with this name already exists, then if true, the file will be overwritten, and if false an error will be thrown.
    `bufferSize` - the size of the buffer to be used.
    `replication` - required block replication for the file.
  Throws:
    `IOException`
  See Also:
    `FileSystem.setPermission(Path, FsPermission)`

### open

    public FSDataInputStream open(Path path,
                                  int bufferSize)
                           throws IOException

  Description copied from class: `FileSystem`
  Opens an FSDataInputStream at the indicated Path.

  Specified by:
    `open` in class `FileSystem`
  Parameters:
    `path` - the file name to open
    `bufferSize` - the size of the buffer to be used.
  Throws:
    `IOException`

### rename

    public boolean rename(Path src,
                          Path dst)
                   throws IOException

  Description copied from class: `FileSystem`
  Renames Path src to Path dst. Can take place on local fs or remote DFS.

  Specified by:
    `rename` in class `FileSystem`
  Throws:
    `IOException`

### delete

    public boolean delete(Path path,
                          boolean recursive)
                   throws IOException

  Description copied from class: `FileSystem`
  Delete a file.

  Specified by:
    `delete` in class `FileSystem`
  Parameters:
    `path` - the path to delete.
    `recursive` - if path is a directory and set to true, the directory is deleted else throws an exception. In case of a file the recursive can be set to either true or false.
  Returns:
    true if delete is successful else false.
  Throws:
    `IOException`

### delete

    @Deprecated
    public boolean delete(Path path)
                   throws IOException

  Deprecated.

  Specified by:
    `delete` in class `FileSystem`
  Throws:
    `IOException`

### getLength

    @Deprecated
    public long getLength(Path path)
                   throws IOException

  Deprecated.

  Overrides:
    `getLength` in class `FileSystem`
  Throws:
    `IOException`

### getReplication

    @Deprecated
    public short getReplication(Path path)
                         throws IOException

  Deprecated.

  Description copied from class: `FileSystem`
  Get replication.

  Overrides:
    `getReplication` in class `FileSystem`
  Parameters:
    `path` - file name
  Returns:
    file replication
  Throws:
    `IOException`

### getDefaultReplication

    public short getDefaultReplication()

  Description copied from class: `FileSystem`
  Get the default replication.

  Overrides:
    `getDefaultReplication` in class `FileSystem`

### setReplication

    public boolean setReplication(Path path,
                                  short replication)
                           throws IOException

  Description copied from class: `FileSystem`
  Set replication for an existing file.

  Overrides:
    `setReplication` in class `FileSystem`
  Parameters:
    `path` - file name
    `replication` - new replication
  Returns:
    true if successful; false if file does not exist or is a directory
  Throws:
    `IOException`

### getDefaultBlockSize

    public long getDefaultBlockSize()

  Description copied from class: `FileSystem`
  Return the number of bytes that large input files should be optimally be split into to minimize i/o time.

  Overrides:
    `getDefaultBlockSize` in class `FileSystem`

### lock

    @Deprecated
    public void lock(Path path,
                                boolean shared)
              throws IOException

  Deprecated.

  Throws:
    `IOException`

### release

    @Deprecated
    public void release(Path path)
                 throws IOException

  Deprecated.

  Throws:
    `IOException`

### getFileBlockLocations

    public BlockLocation[] getFileBlockLocations(FileStatus file,
                                                 long start,
                                                 long len)
                                          throws IOException

  Return null if the file doesn't exist; otherwise, get the locations of the various chunks of the file file from KFS.

  Overrides:
    `getFileBlockLocations` in class `FileSystem`
  Throws:
    `IOException`

### copyFromLocalFile

    public void copyFromLocalFile(boolean delSrc,
                                  Path src,
                                  Path dst)
                           throws IOException

  Description copied from class: `FileSystem`
  The src file is on the local disk. Add it to FS at the given dst name. delSrc indicates if the source should be removed

  Overrides:
    `copyFromLocalFile` in class `FileSystem`
  Throws:
    `IOException`

### copyToLocalFile

    public void copyToLocalFile(boolean delSrc,
                                Path src,
                                Path dst)
                         throws IOException

  Description copied from class: `FileSystem`
  The src file is under FS, and the dst is on the local disk. Copy it from FS control to the local dst name. delSrc indicates if the src will be removed or not.

  Overrides:
    `copyToLocalFile` in class `FileSystem`
  Throws:
    `IOException`

### startLocalOutput

    public Path startLocalOutput(Path fsOutputFile,
                                 Path tmpLocalFile)
                          throws IOException

  Description copied from class: `FileSystem`
  Returns a local File that the user can write output to. The caller provides both the eventual FS target name and the local working file. If the FS is local, we write directly into the target. If the FS is remote, we write into the tmp local area.

  Overrides:
    `startLocalOutput` in class `FileSystem`
  Throws:
    `IOException`

### completeLocalOutput

    public void completeLocalOutput(Path fsOutputFile,
                                    Path tmpLocalFile)
                             throws IOException

  Description copied from class: `FileSystem`
  Called when we're all done writing to the target. A local FS will do nothing, because we've written to exactly the right place. A remote FS will copy the contents of tmpLocalFile to the correct target at fsOutputFile.

  Overrides:
    `completeLocalOutput` in class `FileSystem`
  Throws:
    `IOException`

Copyright © 2009 The Apache Software Foundation