Uses of Package
org.apache.hadoop.fs

Packages that use org.apache.hadoop.fs

Package	Description
org.apache.hadoop.conf	Configuration of system parameters.
org.apache.hadoop.crypto	Crypto related classes.
org.apache.hadoop.crypto.key	Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.
org.apache.hadoop.fs	An abstract file system API.
org.apache.hadoop.fs.crypto
org.apache.hadoop.fs.ftp
org.apache.hadoop.fs.http	Filesystem implementations that allow Hadoop to read directly from HTTP / HTTPS endpoints.
org.apache.hadoop.fs.impl	This package contains implementation classes for use inside filesystems.
org.apache.hadoop.fs.impl.prefetch	block caching for use in object store clients.
org.apache.hadoop.fs.local	Filesystem implementations that allow Hadoop to read directly from the local file system.
org.apache.hadoop.fs.permission	This package provides support for HDFS permission and ACL.
org.apache.hadoop.fs.protocolPB	Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.
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.statistics	This package contains support for statistic collection and reporting.
org.apache.hadoop.fs.statistics.impl	Implementation support for statistics.
org.apache.hadoop.fs.store	This package is for classes to be shared across object stores; for internal use within the hadoop-* modules only.
org.apache.hadoop.fs.viewfs	ViewFileSystem and ViewFileSystemOverloadScheme classes.
org.apache.hadoop.io	Generic i/o code for use when reading and writing data to the network, to databases, and to files.
org.apache.hadoop.io.compress
org.apache.hadoop.io.file.tfile
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.metrics2.sink	Builtin metrics sinks
org.apache.hadoop.security	Classes for hadoop security.
org.apache.hadoop.security.alias	Provides the hadoop credential provider API.
org.apache.hadoop.util	Common utilities.
org.apache.hadoop.util.functional	Support for functional programming within the Hadoop APIs.

Classes in org.apache.hadoop.fs used by org.apache.hadoop.conf

Class	Description
Path	Names a file or directory in a FileSystem.

Classes in org.apache.hadoop.fs used by org.apache.hadoop.crypto

Class	Description
ByteBufferPositionedReadable	Implementers of this interface provide a positioned read API that writes to a ByteBuffer rather than a byte[].
ByteBufferReadable	Implementers of this interface provide a read API that writes to a ByteBuffer, not a byte[].
CanSetDropBehind
CanSetReadahead
CanUnbuffer	FSDataInputStreams implement this interface to indicate that they can clear their buffers on request.
HasEnhancedByteBufferAccess	FSDataInputStreams implement this interface to provide enhanced byte buffer access.
HasFileDescriptor	Having a FileDescriptor
PositionedReadable	Stream that permits positional reading.
ReadOption	Options that can be used when reading from a FileSystem.
Seekable	Stream that permits seeking.
StreamCapabilities	Interface to query streams for supported capabilities.
Syncable	This is the interface for flush/sync operations.

Classes in org.apache.hadoop.fs used by org.apache.hadoop.crypto.key

Class	Description
Path	Names a file or directory in a FileSystem.

Classes in org.apache.hadoop.fs used by org.apache.hadoop.fs

