org.apache.hadoop.fs.s3

Class S3FileSystem

java.lang.Object

org.apache.hadoop.conf.Configured

org.apache.hadoop.fs.FileSystem

org.apache.hadoop.fs.s3.S3FileSystem

All Implemented Interfaces:

Closeable, AutoCloseable, Configurable

Deprecated.

Use NativeS3FileSystem and S3AFileSystem instead.

@InterfaceAudience.Public
@InterfaceStability.Stable
@Deprecated
public class S3FileSystem
extends FileSystem

A block-based FileSystem backed by Amazon S3.

See Also:

NativeS3FileSystem

Field Summary

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

DEFAULT_FS, FS_DEFAULT_NAME_KEY, SHUTDOWN_HOOK_PRIORITY, statistics, TRASH_PREFIX, USER_HOME_PREFIX

Constructor Summary

Constructors

Constructor and Description
S3FileSystem() Deprecated.
S3FileSystem(org.apache.hadoop.fs.s3.FileSystemStore store) Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
FSDataOutputStream	append(Path f, int bufferSize, Progressable progress) Deprecated. This optional operation is not yet supported.
protected URI	canonicalizeUri(URI rawUri) Deprecated. Canonicalize the given URI.
protected void	checkPath(Path path) Deprecated. Check that a Path belongs to this FileSystem.
FSDataOutputStream	create(Path file, FsPermission permission, boolean overwrite, int bufferSize, short replication, long blockSize, Progressable progress) Deprecated. Create an FSDataOutputStream at the indicated Path with write-progress reporting.
boolean	delete(Path path, boolean recursive) Deprecated. Delete a file.
String	getCanonicalServiceName() Deprecated. Get a canonical service name for this FileSystem.
long	getDefaultBlockSize() Deprecated. Return the number of bytes that large input files should be optimally be split into to minimize I/O time.
FileStatus	getFileStatus(Path f) Deprecated. FileStatus for S3 file systems.
String	getScheme() Deprecated. Return the protocol scheme for the FileSystem.
URI	getUri() Deprecated. Returns a URI which identifies this FileSystem.
Path	getWorkingDirectory() Deprecated. Get the current working directory for the given FileSystem
void	initialize(URI uri, Configuration conf) Deprecated. Initialize a FileSystem.
boolean	isFile(Path path) Deprecated. True iff the named path is a regular file.
FileStatus[]	listStatus(Path f) Deprecated. List the statuses of the files/directories in the given path if the path is a directory.
boolean	mkdirs(Path path, FsPermission permission) Deprecated. Make the given file and all non-existent parents into directories.
FSDataInputStream	open(Path path, int bufferSize) Deprecated. Opens an FSDataInputStream at the indicated Path.
boolean	rename(Path src, Path dst) Deprecated. Renames Path src to Path dst.
void	setWorkingDirectory(Path dir) Deprecated. Set the current working directory for the given FileSystem.

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

addDelegationTokens, append, append, appendFile, areSymlinksEnabled, cancelDeleteOnExit, clearStatistics, close, closeAll, closeAllForUGI, completeLocalOutput, concat, copyFromLocalFile, copyFromLocalFile, copyFromLocalFile, copyFromLocalFile, copyToLocalFile, copyToLocalFile, copyToLocalFile, create, create, create, create, create, create, create, create, create, create, create, create, createFile, createNewFile, createNonRecursive, createNonRecursive, createNonRecursive, createSnapshot, createSnapshot, createSymlink, delete, deleteOnExit, deleteSnapshot, enableSymlinks, exists, fixRelativePart, get, get, get, getAclStatus, getAllStatistics, getAllStoragePolicies, getBlockSize, getCanonicalUri, getContentSummary, getDefaultBlockSize, getDefaultPort, getDefaultReplication, getDefaultReplication, getDefaultUri, getFileBlockLocations, getFileBlockLocations, getFileChecksum, getFileChecksum, getFileLinkStatus, getFileSystemClass, getFSofPath, getGlobalStorageStatistics, getHomeDirectory, getInitialWorkingDirectory, getLength, getLinkTarget, getLocal, getName, getNamed, getQuotaUsage, getReplication, getServerDefaults, getServerDefaults, getStatistics, getStatistics, getStatus, getStatus, getStoragePolicy, getStorageStatistics, getTrashRoot, getTrashRoots, getUsed, getUsed, getXAttr, getXAttrs, getXAttrs, globStatus, globStatus, isDirectory, listCorruptFileBlocks, listFiles, listLocatedStatus, listLocatedStatus, listStatus, listStatus, listStatus, listStatusIterator, listXAttrs, makeQualified, mkdirs, mkdirs, modifyAclEntries, moveFromLocalFile, moveFromLocalFile, moveToLocalFile, msync, newInstance, newInstance, newInstance, newInstanceLocal, open, primitiveCreate, primitiveMkdir, primitiveMkdir, printStatistics, processDeleteOnExit, removeAcl, removeAclEntries, removeDefaultAcl, removeXAttr, rename, renameSnapshot, resolveLink, resolvePath, setAcl, setDefaultUri, setDefaultUri, setOwner, setPermission, setReplication, setStoragePolicy, setTimes, setVerifyChecksum, setWriteChecksum, setXAttr, setXAttr, startLocalOutput, supportsSymlinks, truncate, unsetStoragePolicy

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()

