org.apache.hadoop.fs.s3native

クラス NativeS3FileSystem

java.lang.Object

org.apache.hadoop.conf.Configured

org.apache.hadoop.fs.FileSystem

org.apache.hadoop.fs.s3native.NativeS3FileSystem

すべての実装されたインタフェース:

Closeable, AutoCloseable, Configurable

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

A FileSystem for reading and writing files stored on Amazon S3. This implementation stores files on S3 in their native form so they can be read by other S3 tools.

A note about directories. S3 of course has no "native" support for them. The idiom we choose then is: for any directory created by this class, we use an empty object "#{dirpath}_$folder$" as a marker. Further, to interoperate with other S3 tools, we also accept the following:

• an object "#{dirpath}/' denoting a directory marker
• if there exists any objects with the prefix "#{dirpath}/", then the directory is said to exist
• if both a file with the name of a directory and a marker for that directory exists, then the *file masks the directory*, and the directory is never returned.

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
static org.slf4j.Logger	LOG

クラスから継承されたフィールド org.apache.hadoop.fs.FileSystem

DEFAULT_FS, FS_DEFAULT_NAME_KEY, SHUTDOWN_HOOK_PRIORITY, statistics, TRASH_PREFIX

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
NativeS3FileSystem()
NativeS3FileSystem(org.apache.hadoop.fs.s3native.NativeFileSystemStore store)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
FSDataOutputStream	append(Path f, int bufferSize, Progressable progress) This optional operation is not yet supported.
protected URI	canonicalizeUri(URI rawUri) Canonicalize the given URI.
protected void	checkPath(Path path) Check that a Path belongs to this FileSystem.
FSDataOutputStream	create(Path f, FsPermission permission, boolean overwrite, int bufferSize, short replication, long blockSize, Progressable progress) Create an FSDataOutputStream at the indicated Path with write-progress reporting.
boolean	delete(Path f, boolean recurse) Delete a file.
String	getCanonicalServiceName() Get a canonical service name for this file system.
long	getDefaultBlockSize() Return the number of bytes that large input files should be optimally be split into to minimize i/o time.
FileStatus	getFileStatus(Path f) Return a file status object that represents the path.
String	getScheme() Return the protocol scheme for the FileSystem.
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.
FileStatus[]	listStatus(Path f) If f is a file, this method will make a single call to S3.
boolean	mkdirs(Path f, FsPermission permission) Make the given file and all non-existent parents into directories.
FSDataInputStream	open(Path f, int bufferSize) Opens an FSDataInputStream at the indicated Path.
boolean	rename(Path src, Path dst) Renames Path src to Path dst.
void	setWorkingDirectory(Path newDir) Set the working directory to the given directory.

クラスから継承されたメソッド org.apache.hadoop.fs.FileSystem

append, append, 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, 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, isFile, listCorruptFileBlocks, listFiles, listLocatedStatus, listLocatedStatus, listStatus, listStatus, listStatus, listStatusIterator, listXAttrs, makeQualified, mkdirs, mkdirs, modifyAclEntries, moveFromLocalFile, moveFromLocalFile, moveToLocalFile, 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

クラスから継承されたメソッド org.apache.hadoop.conf.Configured

getConf, setConf

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

LOG

public static final org.slf4j.Logger LOG

コンストラクタの詳細

NativeS3FileSystem

public NativeS3FileSystem()

NativeS3FileSystem

public NativeS3FileSystem(org.apache.hadoop.fs.s3native.NativeFileSystemStore store)

メソッドの詳細

getScheme

public String getScheme()

Return the protocol scheme for the FileSystem.

オーバーライド:

getScheme クラス内 FileSystem

戻り値:

s3n

initialize

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

クラスからコピーされた説明: FileSystem

Called after a new FileSystem instance is constructed.

オーバーライド:

initialize クラス内 FileSystem

パラメータ:

uri - a uri whose authority section names the host, port, etc. for this FileSystem

conf - the configuration

例外:

IOException

checkPath

protected void checkPath(Path path)

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

オーバーライド:

checkPath クラス内 FileSystem

パラメータ:

path - to check

例外:

IllegalArgumentException - if there is an FS mismatch

canonicalizeUri

protected URI canonicalizeUri(URI rawUri)

クラスからコピーされた説明: FileSystem

Canonicalize the given URI. This is filesystem-dependent, but 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 the filesystem has a default port.

オーバーライド:

canonicalizeUri クラス内 FileSystem

戻り値:

URI

関連項目:

NetUtils.getCanonicalUri(URI, int)

append

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

This optional operation is not yet supported.

定義:

append クラス内 FileSystem

パラメータ:

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.

例外:

IOException

create

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

クラスからコピーされた説明: FileSystem

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

定義:

create クラス内 FileSystem

パラメータ:

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

例外:

IOException

関連項目:

FileSystem.setPermission(Path, FsPermission)

delete

public boolean delete(Path f,
                      boolean recurse)
               throws IOException

クラスからコピーされた説明: FileSystem

Delete a file.

定義:

delete クラス内 FileSystem

パラメータ:

f - the path to delete.

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

戻り値:

true if delete is successful else false.

例外:

IOException

getFileStatus

public FileStatus getFileStatus(Path f)
                         throws IOException

クラスからコピーされた説明: FileSystem

Return a file status object that represents the path.

定義:

getFileStatus クラス内 FileSystem

パラメータ:

f - The path we want information from

戻り値:

a FileStatus object

例外:

FileNotFoundException - when the path does not exist; IOException see specific implementation

IOException

getUri

public URI getUri()

クラスからコピーされた説明: FileSystem

Returns a URI whose scheme and authority identify this FileSystem.

定義:

getUri クラス内 FileSystem

listStatus

public FileStatus[] listStatus(Path f)
                        throws IOException

If f is a file, this method will make a single call to S3. If f is a directory, this method will make a maximum of (n / 1000) + 2 calls to S3, where n is the total number of files and directories contained directly in f.

定義:

listStatus クラス内 FileSystem

パラメータ:

f - given path

戻り値:

the statuses of the files/directories in the given patch

例外:

FileNotFoundException - when the path does not exist; IOException see specific implementation

IOException

mkdirs

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

クラスからコピーされた説明: 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.

定義:

mkdirs クラス内 FileSystem

パラメータ:

f - path to create

permission - to apply to f

例外:

IOException

open

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

クラスからコピーされた説明: FileSystem

Opens an FSDataInputStream at the indicated Path.

定義:

open クラス内 FileSystem

パラメータ:

f - the file name to open

bufferSize - the size of the buffer to be used.

例外:

IOException

rename

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

クラスからコピーされた説明: FileSystem

Renames Path src to Path dst. Can take place on local fs or remote DFS.

定義:

rename クラス内 FileSystem

パラメータ:

src - path to be renamed

dst - new path after rename

戻り値:

true if rename is successful

例外:

IOException - on failure

getDefaultBlockSize

public long getDefaultBlockSize()

クラスからコピーされた説明: FileSystem

Return the number of bytes that large input files should be optimally be split into to minimize i/o time.

オーバーライド:

getDefaultBlockSize クラス内 FileSystem

setWorkingDirectory

public void setWorkingDirectory(Path newDir)

Set the working directory to the given directory.

定義:

setWorkingDirectory クラス内 FileSystem

パラメータ:

newDir - Path of new working directory

getWorkingDirectory

public Path getWorkingDirectory()

クラスからコピーされた説明: FileSystem

Get the current working directory for the given file system

定義:

getWorkingDirectory クラス内 FileSystem

戻り値:

the directory pathname

getCanonicalServiceName

public String getCanonicalServiceName()

クラスからコピーされた説明: FileSystem

Get a canonical service name for this file system. The token cache is the only user of the canonical service name, and uses it to lookup this filesystem's service tokens. If file system provides a token of its own then it must have a canonical name, otherwise canonical name can be null. Default Impl: If the file system 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.

戻り値:

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

関連項目:

SecurityUtil.buildDTServiceName(URI, int)