Class	Description
Abortable	Abort data being written to a stream, so that close() does not write the data.
Abortable.AbortableResult	Interface for the result of aborts; allows subclasses to extend (IOStatistics etc) or for future enhancements if ever needed.
AbstractFileSystem	This class provides an interface for implementors of a Hadoop file system (analogous to the VFS of Unix).
BatchedRemoteIterator.BatchedEntries
BlockLocation	Represents the network location of a block, information about the hosts that contain block replicas, and other block metadata (E.g. the file offset associated with the block, length, whether it is corrupt, etc).
BlockStoragePolicySpi	A storage policy specifies the placement of block replicas on specific storage types.
BulkDelete	API for bulk deletion of objects/files, but not directories.
BulkDeleteSource	Interface for bulk deletion.
ByteBufferPositionedReadable	Implementers of this interface provide a positioned read API that writes to a ByteBuffer rather than a byte[].
ByteBufferReadable	Implementers of this interface provide a read API that writes to a ByteBuffer, not a byte[].
CachingGetSpaceUsed	Interface for class that can tell estimate much space is used in a directory.
CanSetDropBehind
CanSetReadahead
CanUnbuffer	FSDataInputStreams implement this interface to indicate that they can clear their buffers on request.
ChecksumFileSystem	Abstract Checksumed FileSystem.
CommonConfigurationKeys	This class contains constants for configuration keys used in the common code.
CommonConfigurationKeysPublic	This class contains constants for configuration keys used in the common code.
ContentSummary	Store the summary of a content (a directory or a file).
ContentSummary.Builder	We don't use generics.
CreateFlag	CreateFlag specifies the file create semantic.
DelegateToFileSystem	Implementation of AbstractFileSystem based on the existing implementation of FileSystem.
DelegationTokenRenewer	A daemon thread that waits for the next file system to renew.
DelegationTokenRenewer.Renewable	The renewable interface used by the renewer.
DelegationTokenRenewer.RenewAction	An action that will renew and replace the file system's delegation tokens automatically.
FileAlreadyExistsException	Used when target file already exists for any operation and is not configured to be overwritten.
FileChecksum	An abstract class representing file checksums for files.
FileContext	The FileContext class provides an interface for users of the Hadoop file system.
FileContext.Util	Utility/library methods built over the basic FileContext methods.
FileRange	A byte range of a file.
FileStatus	Interface that represents the client side information for a file.
FileStatus.AttrFlags	Flags for entity attributes.
FileSystem	An abstract base class for a fairly generic filesystem.
FileSystem.DirectoryEntries	Represents a batch of directory entries when iteratively listing a directory.
FileSystem.Statistics	Tracks statistics about how many reads, writes, and so forth have been done in a FileSystem.
FileSystem.Statistics.StatisticsData	Statistics data.
FilterFileSystem	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.
FilterFs	A FilterFs contains some other file system, which it uses as its basic file system, possibly transforming the data along the way or providing additional functionality.
FSBuilder	The base interface which various FileSystem FileContext Builder interfaces can extend, and which underlying implementations will then implement.
FSDataInputStream	Utility that wraps a FSInputStream in a DataInputStream and buffers input through a BufferedInputStream.
FSDataOutputStream	Utility that wraps a OutputStream in a DataOutputStream.
FSDataOutputStreamBuilder	Builder for FSDataOutputStream and its subclasses.
FSInputStream	FSInputStream is a generic old InputStream with a little bit of RAF-style seek ability.
FsServerDefaults	Provides server default configuration values to clients.
FsShell	Provide command line access to a FileSystem.
FsShell.Help	Displays short usage of commands sans the long description
FsShellPermissions	This class is the home for file permissions related commands.
FsShellPermissions.Chown	Used to change owner and/or group of files
FsStatus	This class is used to represent the capacity, free and used space on a FileSystem.
FutureDataInputStreamBuilder	Builder for input streams and subclasses whose return value is actually a completable future: this allows for better asynchronous operation.
GetSpaceUsed
GetSpaceUsed.Builder	The builder class
GlobalStorageStatistics	Stores global storage statistics objects.
GlobalStorageStatistics.StorageStatisticsProvider	A callback API for creating new StorageStatistics instances.
Globber	Implementation of FileSystem.globStatus(Path, PathFilter).
Globber.GlobBuilder	Builder for Globber instances.
HardLink	Class for creating hardlinks.
HardLink.LinkStats	HardLink statistics counters and methods.
HasEnhancedByteBufferAccess	FSDataInputStreams implement this interface to provide enhanced byte buffer access.
HasFileDescriptor	Having a FileDescriptor
InvalidPathHandleException	Thrown when the constraints enoded in a PathHandle do not hold.
LocalFileSystem	Implement the FileSystem API for the checksumed local filesystem.
LocatedFileStatus	This class defines a FileStatus that includes a file's block locations.
MD5MD5CRC32FileChecksum	MD5 of MD5 of CRC32.
MultipartUploader	MultipartUploader is an interface for copying files multipart and across multiple nodes.
MultipartUploaderBuilder	Builder interface for Multipart readers.
Options.ChecksumCombineMode	Enum for indicating what mode to use when combining chunk and block checksums to define an aggregate FileChecksum.
Options.ChecksumOpt	This is used in FileSystem and FileContext to specify checksum options.
Options.CreateOpts	Class to support the varargs for create() options.
Options.CreateOpts.BlockSize
Options.CreateOpts.BufferSize
Options.CreateOpts.BytesPerChecksum	This is not needed if ChecksumParam is specified.
Options.CreateOpts.ChecksumParam
Options.CreateOpts.CreateParent
Options.CreateOpts.Perms
Options.CreateOpts.Progress
Options.CreateOpts.ReplicationFactor
Options.HandleOpt	Options for creating PathHandle references.
Options.HandleOpt.Data	Option storing standard constraints on data.
Options.HandleOpt.Location	Option storing standard constraints on location.
Options.Rename	Enum to support the varargs for rename() options
ParentNotDirectoryException	Indicates that the parent of specified Path is not a directory as expected.
PartHandle	Opaque, serializable reference to a part id for multipart uploads.
PartialListing	A partial listing of the children of a parent directory.
Path	Names a file or directory in a FileSystem.
PathCapabilities	The Path counterpoint to StreamCapabilities; a query to see if, a FileSystem/FileContext instance has a specific capability under the given path.
PathExistsException	Exception corresponding to File Exists - EEXISTS
PathFilter
PathHandle	Opaque, serializable reference to an entity in the FileSystem.
PathIOException	Exceptions based on standard posix/linux style exceptions for path related errors.
PositionedReadable	Stream that permits positional reading.
QuotaUsage	Store the quota usage of a directory.
QuotaUsage.Builder	Builder class for QuotaUsage.
ReadOption	Options that can be used when reading from a FileSystem.
RemoteIterator	An iterator over a collection whose elements need to be fetched remotely
SafeModeAction	An identical copy from org.apache.hadoop.hdfs.protocol.HdfsConstants.SafeModeAction, that helps the other file system implementation to define SafeMode.
Seekable	Stream that permits seeking.
StorageStatistics	StorageStatistics contains statistics data for a FileSystem or FileContext instance.
StorageStatistics.LongStatistic	A 64-bit storage statistic.
StorageType	Defines the types of supported storage media.
StreamCapabilities	Interface to query streams for supported capabilities.
StreamCapabilities.StreamCapability	Deprecated.
Syncable	This is the interface for flush/sync operations.
Trash	Provides a trash facility which supports pluggable Trash policies.
TrashPolicy	This interface is used for implementing different Trash policies.
UnresolvedLinkException	Thrown when a symbolic link is encountered in a path.
UnsupportedFileSystemException	File system for a given file system name/scheme is not supported
UploadHandle	Opaque, serializable reference to an uploadId for multipart uploads.
XAttrCodec	The value of XAttr is byte[], this class is to covert byte[] to some kind of string representation or convert back.
XAttrSetFlag

