Package org.apache.hadoop.fs

package org.apache.hadoop.fs

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

  • Class
    Description
    Abortable
    Abort data being written to a stream, so that close() does not write the data.
    org.apache.hadoop.fs.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).
    AvroFSInput
    Adapts an FSDataInputStream to Avro's SeekableInput interface.
    org.apache.hadoop.fs.BatchedRemoteIterator<K,E>
    A RemoteIterator that fetches elements in batches.
    org.apache.hadoop.fs.BatchedRemoteIterator.BatchedEntries<E>
     
    org.apache.hadoop.fs.BatchedRemoteIterator.BatchedListEntries<E>
     
    BatchListingOperations
    Interface filesystems MAY implement to offer a batched list.
    org.apache.hadoop.fs.BBPartHandle
    Byte array backed part handle.
    org.apache.hadoop.fs.BBUploadHandle
    Byte array backed upload handle.
    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.
    org.apache.hadoop.fs.BufferedFSInputStream
    A class that optimizes reading from FSInputStream by buffering.
    BulkDelete
    API for bulk deletion of objects/files, but not directories.
    BulkDeleteSource
    Interface for bulk deletion.
    org.apache.hadoop.fs.BulkDeleteUtils
    Utility class for bulk delete operations.
    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[].
    org.apache.hadoop.fs.ByteBufferUtil
     
    CacheFlag
    Specifies semantics for CacheDirective operations.
    org.apache.hadoop.fs.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.
    ChecksumException
    Thrown for checksum errors.
    ChecksumFileSystem
    Abstract Checksumed FileSystem.
    org.apache.hadoop.fs.ChecksumFs
    Abstract Checksumed Fs.
    ClosedIOException
    Exception to denote if the underlying stream, cache or other closable resource is closed.
    ClusterStorageCapacityExceededException
    Exception raised by HDFS indicating that storage capacity in the cluster filesystem is exceeded.
    org.apache.hadoop.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.
    org.apache.hadoop.fs.CommonPathCapabilities
    Common path capabilities.
    org.apache.hadoop.fs.CompositeCrcFileChecksum
    Composite CRC.
    ContentSummary
    Store the summary of a content (a directory or a file).
    org.apache.hadoop.fs.ContentSummary.Builder
    We don't use generics.
    CreateFlag
    CreateFlag specifies the file create semantic.
    org.apache.hadoop.fs.DelegateToFileSystem
    Implementation of AbstractFileSystem based on the existing implementation of FileSystem.
    org.apache.hadoop.fs.DelegationTokenRenewer
    A daemon thread that waits for the next file system to renew.
    org.apache.hadoop.fs.DelegationTokenRenewer.Renewable
    The renewable interface used by the renewer.
    org.apache.hadoop.fs.DelegationTokenRenewer.RenewAction<T extends FileSystem & org.apache.hadoop.fs.DelegationTokenRenewer.Renewable>
    An action that will renew and replace the file system's delegation tokens automatically.
    org.apache.hadoop.fs.DF
    Filesystem disk space usage statistics.
    org.apache.hadoop.fs.DFCachingGetSpaceUsed
    Fast but inaccurate class to tell how much space HDFS is using.
    org.apache.hadoop.fs.DirectoryListingStartAfterNotFoundException
    Thrown when the startAfter can't be found when listing a directory.
    org.apache.hadoop.fs.DU
    Filesystem disk space usage statistics.
    org.apache.hadoop.fs.DUHelper
     
    org.apache.hadoop.fs.EtagSource
    An optional interface for FileStatus subclasses to implement to provide access to etags.
    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.
    org.apache.hadoop.fs.FileEncryptionInfo
    FileEncryptionInfo encapsulates all the encryption-related information for an encrypted file.
    org.apache.hadoop.fs.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.
    org.apache.hadoop.fs.FileSystem.DirectoryEntries
    Represents a batch of directory entries when iteratively listing a directory.
    org.apache.hadoop.fs.FileSystem.Statistics
    Tracks statistics about how many reads, writes, and so forth have been done in a FileSystem.
    org.apache.hadoop.fs.FileSystem.Statistics.StatisticsData
    Statistics data.
    org.apache.hadoop.fs.FileSystemLinkResolver<T>
    FileSystem-specific class used to operate on and resolve symlinks in a path.
    org.apache.hadoop.fs.FileSystemStorageStatistics
    A basic StorageStatistics instance which simply returns data from FileSystem#Statistics.
    FileUtil
    A collection of file-processing util methods
    org.apache.hadoop.fs.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.
    org.apache.hadoop.fs.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<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.
    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.
    FSError
    Thrown for unexpected filesystem errors, presumed to reflect disk errors in the native filesystem.
    org.apache.hadoop.fs.FSExceptionMessages
    Standard strings to use in exception messages in filesystems HDFS is used as the reference source of the strings
    org.apache.hadoop.fs.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.
    org.apache.hadoop.fs.FSLinkResolver<T>
    Used primarily by FileContext to operate on and resolve symlinks in a path.
    org.apache.hadoop.fs.FSOutputSummer
    This is a generic output stream for generating checksums for data before it is written to the underlying stream
    org.apache.hadoop.fs.FSProtos
     
    org.apache.hadoop.fs.FSProtos.FileStatusProto
    FileStatus encoding.
    org.apache.hadoop.fs.FSProtos.FileStatusProto.Builder
    FileStatus encoding.
    FSProtos.FileStatusProto.FileType
    Protobuf enum hadoop.fs.FileStatusProto.FileType
    FSProtos.FileStatusProto.Flags
    Protobuf enum hadoop.fs.FileStatusProto.Flags
    org.apache.hadoop.fs.FSProtos.FileStatusProtoOrBuilder
     
    org.apache.hadoop.fs.FSProtos.FsPermissionProto
    Protobuf type hadoop.fs.FsPermissionProto
    org.apache.hadoop.fs.FSProtos.FsPermissionProto.Builder
    Protobuf type hadoop.fs.FsPermissionProto
    org.apache.hadoop.fs.FSProtos.FsPermissionProtoOrBuilder
     
    org.apache.hadoop.fs.FSProtos.LocalFileSystemPathHandleProto
    Placeholder type for consistent basic FileSystem operations.
    org.apache.hadoop.fs.FSProtos.LocalFileSystemPathHandleProto.Builder
    Placeholder type for consistent basic FileSystem operations.
    org.apache.hadoop.fs.FSProtos.LocalFileSystemPathHandleProtoOrBuilder
     
    FsServerDefaults
    Provides server default configuration values to clients.
    org.apache.hadoop.fs.FsShell
    Provide command line access to a FileSystem.
    org.apache.hadoop.fs.FsShellPermissions
    This class is the home for file permissions related commands.
    org.apache.hadoop.fs.FsShellPermissions.Chgrp
    Used to change group of files
    org.apache.hadoop.fs.FsShellPermissions.Chmod
    The pattern is almost as flexible as mode allowed by chmod shell command.
    org.apache.hadoop.fs.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.
    org.apache.hadoop.fs.FsTracer
    Holds the HTrace Tracer used for FileSystem operations.
    org.apache.hadoop.fs.FsUrlStreamHandlerFactory
    Factory for URL stream handlers.
    FutureDataInputStreamBuilder
    Builder for input streams and subclasses whose return value is actually a completable future: this allows for better asynchronous operation.
    org.apache.hadoop.fs.GetSpaceUsed
     
    org.apache.hadoop.fs.GetSpaceUsed.Builder
    The builder class
    GlobalStorageStatistics
    Stores global storage statistics objects.
    org.apache.hadoop.fs.GlobalStorageStatistics.StorageStatisticsProvider
    A callback API for creating new StorageStatistics instances.
    org.apache.hadoop.fs.Globber
    Implementation of FileSystem.globStatus(Path, PathFilter).
    org.apache.hadoop.fs.Globber.GlobBuilder
    Builder for Globber instances.
    org.apache.hadoop.fs.GlobExpander
     
    GlobFilter
    A filter for POSIX glob pattern with brace expansions.
    org.apache.hadoop.fs.GlobPattern
    A class for POSIX glob pattern with brace expansions.
    org.apache.hadoop.fs.HardLink
    Class for creating hardlinks.
    org.apache.hadoop.fs.HardLink.LinkStats
    HardLink statistics counters and methods.
    org.apache.hadoop.fs.HarFileSystem
    This is an implementation of the Hadoop Archive Filesystem.
    org.apache.hadoop.fs.HarFs
     
    org.apache.hadoop.fs.HasEnhancedByteBufferAccess
    FSDataInputStreams implement this interface to provide enhanced byte buffer access.
    org.apache.hadoop.fs.HasFileDescriptor
    Having a FileDescriptor
    org.apache.hadoop.fs.Hdfs
     
    org.apache.hadoop.fs.HdfsBlockLocation
    Wrapper for BlockLocation that also includes a LocatedBlock, allowing more detailed queries to the datanode about a block.
    org.apache.hadoop.fs.InternalOperations
    This method allows access to Package-scoped operations from classes in org.apache.hadoop.fs.impl and other file system implementations in the hadoop modules.
    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.
    org.apache.hadoop.fs.InvalidRequestException
    Thrown when the user makes a malformed request, for example missing required parameters or parameters that are not valid.
    org.apache.hadoop.fs.LeaseRecoverable
    Whether the given Path of the FileSystem has the capability to perform lease recovery.
    org.apache.hadoop.fs.LocalDirAllocator
    An implementation of a round-robin scheme for disk allocation for creating files.
    LocalFileSystem
    Implement the FileSystem API for the checksumed local filesystem.
    org.apache.hadoop.fs.LocalFileSystemConfigKeys
    This class contains constants for configuration keys used in the local file system, raw local fs and checksum fs.
    org.apache.hadoop.fs.LocalFileSystemPathHandle
    Opaque handle to an entity in a FileSystem.
    LocatedFileStatus
    This class defines a FileStatus that includes a file's block locations.
    org.apache.hadoop.fs.MD5MD5CRC32CastagnoliFileChecksum
    For CRC32 with the Castagnoli polynomial
    org.apache.hadoop.fs.MD5MD5CRC32FileChecksum
    MD5 of MD5 of CRC32.
    org.apache.hadoop.fs.MD5MD5CRC32GzipFileChecksum
    For CRC32 with the Gzip polynomial
    MultipartUploader
    MultipartUploader is an interface for copying files multipart and across multiple nodes.
    org.apache.hadoop.fs.MultipartUploaderBuilder<S extends MultipartUploader,B extends org.apache.hadoop.fs.MultipartUploaderBuilder<S,B>>
    Builder interface for Multipart readers.
    Options
    This class contains options related to file system operations.
    Options.ChecksumCombineMode
    Enum for indicating what mode to use when combining chunk and block checksums to define an aggregate FileChecksum.
    org.apache.hadoop.fs.Options.ChecksumOpt
    This is used in FileSystem and FileContext to specify checksum options.
    Options.CreateFileOptionKeys
    The standard createFile() options.
    org.apache.hadoop.fs.Options.CreateOpts
    Class to support the varargs for create() options.
    org.apache.hadoop.fs.Options.CreateOpts.BlockSize
     
    org.apache.hadoop.fs.Options.CreateOpts.BufferSize
     
    org.apache.hadoop.fs.Options.CreateOpts.BytesPerChecksum
    This is not needed if ChecksumParam is specified.
    org.apache.hadoop.fs.Options.CreateOpts.ChecksumParam
     
    org.apache.hadoop.fs.Options.CreateOpts.CreateParent
     
    org.apache.hadoop.fs.Options.CreateOpts.Perms
     
    org.apache.hadoop.fs.Options.CreateOpts.Progress
     
    org.apache.hadoop.fs.Options.CreateOpts.ReplicationFactor
     
    org.apache.hadoop.fs.Options.HandleOpt
    Options for creating PathHandle references.
    org.apache.hadoop.fs.Options.HandleOpt.Data
    Option storing standard constraints on data.
    org.apache.hadoop.fs.Options.HandleOpt.Location
    Option storing standard constraints on location.
    Options.OpenFileOptions
    The standard openFile() options.
    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<T extends FileStatus>
    A partial listing of the children of a parent directory.
    Path
    Names a file or directory in a FileSystem.
    org.apache.hadoop.fs.PathAccessDeniedException
    EACCES
    org.apache.hadoop.fs.PathCapabilities
    The Path counterpoint to StreamCapabilities; a query to see if, a FileSystem/FileContext instance has a specific capability under the given path.
    org.apache.hadoop.fs.PathExistsException
    Exception corresponding to File Exists - EEXISTS
    PathFilter
     
    PathHandle
    Opaque, serializable reference to an entity in the FileSystem.
    org.apache.hadoop.fs.PathIOException
    Exceptions based on standard posix/linux style exceptions for path related errors.
    org.apache.hadoop.fs.PathIsDirectoryException
    EISDIR
    org.apache.hadoop.fs.PathIsNotDirectoryException
    ENOTDIR
    org.apache.hadoop.fs.PathIsNotEmptyDirectoryException
    Generated by rm commands
    org.apache.hadoop.fs.PathNotFoundException
    Exception corresponding to path not found: ENOENT/ENOFILE
    org.apache.hadoop.fs.PathOperationException
    ENOTSUP
    org.apache.hadoop.fs.PathPermissionException
    Exception corresponding to Operation Not Permitted - EPERM
    PositionedReadable
    Stream that permits positional reading.
    QuotaUsage
    Store the quota usage of a directory.
    org.apache.hadoop.fs.QuotaUsage.Builder
    Builder class for QuotaUsage.
    RawLocalFileSystem
    Implement the FileSystem API for the raw local filesystem.
    org.apache.hadoop.fs.RawPathHandle
    Generic format of FileStatus objects.
    ReadOption
    Options that can be used when reading from a FileSystem.
    org.apache.hadoop.fs.RemoteIterator<E>
    An iterator over a collection whose elements need to be fetched remotely
    org.apache.hadoop.fs.SafeMode
    Whether the given filesystem is in any status of safe mode.
    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.
    org.apache.hadoop.fs.Stat
    Wrapper for the Unix stat(1) command.
    StorageStatistics
    StorageStatistics contains statistics data for a FileSystem or FileContext instance.
    org.apache.hadoop.fs.StorageStatistics.CommonStatisticNames
    These are common statistic names.
    org.apache.hadoop.fs.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.
    StreamCapabilitiesPolicy
    Static methods to implement policies for StreamCapabilities.
    SWebHdfs
    AbstractFileSystem implementation for HDFS over the web (secure).
    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.
    org.apache.hadoop.fs.TrashPolicyDefault
    Provides a trash feature.
    org.apache.hadoop.fs.UnionStorageStatistics
    A StorageStatistics instance which combines the outputs of several other StorageStatistics instances.
    org.apache.hadoop.fs.UnresolvedLinkException
    Thrown when a symbolic link is encountered in a path.
    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.
    UploadHandle
    Opaque, serializable reference to an uploadId for multipart uploads.
    org.apache.hadoop.fs.VectoredReadUtils
    Utility class which implements helper methods used in vectored IO implementation.
    WebHdfs
    AbstractFileSystem implementation for HDFS over the web.
    org.apache.hadoop.fs.WindowsGetSpaceUsed
    Class to tell the size of a path on windows.
    org.apache.hadoop.fs.WithErasureCoding
    Filesystems that support EC can implement this interface.
    org.apache.hadoop.fs.XAttr
    XAttr is the POSIX Extended Attribute model similar to that found in traditional Operating Systems.
    org.apache.hadoop.fs.XAttr.Builder
     
    XAttr.NameSpace
     
    XAttrCodec
    The value of XAttr is byte[], this class is to covert byte[] to some kind of string representation or convert back.
    XAttrSetFlag
     
    org.apache.hadoop.fs.ZeroCopyUnavailableException