Package org.apache.hadoop.fs

Implementations of AbstractFileSystem for hdfs over rpc and hdfs over web.

See: Description

Interface Summary

Interface	Description
Abortable	Abort data being written to a stream, so that close() does not write the data.
BatchListingOperations	Interface filesystems MAY implement to offer a batched list.
BlockStoragePolicySpi	A storage policy specifies the placement of block replicas on specific storage types.
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.
FSBuilder<S,B extends FSBuilder<S,B>>	The base interface which various FileSystem FileContext Builder interfaces can extend, and which underlying implementations will then implement.
FsConstants	FileSystem related constants.
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.
PartHandle	Opaque, serializable reference to a part id for multipart uploads.
PathFilter
PathHandle	Opaque, serializable reference to an entity in the FileSystem.
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.
UploadHandle	Opaque, serializable reference to an uploadId for multipart uploads.

Class Summary

Class	Description
AbstractFileSystem	This class provides an interface for implementors of a Hadoop file system (analogous to the VFS of Unix).
AvroFSInput	Adapts an FSDataInputStream to Avro's SeekableInput interface.
BlockLocation	Represents the network location of a block, information about the hosts that contain block replicas, and other block metadata (E.g.
ChecksumFileSystem	Abstract Checksumed FileSystem.
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).
FileChecksum	An abstract class representing file checksums for files.
FileContext	The FileContext class provides an interface for users of the Hadoop file system.
FileStatus	Interface that represents the client side information for a file.
FileSystem	An abstract base class for a fairly generic filesystem.
FileUtil	A collection of file-processing util methods
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.
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<S extends FSDataOutputStream,B extends FSDataOutputStreamBuilder<S,B>>	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.
FsStatus	This class is used to represent the capacity, free and used space on a FileSystem.
GlobFilter	A filter for POSIX glob pattern with brace expansions.
LocalFileSystem	Implement the FileSystem API for the checksumed local filesystem.
LocatedFileStatus	This class defines a FileStatus that includes a file's block locations.
Options	This class contains options related to file system operations.
Options.OpenFileOptions	The standard openFile() options.
PartialListing<T extends FileStatus>	A partial listing of the children of a parent directory.
Path	Names a file or directory in a FileSystem.
QuotaUsage	Store the quota usage of a directory.
RawLocalFileSystem	Implement the FileSystem API for the raw local filesystem.
StorageStatistics	StorageStatistics contains statistics data for a FileSystem or FileContext instance.
StreamCapabilitiesPolicy	Static methods to implement policies for StreamCapabilities.
SWebHdfs	AbstractFileSystem implementation for HDFS over the web (secure).
Trash	Provides a trash facility which supports pluggable Trash policies.
TrashPolicy	This interface is used for implementing different Trash policies.
WebHdfs	AbstractFileSystem implementation for HDFS over the web.

Enum Summary

Enum	Description
CacheFlag	Specifies semantics for CacheDirective operations.
CreateFlag	CreateFlag specifies the file create semantic.
GlobalStorageStatistics	Stores global storage statistics objects.
ReadOption	Options that can be used when reading from a FileSystem.
StorageType	Defines the types of supported storage media.
XAttrCodec	The value of XAttr is byte[], this class is to covert byte[] to some kind of string representation or convert back.
XAttrSetFlag

Exception Summary

Exception	Description
ChecksumException	Thrown for checksum errors.
ClusterStorageCapacityExceededException	Exception raised by HDFS indicating that storage capacity in the cluster filesystem is exceeded.
FileAlreadyExistsException	Used when target file already exists for any operation and is not configured to be overwritten.
InvalidPathException	Path string is invalid either because it has invalid characters or due to other file system specific reasons.
InvalidPathHandleException	Thrown when the constraints enoded in a PathHandle do not hold.
ParentNotDirectoryException	Indicates that the parent of specified Path is not a directory as expected.
UnsupportedFileSystemException	File system for a given file system name/scheme is not supported
UnsupportedMultipartUploaderException	MultipartUploader for a given file system name/scheme is not supported.

Error Summary

Error	Description
FSError	Thrown for unexpected filesystem errors, presumed to reflect disk errors in the native filesystem.

Package org.apache.hadoop.fs Description

Implementations of AbstractFileSystem for hdfs over rpc and hdfs over web.