Classes in org.apache.hadoop.fs used by org.apache.hadoop.fs.crypto

Class	Description
Abortable	Abort data being written to a stream, so that close() does not write the data.
ByteBufferPositionedReadable	Implementers of this interface provide a positioned read API that writes to a ByteBuffer rather than a byte[].
ByteBufferReadable	Implementers of this interface provide a read API that writes to a ByteBuffer, not a byte[].
CanSetDropBehind
CanSetReadahead
CanUnbuffer	FSDataInputStreams implement this interface to indicate that they can clear their buffers on request.
FSDataInputStream	Utility that wraps a FSInputStream in a DataInputStream and buffers input through a BufferedInputStream.
FSDataOutputStream	Utility that wraps a OutputStream in a DataOutputStream.
HasEnhancedByteBufferAccess	FSDataInputStreams implement this interface to provide enhanced byte buffer access.
HasFileDescriptor	Having a FileDescriptor
PositionedReadable	Stream that permits positional reading.
Seekable	Stream that permits seeking.
StreamCapabilities	Interface to query streams for supported capabilities.
Syncable	This is the interface for flush/sync operations.

Classes in org.apache.hadoop.fs used by org.apache.hadoop.fs.ftp

Class	Description
AbstractFileSystem	This class provides an interface for implementors of a Hadoop file system (analogous to the VFS of Unix).
BulkDeleteSource	Interface for bulk deletion.
CommonConfigurationKeys	This class contains constants for configuration keys used in the common code.
CommonConfigurationKeysPublic	This class contains constants for configuration keys used in the common code.
DelegateToFileSystem	Implementation of AbstractFileSystem based on the existing implementation of FileSystem.
FileStatus	Interface that represents the client side information for a file.
FileSystem	An abstract base class for a fairly generic filesystem.
FileSystem.Statistics	Tracks statistics about how many reads, writes, and so forth have been done in a FileSystem.
FSDataInputStream	Utility that wraps a FSInputStream in a DataInputStream and buffers input through a BufferedInputStream.
FSDataOutputStream	Utility that wraps a OutputStream in a DataOutputStream.
FSInputStream	FSInputStream is a generic old InputStream with a little bit of RAF-style seek ability.
FsServerDefaults	Provides server default configuration values to clients.
Path	Names a file or directory in a FileSystem.
PathCapabilities	The Path counterpoint to StreamCapabilities; a query to see if, a FileSystem/FileContext instance has a specific capability under the given path.
PositionedReadable	Stream that permits positional reading.
Seekable	Stream that permits seeking.

