org.apache.hadoop.fs.s3
Class S3FileSystem

java.lang.Object
  extended by org.apache.hadoop.conf.Configured
      extended by org.apache.hadoop.fs.FileSystem
          extended by org.apache.hadoop.fs.s3.S3FileSystem
All Implemented Interfaces:
Configurable

public class S3FileSystem
extends FileSystem

A FileSystem backed by Amazon S3.


Field Summary
 
Fields inherited from class org.apache.hadoop.fs.FileSystem
LOG
 
Constructor Summary
S3FileSystem()
           
S3FileSystem(FileSystemStore store)
           
 
Method Summary
 FSDataOutputStream create(Path file, 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)
          Delete a file
 boolean exists(Path path)
          Check if exists.
 FileStatus getFileStatus(Path f)
          FileStatus for S3 file systems.
 String getName()
           
 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 isFile(Path path)
          True iff the named path is a regular file.
 Path[] listPaths(Path path)
          List files in a directory.
 boolean mkdirs(Path path)
          Make the given file and all non-existent parents into directories.
 FSDataInputStream open(Path path, int bufferSize)
          Opens an FSDataInputStream at the indicated Path.
 boolean rename(Path src, Path dst)
          Renames Path src to Path dst.
 void setWorkingDirectory(Path dir)
          Set the current working directory for the given file system.
 
Methods inherited from class org.apache.hadoop.fs.FileSystem
checkPath, close, closeAll, completeLocalOutput, copyFromLocalFile, copyFromLocalFile, copyToLocalFile, copyToLocalFile, create, create, create, create, create, create, create, createNewFile, get, get, getBlockSize, getContentLength, getDefaultBlockSize, getDefaultReplication, getFileCacheHints, getLength, getLocal, getNamed, getReplication, getUsed, globPaths, globPaths, isDirectory, listPaths, listPaths, listPaths, lock, makeQualified, moveFromLocalFile, moveToLocalFile, open, parseArgs, release, setReplication, startLocalOutput
 
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

S3FileSystem

public S3FileSystem()

S3FileSystem

public S3FileSystem(FileSystemStore store)
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.

Specified by:
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

public String getName()
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

exists

public boolean exists(Path path)
               throws IOException
Description copied from class: FileSystem
Check if exists.

Specified by:
exists in class FileSystem
Parameters:
path - source file
Throws:
IOException

mkdirs

public boolean mkdirs(Path path)
               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

isFile

public boolean isFile(Path path)
               throws IOException
Description copied from class: FileSystem
True iff the named path is a regular file.

Overrides:
isFile in class FileSystem
Throws:
IOException

listPaths

public Path[] listPaths(Path path)
                 throws IOException
Description copied from class: FileSystem
List files in a directory.

Specified by:
listPaths in class FileSystem
Throws:
IOException

create

public FSDataOutputStream create(Path file,
                                 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

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)
               throws IOException
Description copied from class: FileSystem
Delete a file

Specified by:
delete in class FileSystem
Throws:
IOException

getFileStatus

public FileStatus getFileStatus(Path f)
                         throws IOException
FileStatus for S3 file systems.

Specified by:
getFileStatus in class FileSystem
Throws:
IOException


Copyright © 2006 The Apache Software Foundation