Deprecated.

S3FileSystem

public S3FileSystem(org.apache.hadoop.fs.s3.FileSystemStore store)

Deprecated.

Method Detail

getScheme

public String getScheme()

Deprecated.

Return the protocol scheme for the FileSystem.

Overrides:

getScheme in class FileSystem

Returns:

s3

getUri

public URI getUri()

Deprecated.

Description copied from class: FileSystem

Returns a URI which identifies this FileSystem.

Specified by:

getUri in class FileSystem

Returns:

the URI of this filesystem.

initialize

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

Deprecated.

Description copied from class: FileSystem

Initialize a FileSystem. Called after the new FileSystem instance is constructed, and before it is ready for use. FileSystem implementations overriding this method MUST forward it to their superclass, though the order in which it is done, and whether to alter the configuration before the invocation are options of the subclass.

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 - on any failure to initialize this instance.

getWorkingDirectory

public Path getWorkingDirectory()

Deprecated.

Description copied from class: FileSystem

Get the current working directory for the given FileSystem

Specified by:

getWorkingDirectory in class FileSystem

Returns:

the directory pathname

setWorkingDirectory

public void setWorkingDirectory(Path dir)

Deprecated.

Description copied from class: FileSystem

Set the current working directory for the given FileSystem. All relative paths will be resolved relative to it.

Specified by:

setWorkingDirectory in class FileSystem

Parameters:

dir - Path of new working directory

checkPath

protected void checkPath(Path path)

Deprecated.

Check that a Path belongs to this FileSystem. Unlike the superclass, this version does not look at authority, only hostnames.

Overrides:

checkPath in class FileSystem

Parameters:

path - to check

Throws:

IllegalArgumentException - if there is an FS mismatch

canonicalizeUri

protected URI canonicalizeUri(URI rawUri)

Deprecated.

Description copied from class: FileSystem

Canonicalize the given URI. This is implementation-dependent, and may for example consist of canonicalizing the hostname using DNS and adding the default port if not specified. The default implementation simply fills in the default port if not specified and if FileSystem.getDefaultPort() returns a default port.

Overrides:

canonicalizeUri in class FileSystem

Returns:

URI

See Also:

NetUtils.getCanonicalUri(URI, int)

mkdirs

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

Deprecated.

Description copied from class: FileSystem

Make the given file and all non-existent parents into directories. Has roughly the semantics of Unix @{code mkdir -p}. Existence of the directory hierarchy is not an error.

Specified by:

mkdirs in class FileSystem

Parameters:

permission - Currently ignored.

path - path to create

Throws:

IOException - IO failure

isFile

public boolean isFile(Path path)
               throws IOException

Deprecated.

Description copied from class: FileSystem

True iff the named path is a regular file. Note: Avoid using this method. Instead reuse the FileStatus returned by FileSystem.getFileStatus(Path) or listStatus() methods.

Overrides:

isFile in class FileSystem

Parameters:

path - path to check

Throws:

IOException - IO failure

listStatus

public FileStatus[] listStatus(Path f)
                        throws IOException

Deprecated.

Description copied from class: FileSystem

List the statuses of the files/directories in the given path if the path is a directory.

Does not guarantee to return the List of files/directories status in a sorted order.

Specified by:

listStatus in class FileSystem

Parameters:

f - given path

Returns:

the statuses of the files/directories in the given patch

Throws:

FileNotFoundException - when the path does not exist

IOException - see specific implementation

append

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

Deprecated.

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 - IO failure

create

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

Deprecated.

Description copied from class: FileSystem

Create an FSDataOutputStream at the indicated Path with write-progress reporting.

Specified by:

create in class FileSystem

Parameters:

permission - Currently ignored.

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.

blockSize - block size

progress - the progress reporter

Throws:

IOException - IO failure

See Also:

FileSystem.setPermission(Path, FsPermission)

open

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

Deprecated.

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 - IO failure

rename

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

Deprecated.

Description copied from class: FileSystem

Renames Path src to Path dst.

Specified by:

rename in class FileSystem

Parameters:

src - path to be renamed

dst - new path after rename

Returns:

true if rename is successful

Throws:

IOException - on failure

delete

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

Deprecated.

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 - IO failure

getFileStatus

public FileStatus getFileStatus(Path f)
                         throws IOException

Deprecated.

FileStatus for S3 file systems.

Specified by:

getFileStatus in class FileSystem

Parameters:

f - The path we want information from

Returns:

a FileStatus object

Throws:

FileNotFoundException - when the path does not exist

IOException - see specific implementation

getDefaultBlockSize

public long getDefaultBlockSize()

Deprecated.

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

getCanonicalServiceName

public String getCanonicalServiceName()

Deprecated.

Description copied from class: FileSystem

Get a canonical service name for this FileSystem. The token cache is the only user of the canonical service name, and uses it to lookup this FileSystem's service tokens. If the file system provides a token of its own then it must have a canonical name, otherwise the canonical name can be null. Default implementation: If the FileSystem has child file systems (such as an embedded file system) then it is assumed that the FS has no tokens of its own and hence returns a null name; otherwise a service name is built using Uri and port.

Overrides:

getCanonicalServiceName in class FileSystem

Returns:

a service string that uniquely identifies this file system, null if the filesystem does not implement tokens

See Also:

SecurityUtil.buildDTServiceName(URI, int)