Classes in org.apache.hadoop.fs used by org.apache.hadoop.fs.http

Class	Description
BulkDeleteSource	Interface for bulk deletion.
FileSystem	An abstract base class for a fairly generic filesystem.
PathCapabilities	The Path counterpoint to StreamCapabilities; a query to see if, a FileSystem/FileContext instance has a specific capability under the given path.

Classes in org.apache.hadoop.fs used by org.apache.hadoop.fs.impl

Class	Description
AbstractFileSystem	This class provides an interface for implementors of a Hadoop file system (analogous to the VFS of Unix).
BulkDelete	API for bulk deletion of objects/files, but not directories.
CreateFlag	CreateFlag specifies the file create semantic.
FileContext	The FileContext class provides an interface for users of the Hadoop file system.
FileRange	A byte range of a file.
FileStatus	Interface that represents the client side information for a file.
FileSystem	An abstract base class for a fairly generic filesystem.
FSBuilder	The base interface which various FileSystem FileContext Builder interfaces can extend, and which underlying implementations will then implement.
FSLinkResolver	Used primarily by FileContext to operate on and resolve symlinks in a path.
FutureDataInputStreamBuilder	Builder for input streams and subclasses whose return value is actually a completable future: this allows for better asynchronous operation.
MultipartUploader	MultipartUploader is an interface for copying files multipart and across multiple nodes.
MultipartUploaderBuilder	Builder interface for Multipart readers.
Options.ChecksumOpt	This is used in FileSystem and FileContext to specify checksum options.
PartHandle	Opaque, serializable reference to a part id for multipart uploads.
Path	Names a file or directory in a FileSystem.
PathHandle	Opaque, serializable reference to an entity in the FileSystem.
StreamCapabilities	Interface to query streams for supported capabilities.
UnresolvedLinkException	Thrown when a symbolic link is encountered in a path.
UploadHandle	Opaque, serializable reference to an uploadId for multipart uploads.

Classes in org.apache.hadoop.fs used by org.apache.hadoop.fs.impl.prefetch

Class	Description
LocalDirAllocator	An implementation of a round-robin scheme for disk allocation for creating files.

Classes in org.apache.hadoop.fs used by org.apache.hadoop.fs.local

Class	Description
AbstractFileSystem	This class provides an interface for implementors of a Hadoop file system (analogous to the VFS of Unix).
ChecksumFs	Abstract Checksumed Fs.
CommonConfigurationKeys	This class contains constants for configuration keys used in the common code.
CommonConfigurationKeysPublic	This class contains constants for configuration keys used in the common code.
DelegateToFileSystem	Implementation of AbstractFileSystem based on the existing implementation of FileSystem.
FilterFs	A FilterFs contains some other file system, which it uses as its basic file system, possibly transforming the data along the way or providing additional functionality.
FsServerDefaults	Provides server default configuration values to clients.
Path	Names a file or directory in a FileSystem.
PathCapabilities	The Path counterpoint to StreamCapabilities; a query to see if, a FileSystem/FileContext instance has a specific capability under the given path.

