org.apache.hadoop.fs.s3native

Class NativeS3FileSystem

java.lang.Object

org.apache.hadoop.conf.Configured

org.apache.hadoop.fs.FileSystem

org.apache.hadoop.fs.s3native.NativeS3FileSystem

All Implemented Interfaces:

Closeable, AutoCloseable, Configurable, BulkDeleteSource, org.apache.hadoop.fs.PathCapabilities, org.apache.hadoop.security.token.DelegationTokenIssuer

Deprecated.

Replaced by the S3A client.

@InterfaceAudience.Public
 @InterfaceStability.Stable
public final class NativeS3FileSystem
extends FileSystem

This is a stub filesystem purely present to fail meaningfully when someone who explicitly declares fs.s3n.impl=org.apache.hadoop.fs.s3native.NativeS3FileSystem and then tries to create a filesystem off an s3n:// URL. The initialize(URI, Configuration) method will throw an IOException informing the user of their need to migrate.

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	LOG Deprecated.

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

DEFAULT_FS, FS_DEFAULT_NAME_KEY, SHUTDOWN_HOOK_PRIORITY, statistics, TRASH_PREFIX, USER_HOME_PREFIX

Fields inherited from interface org.apache.hadoop.security.token.DelegationTokenIssuer

TOKEN_LOG

Constructor Summary

Constructors

Constructor and Description
NativeS3FileSystem() Deprecated.

Method Summary

Modifier and Type	Method and Description
FSDataOutputStream	append(Path f, int bufferSize, Progressable progress) Deprecated. Append to an existing file (optional operation).
FSDataOutputStream	create(Path f, 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 f, boolean recursive) Deprecated. Delete a file.
FileStatus	getFileStatus(Path f) Deprecated. Return a file status object that represents the path.
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. Always fail to initialize.
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 f, FsPermission permission) Deprecated. Make the given file and all non-existent parents into directories.
FSDataInputStream	open(Path f, 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 new_dir) Deprecated. Set the current working directory for the given FileSystem.

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

append, append, append, append, appendFile, areSymlinksEnabled, cancelDeleteOnExit, canonicalizeUri, checkPath, 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, createBulkDelete, createDataOutputStreamBuilder, createFile, createMultipartUploader, createNewFile, createNonRecursive, createNonRecursive, createNonRecursive, createPathHandle, createSnapshot, createSnapshot, createSymlink, delete, deleteOnExit, deleteSnapshot, enableSymlinks, exists, fixRelativePart, get, get, get, getAclStatus, getAllStatistics, getAllStoragePolicies, getBlockSize, getCanonicalServiceName, getCanonicalUri, getContentSummary, getDefaultBlockSize, getDefaultBlockSize, getDefaultPort, getDefaultReplication, getDefaultReplication, getDefaultUri, getEnclosingRoot, getFileBlockLocations, getFileBlockLocations, getFileChecksum, getFileChecksum, getFileLinkStatus, getFileSystemClass, getFSofPath, getGlobalStorageStatistics, getHomeDirectory, getInitialWorkingDirectory, getLength, getLinkTarget, getLocal, getName, getNamed, getPathHandle, getQuotaUsage, getReplication, getServerDefaults, getServerDefaults, getStatistics, getStatistics, getStatus, getStatus, getStoragePolicy, getStorageStatistics, getTrashRoot, getTrashRoots, getUsed, getUsed, getXAttr, getXAttrs, getXAttrs, globStatus, globStatus, hasPathCapability, isDirectory, isFile, listCorruptFileBlocks, listFiles, listLocatedStatus, listLocatedStatus, listStatus, listStatus, listStatus, listStatusIterator, listXAttrs, makeQualified, mkdirs, mkdirs, modifyAclEntries, moveFromLocalFile, moveFromLocalFile, moveToLocalFile, msync, newInstance, newInstance, newInstance, newInstanceLocal, open, open, open, openFile, openFile, openFileWithOptions, openFileWithOptions, primitiveCreate, primitiveMkdir, primitiveMkdir, printStatistics, processDeleteOnExit, removeAcl, removeAclEntries, removeDefaultAcl, removeXAttr, rename, renameSnapshot, resolveLink, resolvePath, satisfyStoragePolicy, setAcl, setDefaultUri, setDefaultUri, setOwner, setPermission, setQuota, setQuotaByStorageType, 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

Methods inherited from interface org.apache.hadoop.security.token.DelegationTokenIssuer

addDelegationTokens, getAdditionalTokenIssuers, getDelegationToken

Field Detail

LOG

public static final org.slf4j.Logger LOG

Deprecated.

Constructor Detail

NativeS3FileSystem

public NativeS3FileSystem()

Deprecated.

Method Detail

getScheme

public String getScheme()

Deprecated.

Return the protocol scheme for the FileSystem.

Overrides:

getScheme in class FileSystem

Returns:

s3n

initialize

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

Deprecated.

Always fail to initialize.

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 - always.

getFileStatus

public FileStatus getFileStatus(Path f)
                         throws IOException

Deprecated.

Description copied from class: FileSystem

Return a file status object that represents the path.

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

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.

open

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

Deprecated.

Description copied from class: FileSystem

Opens an FSDataInputStream at the indicated Path.

Specified by:

open in class FileSystem

Parameters:

f - the file name to open

bufferSize - the size of the buffer to be used.

Returns:

input stream.

Throws:

IOException - IO failure

create

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

f - the file name to open

permission - file permission

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

Returns:

output stream.

Throws:

IOException - IO failure

See Also:

FileSystem.setPermission(Path, FsPermission)

append

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

Deprecated.

Description copied from class: FileSystem

Append to an existing file (optional operation).

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.

Returns:

output stream.

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 f,
                      boolean recursive)
               throws IOException

Deprecated.

Description copied from class: FileSystem

Delete a file.

Specified by:

delete in class FileSystem

Parameters:

f - 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

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.

Will not return null. Expect IOException upon access error.

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

setWorkingDirectory

public void setWorkingDirectory(Path new_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:

new_dir - Path of new working directory

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

mkdirs

public boolean mkdirs(Path f,
                      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:

f - path to create

permission - to apply to f

Returns:

if mkdir success true, not false.

Throws:

IOException - IO failure