Package org.apache.hadoop.fs

An abstract file system API.

See: Description

Interface Summary

Interface	Description
ByteBufferReadable	Implementers of this interface provide a read API that writes to a ByteBuffer, not a byte[].
CanSetDropBehind
CanSetReadahead
DelegationTokenRenewer.Renewable	The renewable interface used by the renewer.
FsConstants	FileSystem related constants.
HasFileDescriptor	Having a FileDescriptor
PathFilter
PositionedReadable	Stream that permits positional reading.
RemoteIterator<E>	An iterator over a collection whose elements need to be fetched remotely
Seekable	Stream that permits seeking.
Syncable	This interface for flush/sync operation.
VolumeId	Opaque interface that identifies a disk location.

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.
BlockStorageLocation	Wrapper for BlockLocation that also adds VolumeId volume location information for each replica.
BufferedFSInputStream	A class optimizes reading from FSInputStream by bufferring
ChecksumFileSystem	Abstract Checksumed FileSystem.
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.
ContentSummary	Store the summary of a content (a directory or a file).
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.RenewAction<T extends FileSystem & DelegationTokenRenewer.Renewable>	An action that will renew and replace the file system's delegation tokens automatically.
DF	Filesystem disk space usage statistics.
DU	Filesystem disk space usage statistics.
DUHelper
FileChecksum	An abstract class representing file checksums for files.
FileContext	The FileContext class provides an interface to the application writer for using 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.
FileSystem.Statistics
FileSystemLinkResolver<T>	FileSystem-specific class used to operate on and resolve symlinks in a path.
FileUtil	A collection of file-processing util methods
FileUtil.HardLink	Deprecated Use HardLink
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.
FSDataInputStream	Utility that wraps a FSInputStream in a DataInputStream and buffers input through a BufferedInputStream.
FSDataOutputStream	Utility that wraps a OutputStream in a DataOutputStream, buffers output through a BufferedOutputStream and creates a checksum file.
FSInputChecker	This is a generic input stream for verifying checksums for data before it is read by a user.
FSInputStream	FSInputStream is a generic old InputStream with a little bit of RAF-style seek ability.
FSLinkResolver<T>	Used primarily by FileContext to operate on and resolve symlinks in a path.
FSOutputSummer	This is a generic output stream for generating checksums for data before it is written to the underlying stream
FsServerDefaults	Provides server default configuration values to clients.
FsShell	Provide command line access to a FileSystem.
FsShellPermissions	This class is the home for file permissions related commands.
FsShellPermissions.Chgrp	Used to change group of files
FsShellPermissions.Chmod	The pattern is almost as flexible as mode allowed by chmod shell command.
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.
FsUrlStreamHandlerFactory	Factory for URL stream handlers.
GlobFilter	A filter for POSIX glob pattern with brace expansions.
GlobPattern	A class for POSIX glob pattern with brace expansions.
HardLink	Class for creating hardlinks.
HardLink.LinkStats	HardLink statistics counters and methods.
HarFileSystem	This is an implementation of the Hadoop Archive Filesystem.
Hdfs
HdfsBlockLocation	Wrapper for BlockLocation that also includes a LocatedBlock, allowing more detailed queries to the datanode about a block.
HdfsVolumeId	HDFS-specific volume identifier which implements VolumeId.
LocalDirAllocator	An implementation of a round-robin scheme for disk allocation for creating files.
LocalFileSystem	Implement the FileSystem API for the checksumed local filesystem.
LocalFileSystemConfigKeys	This class contains constants for configuration keys used in the local file system, raw local fs and checksum fs.
LocatedFileStatus	This class defines a FileStatus that includes a file's block locations.
MD5MD5CRC32CastagnoliFileChecksum	For CRC32 with the Castagnoli polynomial
MD5MD5CRC32FileChecksum	MD5 of MD5 of CRC32.
MD5MD5CRC32GzipFileChecksum	For CRC32 with the Gzip polynomial
Options	This class contains options related to file system operations.
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
Path	Names a file or directory in a FileSystem.
RawLocalFileSystem	Implement the FileSystem API for the raw local filesystem.
Trash	Provides a trash facility which supports pluggable Trash policies.
TrashPolicy	This interface is used for implementing different Trash policies.
TrashPolicyDefault	Provides a trash feature.

Enum Summary

Enum	Description
CreateFlag	CreateFlag specifies the file create semantic.
HardLink.OSType
Options.Rename	Enum to support the varargs for rename() options

Exception Summary

Exception	Description
ChecksumException	Thrown for checksum errors.
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.
ParentNotDirectoryException	Indicates that the parent of specified Path is not a directory as expected.
PathAccessDeniedException	EACCES
PathExistsException	Exception corresponding to File Exists - EEXISTS
PathIOException	Exceptions based on standard posix/linux style exceptions for path related errors.
PathIsDirectoryException	EISDIR
PathIsNotDirectoryException	ENOTDIR
PathIsNotEmptyDirectoryException	Generated by rm commands
PathNotFoundException	Exception corresponding to Permission denied - ENOENT
PathOperationException	ENOTSUP
PathPermissionException	Exception corresponding to Operation Not Permitted - EPERM
UnresolvedLinkException	Thrown when a symbolic link is encountered in a path.
UnsupportedFileSystemException	File system 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

An abstract file system API.