Classes in org.apache.hadoop.fs used by org.apache.hadoop.fs.permission

Class	Description
FileStatus	Interface that represents the client side information for a file.

Classes in org.apache.hadoop.fs used by org.apache.hadoop.fs.protocolPB

Class	Description
FileStatus	Interface that represents the client side information for a file.
FSProtos.FileStatusProto	FileStatus encoding.
FSProtos.FsPermissionProto	Protobuf type hadoop.fs.FsPermissionProto

Classes in org.apache.hadoop.fs used by org.apache.hadoop.fs.sftp

Class	Description
BulkDeleteSource	Interface for bulk deletion.
FileStatus	Interface that represents the client side information for a file.
FileSystem	An abstract base class for a fairly generic filesystem.
FSDataInputStream	Utility that wraps a FSInputStream in a DataInputStream and buffers input through a BufferedInputStream.
FSDataOutputStream	Utility that wraps a OutputStream in a DataOutputStream.
Path	Names a file or directory in a FileSystem.
PathCapabilities	The Path counterpoint to StreamCapabilities; a query to see if, a FileSystem/FileContext instance has a specific capability under the given path.

Classes in org.apache.hadoop.fs used by org.apache.hadoop.fs.shell

Class	Description
FileStatus	Interface that represents the client side information for a file.
FileSystem	An abstract base class for a fairly generic filesystem.
FSDataInputStream	Utility that wraps a FSInputStream in a DataInputStream and buffers input through a BufferedInputStream.
Path	Names a file or directory in a FileSystem.
RemoteIterator	An iterator over a collection whose elements need to be fetched remotely

Classes in org.apache.hadoop.fs used by org.apache.hadoop.fs.shell.find

Class	Description
FileStatus	Interface that represents the client side information for a file.
FileSystem	An abstract base class for a fairly generic filesystem.
Path	Names a file or directory in a FileSystem.

Classes in org.apache.hadoop.fs used by org.apache.hadoop.fs.statistics

Class	Description
StreamCapabilities	Interface to query streams for supported capabilities.
Syncable	This is the interface for flush/sync operations.

Classes in org.apache.hadoop.fs used by org.apache.hadoop.fs.statistics.impl

Class	Description
StorageStatistics	StorageStatistics contains statistics data for a FileSystem or FileContext instance.
StorageStatistics.LongStatistic	A 64-bit storage statistic.

Classes in org.apache.hadoop.fs used by org.apache.hadoop.fs.store

Class	Description
FileChecksum	An abstract class representing file checksums for files.

Classes in org.apache.hadoop.fs used by org.apache.hadoop.fs.viewfs

Class	Description
AbstractFileSystem	This class provides an interface for implementors of a Hadoop file system (analogous to the VFS of Unix).
BlockLocation	Represents the network location of a block, information about the hosts that contain block replicas, and other block metadata (E.g. the file offset associated with the block, length, whether it is corrupt, etc).
BlockStoragePolicySpi	A storage policy specifies the placement of block replicas on specific storage types.
BulkDeleteSource	Interface for bulk deletion.
ContentSummary	Store the summary of a content (a directory or a file).
CreateFlag	CreateFlag specifies the file create semantic.
FileAlreadyExistsException	Used when target file already exists for any operation and is not configured to be overwritten.
FileChecksum	An abstract class representing file checksums for files.
FileStatus	Interface that represents the client side information for a file.
FileSystem	An abstract base class for a fairly generic filesystem.
FSDataInputStream	Utility that wraps a FSInputStream in a DataInputStream and buffers input through a BufferedInputStream.
FSDataOutputStream	Utility that wraps a OutputStream in a DataOutputStream.
FsServerDefaults	Provides server default configuration values to clients.
FsStatus	This class is used to represent the capacity, free and used space on a FileSystem.
LocatedFileStatus	This class defines a FileStatus that includes a file's block locations.
Options.ChecksumOpt	This is used in FileSystem and FileContext to specify checksum options.
ParentNotDirectoryException	Indicates that the parent of specified Path is not a directory as expected.
Path	Names a file or directory in a FileSystem.
PathCapabilities	The Path counterpoint to StreamCapabilities; a query to see if, a FileSystem/FileContext instance has a specific capability under the given path.
PathFilter
QuotaUsage	Store the quota usage of a directory.
RemoteIterator	An iterator over a collection whose elements need to be fetched remotely
UnresolvedLinkException	Thrown when a symbolic link is encountered in a path.
UnsupportedFileSystemException	File system for a given file system name/scheme is not supported
XAttrSetFlag

