org.apache.hadoop.fs

类 FilterFileSystem

java.lang.Object

org.apache.hadoop.conf.Configured

org.apache.hadoop.fs.FileSystem

org.apache.hadoop.fs.FilterFileSystem

所有已实现的接口:

Closeable, AutoCloseable, Configurable

直接已知子类:

ChecksumFileSystem, HarFileSystem

public class FilterFileSystem
extends FileSystem

A FilterFileSystem contains some other file system, which it uses as its basic file system, possibly transforming the data along the way or providing additional functionality. The class FilterFileSystem itself simply overrides all methods of FileSystem with versions that pass all requests to the contained file system. Subclasses of FilterFileSystem may further override some of these methods and may also provide additional methods and fields.

嵌套类概要

从类继承的嵌套类/接口 org.apache.hadoop.fs.FileSystem

FileSystem.Statistics

字段概要

字段

限定符和类型	字段和说明
protected FileSystem	fs

从类继承的字段 org.apache.hadoop.fs.FileSystem

FS_DEFAULT_NAME_KEY, LOG, statistics

构造器概要

构造器

构造器和说明
FilterFileSystem()
FilterFileSystem(FileSystem fs)

方法概要

方法

限定符和类型	方法和说明
FSDataOutputStream	append(Path f, int bufferSize, Progressable progress) Append to an existing file (optional operation).
protected void	checkPath(Path path) Check that a Path belongs to this FileSystem.
void	close() No more filesystem operations are needed.
void	completeLocalOutput(Path fsOutputFile, Path tmpLocalFile) Called when we're all done writing to the target.
void	concat(Path f, Path[] psrcs) Concat existing files together.
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 f, 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 f) 已过时。
boolean	delete(Path f, boolean recursive) Delete a file
String	getCanonicalServiceName() Get a canonical service name for this file system.
Configuration	getConf() Return the configuration used by this object.
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 an array containing hostnames, offset and size of portions of the given file.
FileChecksum	getFileChecksum(Path f) Get the checksum of a file.
FileStatus	getFileStatus(Path f) Get file status.
Path	getHomeDirectory() Return the current user's home directory in this filesystem.
String	getName() 已过时。 call #getUri() instead.
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 name, Configuration conf) Called after a new FileSystem instance is constructed.
FileStatus[]	listStatus(Path f) List files in a directory.
Path	makeQualified(Path path) Make sure that a path specifies a FileSystem.
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	setOwner(Path p, String username, String groupname) Set owner of a path (i.e. a file or a directory).
void	setPermission(Path p, FsPermission permission) Set permission of a path.
boolean	setReplication(Path src, short replication) Set replication for an existing file.
void	setVerifyChecksum(boolean verifyChecksum) Set the verify checksum flag.
void	setWorkingDirectory(Path newDir) 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.

从类继承的方法 org.apache.hadoop.fs.FileSystem

addFileSystemForTesting, append, append, clearStatistics, 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, getCacheSize, getCanonicalUri, getContentSummary, getDefaultBlockSize, getDefaultPort, getDefaultReplication, getDefaultUri, getDelegationToken, getLength, getLocal, getNamed, getReplication, getStatistics, getStatistics, getUsed, globStatus, globStatus, isDirectory, isFile, listStatus, listStatus, listStatus, mkdirs, mkdirs, moveFromLocalFile, moveFromLocalFile, moveToLocalFile, open, printStatistics, processDeleteOnExit, setDefaultUri, setDefaultUri, setTimes

从类继承的方法 org.apache.hadoop.conf.Configured

setConf

从类继承的方法 java.lang.Object

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

字段详细资料

fs

protected FileSystem fs

构造器详细资料

FilterFileSystem

public FilterFileSystem()

FilterFileSystem

public FilterFileSystem(FileSystem fs)

方法详细资料

initialize

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

Called after a new FileSystem instance is constructed.

覆盖:

initialize 在类中 FileSystem

参数:

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

conf - the configuration

抛出:

IOException

getUri

public URI getUri()

Returns a URI whose scheme and authority identify this FileSystem.

指定者:

getUri 在类中 FileSystem

getCanonicalServiceName

public String getCanonicalServiceName()

从类复制的说明: FileSystem

Get a canonical service name for this file system. The token cache is the only user of this value, and uses it to lookup this filesystem's service tokens. The token cache will not attempt to acquire tokens if the service is null.

覆盖:

getCanonicalServiceName 在类中 FileSystem

返回:

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

另请参阅:

SecurityUtil.buildDTServiceName(URI, int)

getName

public String getName()

已过时。 call #getUri() instead.

覆盖:

getName 在类中 FileSystem

makeQualified

public Path makeQualified(Path path)

Make sure that a path specifies a FileSystem.

覆盖:

makeQualified 在类中 FileSystem

checkPath

protected void checkPath(Path path)

Check that a Path belongs to this FileSystem.

覆盖:

checkPath 在类中 FileSystem

getFileBlockLocations

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

从类复制的说明: FileSystem

