org.apache.hadoop.fs (Apache Hadoop Common 3.5.0 API)
Description: declaration: package: org.apache.hadoop.fs

# Package org.apache.hadoop.fs

package org.apache.hadoop.fs
An abstract file system API.

- Related Packages
  Package
  Description
  org.apache.hadoop
  org.apache.hadoop.fs.audit
  Public classes for adding information to any auditing information picked up by filesystem clients.
  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.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.statistics
  This package contains support for statistic collection and reporting.
  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.
- 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).
  AvroFSInput
  Adapts an `FSDataInputStream` to Avro's SeekableInput interface.
  BatchedRemoteIterator<K,E>
  A RemoteIterator that fetches elements in batches.
  BatchedRemoteIterator.BatchedEntries<E>
  BatchedRemoteIterator.BatchedListEntries<E>
  BatchListingOperations
  Interface filesystems MAY implement to offer a batched list.
  BBPartHandle
  Byte array backed part handle.
  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.
  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.
  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[].
  ByteBufferUtil
  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.
  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.
  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.
  CommonPathCapabilities
  Common path capabilities.
  CompositeCrcFileChecksum
  Composite CRC.
  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<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.
  DFCachingGetSpaceUsed
  Fast but inaccurate class to tell how much space HDFS is using.
  DirectoryListingStartAfterNotFoundException
  Thrown when the startAfter can't be found when listing a directory.
  DU
  Filesystem disk space usage statistics.
  DUHelper
  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.
  FileEncryptionInfo
  FileEncryptionInfo encapsulates all the encryption-related information for an encrypted file.
  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.
  FileSystemLinkResolver<T>
  FileSystem-specific class used to operate on and resolve symlinks in a path.
  FileSystemStorageStatistics
  A basic StorageStatistics instance which simply returns data from FileSystem#Statistics.
  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.
  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.
  FSExceptionMessages
  Standard strings to use in exception messages in filesystems HDFS is used as the reference source of the strings
  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`.
  FsTracer
  Holds the HTrace Tracer used for FileSystem operations.
  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.
  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.
  GlobExpander
  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.
  HarFs
  HasEnhancedByteBufferAccess
  FSDataInputStreams implement this interface to provide enhanced byte buffer access.
  HasFileDescriptor
  Having a FileDescriptor
  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.
  InvalidRequestException
  Thrown when the user makes a malformed request, for example missing required parameters or parameters that are not valid.
  LeaseRecoverable
  Whether the given Path of the FileSystem has the capability to perform lease recovery.
  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.
  LocalFileSystemPathHandle
  Opaque handle to an entity in a FileSystem.
  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
  MultipartUploader
  MultipartUploader is an interface for copying files multipart and across multiple nodes.
  MultipartUploaderBuilder<S extends MultipartUploader,B extends 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.
  Options.ChecksumOpt
  This is used in FileSystem and FileContext to specify checksum options.
  Options.CreateFileOptionKeys
  The standard `createFile()` 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.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`.
  PathAccessDeniedException
  EACCES
  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.
  PathIsDirectoryException
  EISDIR
  PathIsNotDirectoryException
  ENOTDIR
  PathIsNotEmptyDirectoryException
  Generated by rm commands
  PathNotFoundException
  Exception corresponding to path not found: ENOENT/ENOFILE
  PathOperationException
  ENOTSUP
  PathPermissionException
  Exception corresponding to Operation Not Permitted - EPERM
  PositionedReadable
  Stream that permits positional reading.
  QuotaUsage
  Store the quota usage of a directory.
  QuotaUsage.Builder
  Builder class for QuotaUsage.
  RawLocalFileSystem
  Implement the FileSystem API for the raw local filesystem.
  RawPathHandle
  Generic format of FileStatus objects.
  ReadOption
  Options that can be used when reading from a FileSystem.
  RemoteIterator<E>
  An iterator over a collection whose elements need to be fetched remotely
  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.
  Stat
  Wrapper for the Unix stat(1) command.
  StorageStatistics
  StorageStatistics contains statistics data for a FileSystem or FileContext instance.
  StorageStatistics.CommonStatisticNames
  These are common statistic names.
  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`.
  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.
  TrashPolicyDefault
  Provides a trash feature.
  UnionStorageStatistics
  A StorageStatistics instance which combines the outputs of several other StorageStatistics instances.
  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.
  VectoredReadUtils
  Utility class which implements helper methods used in vectored IO implementation.
  WindowsGetSpaceUsed
  Class to tell the size of a path on windows.
  WithErasureCoding
  Filesystems that support EC can implement this interface.
  XAttrCodec
  The value of `XAttr` is byte[], this class is to covert byte[] to some kind of string representation or convert back.
  XAttrSetFlag
  ZeroCopyUnavailableException