Classes in org.apache.hadoop.fs used by org.apache.hadoop.io

Class	Description
CreateFlag	CreateFlag specifies the file create semantic.
FileContext	The FileContext class provides an interface for users of the Hadoop file system.
FileSystem	An abstract base class for a fairly generic filesystem.
FSDataInputStream	Utility that wraps a FSInputStream in a DataInputStream and buffers input through a BufferedInputStream.
FSDataOutputStream	Utility that wraps a OutputStream in a DataOutputStream.
Options.CreateOpts	Class to support the varargs for create() options.
Path	Names a file or directory in a FileSystem.
StreamCapabilities	Interface to query streams for supported capabilities.
Syncable	This is the interface for flush/sync operations.

Classes in org.apache.hadoop.fs used by org.apache.hadoop.io.compress

Class	Description
Path	Names a file or directory in a FileSystem.
Seekable	Stream that permits seeking.

Classes in org.apache.hadoop.fs used by org.apache.hadoop.io.file.tfile

Class	Description
FSDataInputStream	Utility that wraps a FSInputStream in a DataInputStream and buffers input through a BufferedInputStream.
FSDataOutputStream	Utility that wraps a OutputStream in a DataOutputStream.

Classes in org.apache.hadoop.fs used by org.apache.hadoop.io.wrappedio

Class	Description
FileStatus	Interface that represents the client side information for a file.
FileSystem	An abstract base class for a fairly generic filesystem.
FSDataInputStream	Utility that wraps a FSInputStream in a DataInputStream and buffers input through a BufferedInputStream.
Path	Names a file or directory in a FileSystem.

Classes in org.apache.hadoop.fs used by org.apache.hadoop.io.wrappedio.impl

Class	Description
FileStatus	Interface that represents the client side information for a file.
FileSystem	An abstract base class for a fairly generic filesystem.
FSDataInputStream	Utility that wraps a FSInputStream in a DataInputStream and buffers input through a BufferedInputStream.
Path	Names a file or directory in a FileSystem.

Classes in org.apache.hadoop.fs used by org.apache.hadoop.metrics2.sink

Class	Description
FileSystem	An abstract base class for a fairly generic filesystem.
Path	Names a file or directory in a FileSystem.

Classes in org.apache.hadoop.fs used by org.apache.hadoop.security

Class	Description
FileSystem	An abstract base class for a fairly generic filesystem.
Path	Names a file or directory in a FileSystem.

Classes in org.apache.hadoop.fs used by org.apache.hadoop.security.alias

Class	Description
Path	Names a file or directory in a FileSystem.

Classes in org.apache.hadoop.fs used by org.apache.hadoop.util

Class	Description
ChecksumException	Thrown for checksum errors.
FileStatus	Interface that represents the client side information for a file.
FileSystem	An abstract base class for a fairly generic filesystem.
FSDataInputStream	Utility that wraps a FSInputStream in a DataInputStream and buffers input through a BufferedInputStream.
FSDataOutputStream	Utility that wraps a OutputStream in a DataOutputStream.
LocalFileSystem	Implement the FileSystem API for the checksumed local filesystem.
Path	Names a file or directory in a FileSystem.

Classes in org.apache.hadoop.fs used by org.apache.hadoop.util.functional

Class	Description
FSBuilder	The base interface which various FileSystem FileContext Builder interfaces can extend, and which underlying implementations will then implement.
RemoteIterator	An iterator over a collection whose elements need to be fetched remotely