| Package | Description |
|---|---|
| org.apache.hadoop.fs |
An abstract file system API.
|
| org.apache.hadoop.fs.ftp | |
| org.apache.hadoop.fs.impl |
This package contains implementation classes for use inside
filesystems.
|
| org.apache.hadoop.fs.permission |
This package provides support for HDFS permission and ACL.
|
| org.apache.hadoop.fs.sftp |
SFTP FileSystem package.
|
| org.apache.hadoop.fs.shell |
Support for the execution of a file system command.
|
| org.apache.hadoop.fs.shell.find | |
| org.apache.hadoop.fs.viewfs |
ViewFileSystem and ViewFileSystemOverloadScheme classes.
|
| org.apache.hadoop.io.wrappedio |
Support for dynamic access to filesystem operations which are not available
in older hadoop releases.
|
| org.apache.hadoop.io.wrappedio.impl |
Implementation/testing support for wrapped IO.
|
| org.apache.hadoop.util |
Common utilities.
|
| Modifier and Type | Class | Description |
|---|---|---|
protected class |
FileSystem.DirListingIterator<T extends FileStatus> |
Generic iterator for implementing
FileSystem.listStatusIterator(Path). |
class |
PartialListing<T extends FileStatus> |
A partial listing of the children of a parent directory.
|
| Modifier and Type | Class | Description |
|---|---|---|
class |
LocatedFileStatus |
This class defines a FileStatus that includes a file's block locations.
|
| Modifier and Type | Method | Description |
|---|---|---|
FileStatus[] |
FileSystem.DirectoryEntries.getEntries() |
|
FileStatus |
AbstractFileSystem.getFileLinkStatus(Path f) |
The specification of this method matches that of
FileContext.getFileLinkStatus(Path)
except that an UnresolvedLinkException may be thrown if a symlink is
encountered in the path leading up to the final path component. |
FileStatus |
DelegateToFileSystem.getFileLinkStatus(Path f) |
|
FileStatus |
FileContext.getFileLinkStatus(Path f) |
Return a file status object that represents the path.
|
FileStatus |
FileSystem.getFileLinkStatus(Path f) |
|
FileStatus |
FilterFileSystem.getFileLinkStatus(Path f) |
|
FileStatus |
FilterFs.getFileLinkStatus(Path f) |
|
FileStatus |
LocalFileSystem.getFileLinkStatus(Path f) |
|
FileStatus |
RawLocalFileSystem.getFileLinkStatus(Path f) |
Return a FileStatus representing the given path.
|
abstract FileStatus |
AbstractFileSystem.getFileStatus(Path f) |
The specification of this method matches that of
FileContext.getFileStatus(Path)
except that an UnresolvedLinkException may be thrown if a symlink is
encountered in the path. |
FileStatus |
DelegateToFileSystem.getFileStatus(Path f) |
|
FileStatus |
FileContext.getFileStatus(Path f) |
Return a file status object that represents the path.
|
abstract FileStatus |
FileSystem.getFileStatus(Path f) |
Return a file status object that represents the path.
|
FileStatus |
FilterFileSystem.getFileStatus(Path f) |
Get file status.
|
FileStatus |
FilterFs.getFileStatus(Path f) |
|
FileStatus |
HarFileSystem.getFileStatus(Path f) |
return the filestatus of files in har archive.
|
FileStatus |
RawLocalFileSystem.getFileStatus(Path f) |
|
FileStatus |
Stat.getFileStatus() |
|
FileStatus[] |
Globber.glob() |
|
FileStatus[] |
FileContext.Util.globStatus(Path pathPattern) |
Return all the files that match filePattern and are not checksum
files.
|
FileStatus[] |
FileContext.Util.globStatus(Path pathPattern,
PathFilter filter) |
Return an array of FileStatus objects whose path names match pathPattern
and is accepted by the user-supplied path filter.
|
FileStatus[] |
FileSystem.globStatus(Path pathPattern) |
Return all the files that match filePattern and are not checksum
files.
|
FileStatus[] |
FileSystem.globStatus(Path pathPattern,
PathFilter filter) |
Return an array of
FileStatus objects whose path names match
pathPattern and is accepted by the user-supplied path filter. |
abstract FileStatus[] |
AbstractFileSystem.listStatus(Path f) |
The specification of this method matches that of
FileContext.Util.listStatus(Path) except that Path f must be
for this file system. |
FileStatus[] |
ChecksumFileSystem.listStatus(Path f) |
List the statuses of the files/directories in the given path if the path is
a directory.
|
FileStatus[] |
ChecksumFs.listStatus(Path f) |
|
FileStatus[] |
DelegateToFileSystem.listStatus(Path f) |
|
FileStatus[] |
FileContext.Util.listStatus(Path f) |
List the statuses of the files/directories in the given path
if the path is a directory.
|
FileStatus[] |
FileContext.Util.listStatus(Path[] files) |
|
FileStatus[] |
FileContext.Util.listStatus(Path[] files,
PathFilter filter) |
Filter files/directories in the given list of paths using user-supplied
path filter.
|
FileStatus[] |
FileContext.Util.listStatus(Path f,
PathFilter filter) |
Filter files/directories in the given path using the user-supplied path
filter.
|
abstract FileStatus[] |
FileSystem.listStatus(Path f) |
List the statuses of the files/directories in the given path if the path is
a directory.
|
FileStatus[] |
FileSystem.listStatus(Path[] files) |
Filter files/directories in the given list of paths using default
path filter.
|
FileStatus[] |
FileSystem.listStatus(Path[] files,
PathFilter filter) |
Filter files/directories in the given list of paths using user-supplied
path filter.
|
FileStatus[] |
FileSystem.listStatus(Path f,
PathFilter filter) |
Filter files/directories in the given path using the user-supplied path
filter.
|
FileStatus[] |
FilterFileSystem.listStatus(Path f) |
List files in a directory.
|
FileStatus[] |
FilterFs.listStatus(Path f) |
|
FileStatus[] |
HarFileSystem.listStatus(Path f) |
liststatus returns the children of a directory
after looking up the index files.
|
FileStatus[] |
RawLocalFileSystem.listStatus(Path f) |
List the statuses of the files/directories in the given path if the path is
a directory.
|
| Modifier and Type | Method | Description |
|---|---|---|
RemoteIterator<PartialListing<FileStatus>> |
BatchListingOperations.batchedListStatusIterator(java.util.List<Path> paths) |
Batched listing API that returns
PartialListings for the
passed Paths. |
java.util.Collection<FileStatus> |
FileSystem.getTrashRoots(boolean allUsers) |
Get all the trash roots for current user or all users.
|
java.util.Collection<FileStatus> |
FilterFileSystem.getTrashRoots(boolean allUsers) |
|
RemoteIterator<FileStatus> |
FileContext.listStatus(Path f) |
List the statuses of the files/directories in the given path if the path is
a directory.
|
RemoteIterator<FileStatus> |
AbstractFileSystem.listStatusIterator(Path f) |
The specification of this method matches that of
FileContext.listStatus(Path) except that Path f must be for this
file system. |
RemoteIterator<FileStatus> |
ChecksumFileSystem.listStatusIterator(Path p) |
|
RemoteIterator<FileStatus> |
FileSystem.listStatusIterator(Path p) |
Returns a remote iterator so that followup calls are made on demand
while consuming the entries.
|
RemoteIterator<FileStatus> |
FilterFileSystem.listStatusIterator(Path f) |
Return a remote iterator for listing in a directory
|
static java.util.function.Function<FileStatus,PathHandle> |
Options.HandleOpt.resolve(java.util.function.BiFunction<FileStatus,Options.HandleOpt[],PathHandle> fsr,
Options.HandleOpt... opt) |
Utility function for partial evaluation of
FileStatus
instances to a fixed set of handle options. |
static java.util.function.Function<FileStatus,PathHandle> |
Options.HandleOpt.resolve(FileSystem fs,
Options.HandleOpt... opt) |
Utility function for mapping
FileSystem.getPathHandle(org.apache.hadoop.fs.FileStatus, org.apache.hadoop.fs.Options.HandleOpt...) to a
fixed set of handle options. |
| Modifier and Type | Method | Description |
|---|---|---|
int |
FileStatus.compareTo(FileStatus o) |
Compare this FileStatus to another FileStatus based on lexicographical
order of path.
|
int |
LocatedFileStatus.compareTo(FileStatus o) |
Compare this FileStatus to another FileStatus
|
static boolean |
FileUtil.copy(FileSystem srcFS,
FileStatus srcStatus,
FileSystem dstFS,
Path dst,
boolean deleteSource,
boolean overwrite,
Configuration conf) |
Copy a file/directory tree within/between filesystems.
|
static boolean |
FileUtil.copyAsMove(FileSystem srcFS,
FileStatus srcStatus,
FileSystem dstFS,
Path dst,
boolean deleteSource,
boolean overwrite,
Configuration conf) |
Copy files between FileSystems with preserved permissions, ownership, links and ACEs.
|
protected PathHandle |
FileSystem.createPathHandle(FileStatus stat,
Options.HandleOpt... opt) |
Hook to implement support for
PathHandle operations. |
protected PathHandle |
FilterFileSystem.createPathHandle(FileStatus stat,
Options.HandleOpt... opts) |
|
protected PathHandle |
HarFileSystem.createPathHandle(FileStatus stat,
Options.HandleOpt... opts) |
|
protected PathHandle |
RawLocalFileSystem.createPathHandle(FileStatus stat,
Options.HandleOpt... opts) |
Hook to implement support for
PathHandle operations. |
static Path |
FileUtil.fixSymlinkFileStatus(FileStatus stat) |
|
BlockLocation[] |
FileSystem.getFileBlockLocations(FileStatus file,
long start,
long len) |
Return an array containing hostnames, offset and size of
portions of the given file.
|
BlockLocation[] |
FilterFileSystem.getFileBlockLocations(FileStatus file,
long start,
long len) |
|
BlockLocation[] |
HarFileSystem.getFileBlockLocations(FileStatus file,
long start,
long len) |
Get block locations from the underlying fs and fix their
offsets and lengths.
|
PathHandle |
FileSystem.getPathHandle(FileStatus stat,
Options.HandleOpt... opt) |
Create a durable, serializable handle to the referent of the given
entity.
|
static Path[] |
FileUtil.stat2Paths(FileStatus[] stats) |
convert an array of FileStatus to an array of Path
|
static Path[] |
FileUtil.stat2Paths(FileStatus[] stats,
Path path) |
convert an array of FileStatus to an array of Path.
|
void |
LocalFileSystemPathHandle.verify(FileStatus stat) |
|
default FutureDataInputStreamBuilder |
FutureDataInputStreamBuilder.withFileStatus(FileStatus status) |
A FileStatus may be provided to the open request.
|
| Modifier and Type | Method | Description |
|---|---|---|
static java.util.function.Function<FileStatus,PathHandle> |
Options.HandleOpt.resolve(java.util.function.BiFunction<FileStatus,Options.HandleOpt[],PathHandle> fsr,
Options.HandleOpt... opt) |
Utility function for partial evaluation of
FileStatus
instances to a fixed set of handle options. |
| Constructor | Description |
|---|---|
DirectoryEntries(FileStatus[] entries,
byte[] token,
boolean hasMore) |
|
FileStatus(FileStatus other) |
Copy constructor.
|
LocatedFileStatus(FileStatus stat,
BlockLocation[] locations) |
Constructor
|
| Modifier and Type | Method | Description |
|---|---|---|
FileStatus |
FTPFileSystem.getFileStatus(Path file) |
|
FileStatus[] |
FTPFileSystem.listStatus(Path file) |
| Modifier and Type | Method | Description |
|---|---|---|
protected FileStatus |
FutureDataInputStreamBuilderImpl.getStatus() |
Get any status set in
FutureDataInputStreamBuilderImpl.withFileStatus(FileStatus). |
FileStatus |
OpenFileParameters.getStatus() |
| Modifier and Type | Method | Description |
|---|---|---|
FutureDataInputStreamBuilder |
FutureDataInputStreamBuilderImpl.withFileStatus(FileStatus st) |
|
OpenFileParameters |
OpenFileParameters.withStatus(FileStatus st) |
| Modifier and Type | Method | Description |
|---|---|---|
short |
ChmodParser.applyNewPermission(FileStatus file) |
Apply permission against specified file and determine what the
new mode would be
|
| Modifier and Type | Method | Description |
|---|---|---|
FileStatus |
SFTPFileSystem.getFileStatus(Path f) |
|
FileStatus[] |
SFTPFileSystem.listStatus(Path f) |
| Modifier and Type | Field | Description |
|---|---|---|
FileStatus |
PathData.stat |
| Modifier and Type | Method | Description |
|---|---|---|
FileStatus |
PathData.refreshStatus() |
Updates the paths's file status
|
| Modifier and Type | Method | Description |
|---|---|---|
protected FileStatus |
BaseExpression.getFileStatus(PathData item,
int depth) |
Returns the
FileStatus from the PathData item. |
| Modifier and Type | Method | Description |
|---|---|---|
FileStatus |
ViewFs.getFileLinkStatus(Path f) |
|
FileStatus |
ViewFileSystem.getFileStatus(Path f) |
Return a file status object that represents the path.
|
FileStatus |
ViewFs.getFileStatus(Path f) |
The specification of this method matches that of
FileContext.getFileStatus(Path)
except that an UnresolvedLinkException may be thrown if a symlink is
encountered in the path. |
FileStatus[] |
ViewFileSystem.listStatus(Path f) |
List the statuses of the files/directories in the given path if the path is
a directory.
|
FileStatus[] |
ViewFs.listStatus(Path f) |
The specification of this method matches that of
FileContext.Util.listStatus(Path) except that Path f must be
for this file system. |
| Modifier and Type | Method | Description |
|---|---|---|
java.util.Collection<FileStatus> |
ViewFileSystem.getTrashRoots(boolean allUsers) |
Get all the trash roots for current user or all users.
|
RemoteIterator<FileStatus> |
ViewFs.listStatusIterator(Path f) |
| Modifier and Type | Method | Description |
|---|---|---|
BlockLocation[] |
ViewFileSystem.getFileBlockLocations(FileStatus fs,
long start,
long len) |
| Modifier and Type | Method | Description |
|---|---|---|
static FSDataInputStream |
WrappedIO.fileSystem_openFile(FileSystem fs,
Path path,
java.lang.String policy,
FileStatus status,
java.lang.Long length,
java.util.Map<java.lang.String,java.lang.String> options) |
OpenFile assistant, easy reflection-based access to
FileSystem.openFile(Path) and blocks
awaiting the operation completion. |
| Modifier and Type | Method | Description |
|---|---|---|
FSDataInputStream |
DynamicWrappedIO.fileSystem_openFile(FileSystem fs,
Path path,
java.lang.String policy,
FileStatus status,
java.lang.Long length,
java.util.Map<java.lang.String,java.lang.String> options) |
OpenFile assistant, easy reflection-based access to
FileSystem#openFile(Path) and blocks
awaiting the operation completion. |
static FSDataInputStream |
DynamicWrappedIO.openFile(FileSystem fs,
FileStatus status,
java.lang.String readPolicies) |
Open a file.
|
| Modifier and Type | Method | Description |
|---|---|---|
T |
JsonSerialization.load(FileSystem fs,
Path path,
FileStatus status) |
Load from a Hadoop filesystem.
|
Copyright © 2008–2025 Apache Software Foundation. All rights reserved.