Return an array containing hostnames, offset and size of portions of the given file. For a nonexistent file or regions, null will be returned. This call is most helpful with DFS, where it returns hostnames of machines that contain the given file. The FileSystem will simply return an elt containing 'localhost'.

覆盖:

getFileBlockLocations 在类中 FileSystem

抛出:

IOException

open

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

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

append

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

Append to an existing file (optional operation).

指定者:

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

concat

public void concat(Path f,
          Path[] psrcs)
            throws IOException

从类复制的说明: FileSystem

Concat existing files together.

覆盖:

concat 在类中 FileSystem

参数:

f - the path to the target destination.

抛出:

IOException

create

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

从类复制的说明: FileSystem

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

指定者:

create 在类中 FileSystem

参数:

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

抛出:

IOException

另请参阅:

FileSystem.setPermission(Path, FsPermission)

setReplication

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

Set replication for an existing file.

覆盖:

setReplication 在类中 FileSystem

参数:

src - file name

replication - new replication

返回:

true if successful; false if file does not exist or is a directory

抛出:

IOException

rename

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

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

指定者:

rename 在类中 FileSystem

抛出:

IOException

delete

@Deprecated
public boolean delete(Path f)
               throws IOException

已过时。

Delete a file

指定者:

delete 在类中 FileSystem

抛出:

IOException

delete

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

Delete a file

指定者:

delete 在类中 FileSystem

参数:

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.

返回:

true if delete is successful else false.

抛出:

IOException

listStatus

public FileStatus[] listStatus(Path f)
                        throws IOException

List files in a directory.

指定者:

listStatus 在类中 FileSystem

参数:

f - given path

返回:

the statuses of the files/directories in the given patch returns null, if Path f does not exist in the FileSystem

抛出:

IOException

getHomeDirectory

public Path getHomeDirectory()

从类复制的说明: FileSystem

Return the current user's home directory in this filesystem. The default implementation returns "/user/$USER/".

覆盖:

getHomeDirectory 在类中 FileSystem

setWorkingDirectory

public void setWorkingDirectory(Path newDir)

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

指定者:

setWorkingDirectory 在类中 FileSystem

参数:

newDir -

getWorkingDirectory

public Path getWorkingDirectory()

Get the current working directory for the given file system

指定者:

getWorkingDirectory 在类中 FileSystem

返回:

the directory pathname

mkdirs

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

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

抛出:

IOException

copyFromLocalFile

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

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

覆盖:

copyFromLocalFile 在类中 FileSystem

抛出:

IOException

copyToLocalFile

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

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.

覆盖:

copyToLocalFile 在类中 FileSystem

抛出:

IOException

startLocalOutput

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

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.

覆盖:

startLocalOutput 在类中 FileSystem

抛出:

IOException

completeLocalOutput

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

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.

覆盖:

completeLocalOutput 在类中 FileSystem

抛出:

IOException

getDefaultBlockSize

public long getDefaultBlockSize()

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

覆盖:

getDefaultBlockSize 在类中 FileSystem

getDefaultReplication

public short getDefaultReplication()

Get the default replication.

覆盖:

getDefaultReplication 在类中 FileSystem

getFileStatus

public FileStatus getFileStatus(Path f)
                         throws IOException

Get file status.

指定者:

getFileStatus 在类中 FileSystem

参数:

f - The path we want information from

返回:

a FileStatus object

抛出:

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

IOException

getFileChecksum

public FileChecksum getFileChecksum(Path f)
                             throws IOException

Get the checksum of a file.

覆盖:

getFileChecksum 在类中 FileSystem

参数:

f - The file path

返回:

The file checksum. The default return value is null, which indicates that no checksum algorithm is implemented in the corresponding FileSystem.

抛出:

IOException

setVerifyChecksum

public void setVerifyChecksum(boolean verifyChecksum)

Set the verify checksum flag. This is only applicable if the corresponding FileSystem supports checksum. By default doesn't do anything.

覆盖:

setVerifyChecksum 在类中 FileSystem

getConf

public Configuration getConf()

从接口复制的说明: Configurable

Return the configuration used by this object.

指定者:

getConf 在接口中 Configurable

覆盖:

getConf 在类中 Configured

close

public void close()
           throws IOException

从类复制的说明: FileSystem

No more filesystem operations are needed. Will release any held locks.

指定者:

close 在接口中 Closeable

指定者:

close 在接口中 AutoCloseable

覆盖:

close 在类中 FileSystem

抛出:

IOException

setOwner

public void setOwner(Path p,
            String username,
            String groupname)
              throws IOException

Set owner of a path (i.e. a file or a directory). The parameters username and groupname cannot both be null.

覆盖:

setOwner 在类中 FileSystem

参数:

p - The path

username - If it is null, the original username remains unchanged.

groupname - If it is null, the original groupname remains unchanged.

抛出:

IOException

setPermission

public void setPermission(Path p,
                 FsPermission permission)
                   throws IOException

Set permission of a path.

覆盖:

setPermission 在类中 FileSystem

抛出:

IOException