Package org.apache.hadoop.fs

Class FilterFs

java.lang.Object

org.apache.hadoop.fs.AbstractFileSystem

org.apache.hadoop.fs.FilterFs

All Implemented Interfaces:

PathCapabilities

Direct Known Subclasses:

ChecksumFs

@Private
@Evolving
public abstract class FilterFs
extends AbstractFileSystem

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. The class FilterFs itself simply overrides all methods of AbstractFileSystem with versions that pass all requests to the contained file system. Subclasses of FilterFs may further override some of these methods and may also provide additional methods and fields.

Field Summary

Fields inherited from class org.apache.hadoop.fs.AbstractFileSystem

statistics

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FilterFs(AbstractFileSystem fs)

Method Summary

Modifier and Type	Method	Description
void	access(Path path, FsAction mode)	The specification of this method matches that of FileContext.access(Path, FsAction) except that an UnresolvedLinkException may be thrown if a symlink is encountered in the path.
void	checkPath(Path path)	Check that a Path belongs to this FileSystem.
FSDataOutputStream	createInternal(Path f, EnumSet<CreateFlag> flag, FsPermission absolutePermission, int bufferSize, short replication, long blockSize, Progressable progress, Options.ChecksumOpt checksumOpt, boolean createParent)	The specification of this method matches that of AbstractFileSystem.create(Path, EnumSet, Options.CreateOpts...) except that the opts have been declared explicitly.
MultipartUploaderBuilder	createMultipartUploader(Path basePath)	Create a multipart uploader.
Path	createSnapshot(Path path, String snapshotName)	The specification of this method matches that of FileContext.createSnapshot(Path, String).
void	createSymlink(Path target, Path link, boolean createParent)	The specification of this method matches that of FileContext.createSymlink(Path, Path, boolean);
boolean	delete(Path f, boolean recursive)	The specification of this method matches that of FileContext.delete(Path, boolean) except that Path f must be for this file system.
void	deleteSnapshot(Path path, String snapshotName)	The specification of this method matches that of FileContext.deleteSnapshot(Path, String).
AclStatus	getAclStatus(Path path)	Gets the ACLs of files and directories.
Collection<? extends BlockStoragePolicySpi>	getAllStoragePolicies()	Retrieve all the storage policies supported by this file system.
String	getCanonicalServiceName()	Get a canonical name for this file system.
List<Token<?>>	getDelegationTokens(String renewer)	Get one or more delegation tokens associated with the filesystem.
Path	getEnclosingRoot(Path path)	Return path of the enclosing root for a given path The enclosing root path is a common ancestor that should be used for temp and staging dirs as well as within encryption zones and other restricted directories.
BlockLocation[]	getFileBlockLocations(Path f, long start, long len)	The specification of this method matches that of FileContext.getFileBlockLocations(Path, long, long) except that Path f must be for this file system.
FileChecksum	getFileChecksum(Path f)	The specification of this method matches that of FileContext.getFileChecksum(Path) except that Path f must be for this file system.
FileStatus	getFileLinkStatus(Path f)	The specification of this method matches that of FileContext.getFileLinkStatus(Path) except that an UnresolvedLinkException may be thrown if a symlink is encountered in the path leading up to the final path component.
FileStatus	getFileStatus(Path f)	The specification of this method matches that of FileContext.getFileStatus(Path) except that an UnresolvedLinkException may be thrown if a symlink is encountered in the path.
FsStatus	getFsStatus()	The specification of this method matches that of FileContext.getFsStatus(Path).
FsStatus	getFsStatus(Path f)	The specification of this method matches that of FileContext.getFsStatus(Path) except that Path f must be for this file system.
Path	getHomeDirectory()	Return the current user's home directory in this file system.
Path	getInitialWorkingDirectory()	Some file systems like LocalFileSystem have an initial workingDir that is used as the starting workingDir.
Path	getLinkTarget(Path f)	Partially resolves the path.
protected AbstractFileSystem	getMyFs()
FsServerDefaults	getServerDefaults()	Deprecated.
FsServerDefaults	getServerDefaults(Path f)	Return a set of server default configuration values based on path.
FileSystem.Statistics	getStatistics()
BlockStoragePolicySpi	getStoragePolicy(Path src)	Retrieve the storage policy for a given file or directory.
URI	getUri()	Returns a URI whose scheme and authority identify this FileSystem.
int	getUriDefaultPort()	The default port of this file system.
String	getUriPath(Path p)	Get the path-part of a pathname.
byte[]	getXAttr(Path path, String name)	Get an xattr for a file or directory.
Map<String,byte[]>	getXAttrs(Path path)	Get all of the xattrs for a file or directory.
Map<String,byte[]>	getXAttrs(Path path, List<String> names)	Get all of the xattrs for a file or directory.
boolean	hasPathCapability(Path path, String capability)	Probe for a specific capability under the given path.
boolean	isValidName(String src)	Returns true if the specified string is considered valid in the path part of a URI by this file system.
RemoteIterator<Path>	listCorruptFileBlocks(Path path)
RemoteIterator<LocatedFileStatus>	listLocatedStatus(Path f)	The specification of this method matches that of FileContext.listLocatedStatus(Path) except that Path f must be for this file system.
FileStatus[]	listStatus(Path f)	The specification of this method matches that of FileContext.Util.listStatus(Path) except that Path f must be for this file system.
List<String>	listXAttrs(Path path)	Get all of the xattr names for a file or directory.
Path	makeQualified(Path path)	Make the path fully qualified to this file system
void	mkdir(Path dir, FsPermission permission, boolean createParent)	The specification of this method matches that of FileContext.mkdir(Path, FsPermission, boolean) except that the Path f must be fully qualified and the permission is absolute (i.e.
void	modifyAclEntries(Path path, List<AclEntry> aclSpec)	Modifies ACL entries of files and directories.
void	msync()	Synchronize client metadata state.
FSDataInputStream	open(Path f)	The specification of this method matches that of FileContext.open(Path) except that Path f must be for this file system.
FSDataInputStream	open(Path f, int bufferSize)	The specification of this method matches that of FileContext.open(Path, int) except that Path f must be for this file system.
CompletableFuture<FSDataInputStream>	openFileWithOptions(Path path, OpenFileParameters parameters)	Open a file with the given set of options.
void	removeAcl(Path path)	Removes all but the base ACL entries of files and directories.
void	removeAclEntries(Path path, List<AclEntry> aclSpec)	Removes ACL entries from files and directories.
void	removeDefaultAcl(Path path)	Removes all default ACL entries from files and directories.
void	removeXAttr(Path path, String name)	Remove an xattr of a file or directory.
void	renameInternal(Path src, Path dst)	The specification of this method matches that of FileContext.rename(Path, Path, Options.Rename...) except that Path f must be for this file system and NO OVERWRITE is performed.
void	renameInternal(Path src, Path dst, boolean overwrite)	The specification of this method matches that of FileContext.rename(Path, Path, Options.Rename...) except that Path f must be for this file system.
void	renameSnapshot(Path path, String snapshotOldName, String snapshotNewName)	The specification of this method matches that of FileContext.renameSnapshot(Path, String, String).
Path	resolvePath(Path p)	Return the fully-qualified path of path f resolving the path through any internal symlinks or mount point
void	satisfyStoragePolicy(Path path)	Set the source path to satisfy storage policy.
void	setAcl(Path path, List<AclEntry> aclSpec)	Fully replaces ACL of files and directories, discarding all existing entries.
void	setOwner(Path f, String username, String groupname)	The specification of this method matches that of FileContext.setOwner(Path, String, String) except that Path f must be for this file system.
void	setPermission(Path f, FsPermission permission)	The specification of this method matches that of FileContext.setPermission(Path, FsPermission) except that Path f must be for this file system.
boolean	setReplication(Path f, short replication)	The specification of this method matches that of FileContext.setReplication(Path, short) except that Path f must be for this file system.
void	setStoragePolicy(Path path, String policyName)	Set the storage policy for a given file or directory.
void	setTimes(Path f, long mtime, long atime)	The specification of this method matches that of FileContext.setTimes(Path, long, long) except that Path f must be for this file system.
void	setVerifyChecksum(boolean verifyChecksum)	The specification of this method matches that of FileContext.setVerifyChecksum(boolean, Path) except that Path f must be for this file system.
void	setXAttr(Path path, String name, byte[] value)	Set an xattr of a file or directory.
void	setXAttr(Path path, String name, byte[] value, EnumSet<XAttrSetFlag> flag)	Set an xattr of a file or directory.
boolean	supportsSymlinks()	Returns true if the file system supports symlinks, false otherwise.
boolean	truncate(Path f, long newLength)	The specification of this method matches that of FileContext.truncate(Path, long) except that Path f must be for this file system.
void	unsetStoragePolicy(Path src)	Unset the storage policy set for a given file or directory.

Methods inherited from class org.apache.hadoop.fs.AbstractFileSystem

checkScheme, clearStatistics, create, createFileSystem, equals, get, getAllStatistics, getStatistics, hashCode, listStatusIterator, methodNotSupported, printStatistics, rename

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FilterFs

protected FilterFs(AbstractFileSystem fs)
            throws URISyntaxException

Throws:

URISyntaxException

Method Details

getMyFs

protected AbstractFileSystem getMyFs()

getStatistics

public FileSystem.Statistics getStatistics()

Overrides:

getStatistics in class AbstractFileSystem

makeQualified

public Path makeQualified(Path path)

Description copied from class: AbstractFileSystem

Make the path fully qualified to this file system

Overrides:

makeQualified in class AbstractFileSystem

Parameters:

path - the path.

Returns:

the qualified path

getInitialWorkingDirectory

public Path getInitialWorkingDirectory()

Description copied from class: AbstractFileSystem

Some file systems like LocalFileSystem have an initial workingDir that is used as the starting workingDir. For other file systems like HDFS there is no built in notion of an initial workingDir.

Overrides:

getInitialWorkingDirectory in class AbstractFileSystem

Returns:

the initial workingDir if the file system has such a notion otherwise return a null.

getHomeDirectory

public Path getHomeDirectory()

Description copied from class: AbstractFileSystem

Return the current user's home directory in this file system. The default implementation returns "/user/$USER/".

Overrides:

getHomeDirectory in class AbstractFileSystem

Returns:

current user's home directory.

createInternal

public FSDataOutputStream createInternal(Path f,
 EnumSet<CreateFlag> flag,
 FsPermission absolutePermission,
 int bufferSize,
 short replication,
 long blockSize,
 Progressable progress,
 Options.ChecksumOpt checksumOpt,
 boolean createParent)
                                  throws IOException,
UnresolvedLinkException

Description copied from class: AbstractFileSystem

The specification of this method matches that of AbstractFileSystem.create(Path, EnumSet, Options.CreateOpts...) except that the opts have been declared explicitly.

Specified by:

createInternal in class AbstractFileSystem

Parameters:

f - the path.

flag - create flag.

absolutePermission - absolute permission.

bufferSize - buffer size.

replication - replications.

blockSize - block size.

progress - progress.

checksumOpt - check sum opt.

createParent - create parent.

Returns:

output stream.

Throws:

AccessControlException - access control exception.

FileAlreadyExistsException - file already exists exception.

FileNotFoundException - file not found exception.

ParentNotDirectoryException - parent not directory exception.

UnsupportedFileSystemException - unsupported filesystem exception.

UnresolvedLinkException - unresolved link exception.

IOException - raised on errors performing I/O.

delete

public boolean delete(Path f,
 boolean recursive)
               throws IOException,
UnresolvedLinkException

Description copied from class: AbstractFileSystem

The specification of this method matches that of FileContext.delete(Path, boolean) except that Path f must be for this file system.

Specified by:

delete in class AbstractFileSystem

Parameters:

f - the path.

recursive - recursive flag.

Returns:

if successfully deleted success true, not false.

Throws:

AccessControlException - access control exception.

FileNotFoundException - file not found exception.

UnresolvedLinkException - unresolved link exception.

IOException - raised on errors performing I/O.

getFileBlockLocations

public BlockLocation[] getFileBlockLocations(Path f,
 long start,
 long len)
                                      throws IOException,
UnresolvedLinkException

Description copied from class: AbstractFileSystem

The specification of this method matches that of FileContext.getFileBlockLocations(Path, long, long) except that Path f must be for this file system.

Specified by:

getFileBlockLocations in class AbstractFileSystem

Parameters:

f - the path.

start - start.

len - length.

Returns:

BlockLocation Array.

Throws:

AccessControlException - access control exception.

FileNotFoundException - file not found exception.

UnresolvedLinkException - unresolved link exception.

IOException - raised on errors performing I/O.

getFileChecksum

public FileChecksum getFileChecksum(Path f)
                             throws IOException,
UnresolvedLinkException

Description copied from class: AbstractFileSystem

The specification of this method matches that of FileContext.getFileChecksum(Path) except that Path f must be for this file system.

Specified by:

getFileChecksum in class AbstractFileSystem

Parameters:

f - the path.

Returns:

File Check sum.

Throws:

AccessControlException - access control exception.

FileNotFoundException - file not found exception.

UnresolvedLinkException - unresolved link exception.

IOException - raised on errors performing I/O.

getFileStatus

public FileStatus getFileStatus(Path f)
                         throws IOException,
UnresolvedLinkException

Description copied from class: AbstractFileSystem

The specification of this method matches that of FileContext.getFileStatus(Path) except that an UnresolvedLinkException may be thrown if a symlink is encountered in the path.

Specified by:

getFileStatus in class AbstractFileSystem

Parameters:

f - the path.

Returns:

File Status

Throws:

AccessControlException - access control exception.

FileNotFoundException - file not found exception.

UnresolvedLinkException - unresolved link exception.

IOException - raised on errors performing I/O.

msync

public void msync()
           throws IOException,
UnsupportedOperationException

Description copied from class: AbstractFileSystem

Synchronize client metadata state.

In some FileSystem implementations such as HDFS metadata synchronization is essential to guarantee consistency of read requests particularly in HA setting.

Overrides:

msync in class AbstractFileSystem

Throws:

IOException - raised on errors performing I/O.

UnsupportedOperationException - Unsupported Operation Exception.

access

public void access(Path path,
 FsAction mode)
            throws AccessControlException,
FileNotFoundException,
UnresolvedLinkException,
IOException

Description copied from class: AbstractFileSystem

The specification of this method matches that of FileContext.access(Path, FsAction) except that an UnresolvedLinkException may be thrown if a symlink is encountered in the path.

Overrides:

access in class AbstractFileSystem

Parameters:

path - the path.

mode - fsaction mode.

Throws:

AccessControlException - access control exception.

FileNotFoundException - file not found exception.

UnresolvedLinkException - unresolved link exception.

IOException - raised on errors performing I/O.

getFileLinkStatus

public FileStatus getFileLinkStatus(Path f)
                             throws IOException,
UnresolvedLinkException

Description copied from class: AbstractFileSystem

The specification of this method matches that of FileContext.getFileLinkStatus(Path) except that an UnresolvedLinkException may be thrown if a symlink is encountered in the path leading up to the final path component. If the file system does not support symlinks then the behavior is equivalent to AbstractFileSystem.getFileStatus(Path).

Overrides:

getFileLinkStatus in class AbstractFileSystem

Parameters:

f - the path.

Returns:

file status.

Throws:

AccessControlException - access control exception.

FileNotFoundException - file not found exception.

UnsupportedFileSystemException - UnSupported File System Exception.

IOException - raised on errors performing I/O.

UnresolvedLinkException

getFsStatus

public FsStatus getFsStatus(Path f)
                     throws AccessControlException,
FileNotFoundException,
UnresolvedLinkException,
IOException

Description copied from class: AbstractFileSystem

The specification of this method matches that of FileContext.getFsStatus(Path) except that Path f must be for this file system.

Overrides:

getFsStatus in class AbstractFileSystem

Parameters:

f - the path.

Returns:

Fs Status.

Throws:

AccessControlException - access control exception.

FileNotFoundException - file not found exception.

UnresolvedLinkException - unresolved link exception.

IOException - raised on errors performing I/O.

getFsStatus

public FsStatus getFsStatus()
                     throws IOException

Description copied from class: AbstractFileSystem

The specification of this method matches that of FileContext.getFsStatus(Path).

Specified by:

getFsStatus in class AbstractFileSystem

Returns:

Fs Status.

Throws:

AccessControlException - access control exception.

FileNotFoundException - file not found exception.

IOException - raised on errors performing I/O.

getServerDefaults

@Deprecated
public FsServerDefaults getServerDefaults()
                                   throws IOException

Deprecated.

Description copied from class: AbstractFileSystem

Return a set of server default configuration values.

Specified by:

getServerDefaults in class AbstractFileSystem

Returns:

server default configuration values

Throws:

IOException - an I/O error occurred

getServerDefaults

public FsServerDefaults getServerDefaults(Path f)
                                   throws IOException

Description copied from class: AbstractFileSystem

Return a set of server default configuration values based on path.

Overrides:

getServerDefaults in class AbstractFileSystem

Parameters:

f - path to fetch server defaults

Returns:

server default configuration values for path

Throws:

IOException - an I/O error occurred

resolvePath

public Path resolvePath(Path p)
                 throws FileNotFoundException,
UnresolvedLinkException,
AccessControlException,
IOException

Description copied from class: AbstractFileSystem

Return the fully-qualified path of path f resolving the path through any internal symlinks or mount point

Overrides:

resolvePath in class AbstractFileSystem

Parameters:

p - path to be resolved

Returns:

fully qualified path

Throws:

FileNotFoundException - when file not find throw.

UnresolvedLinkException - if symbolic link on path cannot be resolved internally

AccessControlException - when accees control error throw.

IOException - raised on errors performing I/O.

getUriDefaultPort

public int getUriDefaultPort()

Description copied from class: AbstractFileSystem

The default port of this file system.

Specified by:

getUriDefaultPort in class AbstractFileSystem

Returns:

default port of this file system's Uri scheme A uri with a port of -1 => default port;

getUri

public URI getUri()

Description copied from class: AbstractFileSystem

Returns a URI whose scheme and authority identify this FileSystem.

Overrides:

getUri in class AbstractFileSystem

Returns:

the uri of this file system.

checkPath

public void checkPath(Path path)

Description copied from class: AbstractFileSystem

Check that a Path belongs to this FileSystem. If the path is fully qualified URI, then its scheme and authority matches that of this file system. Otherwise the path must be slash-relative name.

Overrides:

checkPath in class AbstractFileSystem

Parameters:

path - the path.

getUriPath

public String getUriPath(Path p)

Description copied from class: AbstractFileSystem

Get the path-part of a pathname. Checks that URI matches this file system and that the path-part is a valid name.

Overrides:

getUriPath in class AbstractFileSystem

Parameters:

p - path

Returns:

path-part of the Path p

listStatus

public FileStatus[] listStatus(Path f)
                        throws IOException,
UnresolvedLinkException

Description copied from class: AbstractFileSystem

The specification of this method matches that of FileContext.Util.listStatus(Path) except that Path f must be for this file system.

Specified by:

listStatus in class AbstractFileSystem

Parameters:

f - the path.

Returns:

FileStatus Iterator.

Throws:

AccessControlException - access control exception.

FileNotFoundException - file not found exception.

UnresolvedLinkException - unresolved link exception.

IOException - raised on errors performing I/O.

listLocatedStatus

public RemoteIterator<LocatedFileStatus> listLocatedStatus(Path f)
                                                    throws AccessControlException,
FileNotFoundException,
UnresolvedLinkException,
IOException

Description copied from class: AbstractFileSystem

The specification of this method matches that of FileContext.listLocatedStatus(Path) except that Path f must be for this file system. In HDFS implementation, the BlockLocation of returned LocatedFileStatus will have different formats for replicated and erasure coded file. Please refer to FileSystem.getFileBlockLocations(FileStatus, long, long) for more details.

Overrides:

listLocatedStatus in class AbstractFileSystem

Parameters:

f - the path.

Returns:

FileStatus Iterator.

Throws:

AccessControlException - access control exception.

FileNotFoundException - file not found exception.

UnresolvedLinkException - unresolved link exception.

IOException - raised on errors performing I/O.

listCorruptFileBlocks

public RemoteIterator<Path> listCorruptFileBlocks(Path path)
                                           throws IOException

Overrides:

listCorruptFileBlocks in class AbstractFileSystem

Parameters:

path - the path.

Returns:

an iterator over the corrupt files under the given path (may contain duplicates if a file has more than one corrupt block)

Throws:

IOException - raised on errors performing I/O.

mkdir

public void mkdir(Path dir,
 FsPermission permission,
 boolean createParent)
           throws IOException,
UnresolvedLinkException

Description copied from class: AbstractFileSystem

The specification of this method matches that of FileContext.mkdir(Path, FsPermission, boolean) except that the Path f must be fully qualified and the permission is absolute (i.e. umask has been applied).

Specified by:

mkdir in class AbstractFileSystem

Parameters:

dir - directory.

permission - permission.

createParent - create parent flag.

Throws:

AccessControlException - access control exception.

FileAlreadyExistsException - file already exists exception.

FileNotFoundException - file not found exception.

UnresolvedLinkException - unresolved link exception.

IOException - raised on errors performing I/O.

open

public FSDataInputStream open(Path f)
                       throws AccessControlException,
FileNotFoundException,
UnresolvedLinkException,
IOException

Description copied from class: AbstractFileSystem

The specification of this method matches that of FileContext.open(Path) except that Path f must be for this file system.

Overrides:

open in class AbstractFileSystem

Parameters:

f - the path.

Returns:

input stream.

Throws:

AccessControlException - access control exception.

FileNotFoundException - file not found exception.

UnresolvedLinkException - unresolved link exception.

IOException - raised on errors performing I/O.

open

public FSDataInputStream open(Path f,
 int bufferSize)
                       throws IOException,
UnresolvedLinkException

Description copied from class: AbstractFileSystem

The specification of this method matches that of FileContext.open(Path, int) except that Path f must be for this file system.

Specified by:

open in class AbstractFileSystem

Parameters:

f - the path.

bufferSize - buffer size.

Returns:

if successfully open success true, not false.

Throws:

AccessControlException - access control exception.

FileNotFoundException - file not found exception.

UnresolvedLinkException - unresolved link exception.

IOException - raised on errors performing I/O.

truncate

public boolean truncate(Path f,
 long newLength)
                 throws AccessControlException,
FileNotFoundException,
UnresolvedLinkException,
IOException

Description copied from class: AbstractFileSystem

The specification of this method matches that of FileContext.truncate(Path, long) except that Path f must be for this file system.

Overrides:

truncate in class AbstractFileSystem

Parameters:

f - the path.

newLength - new length.

Returns:

if successfully truncate success true, not false.

Throws:

AccessControlException - access control exception.

FileNotFoundException - file not found exception.

UnresolvedLinkException - unresolved link exception.

IOException - raised on errors performing I/O.

renameInternal

public void renameInternal(Path src,
 Path dst)
                    throws IOException,
UnresolvedLinkException

Description copied from class: AbstractFileSystem

The specification of this method matches that of FileContext.rename(Path, Path, Options.Rename...) except that Path f must be for this file system and NO OVERWRITE is performed. File systems that do not have a built in overwrite need implement only this method and can take advantage of the default impl of the other AbstractFileSystem.renameInternal(Path, Path, boolean)

Specified by:

renameInternal in class AbstractFileSystem

Parameters:

src - src.

dst - dst.

Throws:

AccessControlException - access control exception.

FileAlreadyExistsException - file already exists exception.

FileNotFoundException - file not found exception.

ParentNotDirectoryException - parent not directory exception.

UnresolvedLinkException - unresolved link exception.

IOException - raised on errors performing I/O.

renameInternal

public void renameInternal(Path src,
 Path dst,
 boolean overwrite)
                    throws AccessControlException,
FileAlreadyExistsException,
FileNotFoundException,
ParentNotDirectoryException,
UnresolvedLinkException,
IOException

Description copied from class: AbstractFileSystem

The specification of this method matches that of FileContext.rename(Path, Path, Options.Rename...) except that Path f must be for this file system.

Overrides:

renameInternal in class AbstractFileSystem

Parameters:

src - src.

dst - dst.

overwrite - overwrite flag.

Throws:

AccessControlException - access control exception.

FileAlreadyExistsException - file already exists exception.

FileNotFoundException - file not found exception.

ParentNotDirectoryException - parent not directory exception.

UnresolvedLinkException - unresolved link exception.

IOException - raised on errors performing I/O.

setOwner

public void setOwner(Path f,
 String username,
 String groupname)
              throws IOException,
UnresolvedLinkException

Description copied from class: AbstractFileSystem

The specification of this method matches that of FileContext.setOwner(Path, String, String) except that Path f must be for this file system.

Specified by:

setOwner in class AbstractFileSystem

Parameters:

f - the path.

username - username.

groupname - groupname.

Throws:

AccessControlException - access control exception.

FileNotFoundException - file not found exception.

UnresolvedLinkException - unresolved link exception.

IOException - raised on errors performing I/O.

setPermission

public void setPermission(Path f,
 FsPermission permission)
                   throws IOException,
UnresolvedLinkException

Description copied from class: AbstractFileSystem

The specification of this method matches that of FileContext.setPermission(Path, FsPermission) except that Path f must be for this file system.

Specified by:

setPermission in class AbstractFileSystem

Parameters:

f - the path.

permission - permission.

Throws:

AccessControlException - access control exception.

FileNotFoundException - file not found exception.

UnresolvedLinkException - unresolved link exception.

IOException - raised on errors performing I/O.

setReplication

public boolean setReplication(Path f,
 short replication)
                       throws IOException,
UnresolvedLinkException

Description copied from class: AbstractFileSystem

The specification of this method matches that of FileContext.setReplication(Path, short) except that Path f must be for this file system.

Specified by:

setReplication in class AbstractFileSystem

Parameters:

f - the path.

replication - replication.

Returns:

if successfully set replication success true, not false.

Throws:

AccessControlException - access control exception.

FileNotFoundException - file not found exception.

UnresolvedLinkException - unresolved link exception.

IOException - raised on errors performing I/O.

setTimes

public void setTimes(Path f,
 long mtime,
 long atime)
              throws IOException,
UnresolvedLinkException

Description copied from class: AbstractFileSystem

The specification of this method matches that of FileContext.setTimes(Path, long, long) except that Path f must be for this file system.

Specified by:

setTimes in class AbstractFileSystem

Parameters:

f - the path.

mtime - modify time.

atime - access time.

Throws:

AccessControlException - access control exception.

FileNotFoundException - file not found exception.

UnresolvedLinkException - unresolved link exception.

IOException - raised on errors performing I/O.

setVerifyChecksum

public void setVerifyChecksum(boolean verifyChecksum)
                       throws IOException,
UnresolvedLinkException

Description copied from class: AbstractFileSystem

The specification of this method matches that of FileContext.setVerifyChecksum(boolean, Path) except that Path f must be for this file system.

Specified by:

setVerifyChecksum in class AbstractFileSystem

Parameters:

verifyChecksum - verify check sum flag.

Throws:

AccessControlException - access control exception.

IOException - raised on errors performing I/O.

UnresolvedLinkException

supportsSymlinks

public boolean supportsSymlinks()

Description copied from class: AbstractFileSystem

Returns true if the file system supports symlinks, false otherwise.

Overrides:

supportsSymlinks in class AbstractFileSystem

Returns:

true if filesystem supports symlinks

createSymlink

public void createSymlink(Path target,
 Path link,
 boolean createParent)
                   throws IOException,
UnresolvedLinkException

Description copied from class: AbstractFileSystem

The specification of this method matches that of FileContext.createSymlink(Path, Path, boolean);

Overrides:

createSymlink in class AbstractFileSystem

Parameters:

target - target.

link - link.

createParent - create parent.

Throws:

IOException - raised on errors performing I/O.

UnresolvedLinkException - unresolved link exception.

getLinkTarget

public Path getLinkTarget(Path f)
                   throws IOException

Description copied from class: AbstractFileSystem

Partially resolves the path. This is used during symlink resolution in FSLinkResolver, and differs from the similarly named method FileContext.getLinkTarget(Path).

Overrides:

getLinkTarget in class AbstractFileSystem

Parameters:

f - the path.

Returns:

target path.

Throws:

IOException - subclass implementations may throw IOException

getCanonicalServiceName

public String getCanonicalServiceName()

Description copied from class: AbstractFileSystem

Get a canonical name for this file system.

Overrides:

getCanonicalServiceName in class AbstractFileSystem

Returns:

a URI string that uniquely identifies this file system

getDelegationTokens

public List<Token<?>> getDelegationTokens(String renewer)
                                   throws IOException

Description copied from class: AbstractFileSystem

Get one or more delegation tokens associated with the filesystem. Normally a file system returns a single delegation token. A file system that manages multiple file systems underneath, could return set of delegation tokens for all the file systems it manages

Overrides:

getDelegationTokens in class AbstractFileSystem

Parameters:

renewer - the account name that is allowed to renew the token.

Returns:

List of delegation tokens. If delegation tokens not supported then return a list of size zero.

Throws:

IOException - raised on errors performing I/O.

isValidName

public boolean isValidName(String src)

Description copied from class: AbstractFileSystem

Returns true if the specified string is considered valid in the path part of a URI by this file system. The default implementation enforces the rules of HDFS, but subclasses may override this method to implement specific validation rules for specific file systems.

Overrides:

isValidName in class AbstractFileSystem

Parameters:

src - String source filename to check, path part of the URI

Returns:

boolean true if the specified string is considered valid

modifyAclEntries

public void modifyAclEntries(Path path,
 List<AclEntry> aclSpec)
                      throws IOException

Description copied from class: AbstractFileSystem

Modifies ACL entries of files and directories. This method can add new ACL entries or modify the permissions on existing ACL entries. All existing ACL entries that are not specified in this call are retained without changes. (Modifications are merged into the current ACL.)

Overrides:

modifyAclEntries in class AbstractFileSystem

Parameters:

path - Path to modify

aclSpec - List<AclEntry> describing modifications

Throws:

IOException - if an ACL could not be modified

removeAclEntries

public void removeAclEntries(Path path,
 List<AclEntry> aclSpec)
                      throws IOException

Description copied from class: AbstractFileSystem

Removes ACL entries from files and directories. Other ACL entries are retained.

Overrides:

removeAclEntries in class AbstractFileSystem

Parameters:

path - Path to modify

aclSpec - List<AclEntry> describing entries to remove

Throws:

IOException - if an ACL could not be modified

removeDefaultAcl

public void removeDefaultAcl(Path path)
                      throws IOException

Description copied from class: AbstractFileSystem

Removes all default ACL entries from files and directories.

Overrides:

removeDefaultAcl in class AbstractFileSystem

Parameters:

path - Path to modify

Throws:

IOException - if an ACL could not be modified

removeAcl

public void removeAcl(Path path)
               throws IOException

Description copied from class: AbstractFileSystem

Removes all but the base ACL entries of files and directories. The entries for user, group, and others are retained for compatibility with permission bits.

Overrides:

removeAcl in class AbstractFileSystem

Parameters:

path - Path to modify

Throws:

IOException - if an ACL could not be removed

setAcl

public void setAcl(Path path,
 List<AclEntry> aclSpec)
            throws IOException

Description copied from class: AbstractFileSystem

Fully replaces ACL of files and directories, discarding all existing entries.

Overrides:

setAcl in class AbstractFileSystem

Parameters:

path - Path to modify

aclSpec - List<AclEntry> describing modifications, must include entries for user, group, and others for compatibility with permission bits.

Throws:

IOException - if an ACL could not be modified

getAclStatus

public AclStatus getAclStatus(Path path)
                       throws IOException

Description copied from class: AbstractFileSystem

Gets the ACLs of files and directories.

Overrides:

getAclStatus in class AbstractFileSystem

Parameters:

path - Path to get

Returns:

RemoteIterator<AclStatus> which returns each AclStatus

Throws:

IOException - if an ACL could not be read

setXAttr

public void setXAttr(Path path,
 String name,
 byte[] value)
              throws IOException

Description copied from class: AbstractFileSystem

Set an xattr of a file or directory. The name must be prefixed with the namespace followed by ".". For example, "user.attr".

Refer to the HDFS extended attributes user documentation for details.

Overrides:

setXAttr in class AbstractFileSystem

Parameters:

path - Path to modify

name - xattr name.

value - xattr value.

Throws:

IOException - raised on errors performing I/O.

setXAttr

public void setXAttr(Path path,
 String name,
 byte[] value,
 EnumSet<XAttrSetFlag> flag)
              throws IOException

Description copied from class: AbstractFileSystem

Set an xattr of a file or directory. The name must be prefixed with the namespace followed by ".". For example, "user.attr".

Refer to the HDFS extended attributes user documentation for details.

Overrides:

setXAttr in class AbstractFileSystem

Parameters:

path - Path to modify

name - xattr name.

value - xattr value.

flag - xattr set flag

Throws:

IOException - raised on errors performing I/O.

getXAttr

public byte[] getXAttr(Path path,
 String name)
                throws IOException

Description copied from class: AbstractFileSystem

Get an xattr for a file or directory. The name must be prefixed with the namespace followed by ".". For example, "user.attr".

Refer to the HDFS extended attributes user documentation for details.

Overrides:

getXAttr in class AbstractFileSystem

Parameters:

path - Path to get extended attribute

name - xattr name.

Returns:

byte[] xattr value.

Throws:

IOException - raised on errors performing I/O.

getXAttrs

public Map<String,byte[]> getXAttrs(Path path)
                             throws IOException

Description copied from class: AbstractFileSystem

Get all of the xattrs for a file or directory. Only those xattrs for which the logged-in user has permissions to view are returned.

Refer to the HDFS extended attributes user documentation for details.

Overrides:

getXAttrs in class AbstractFileSystem

Parameters:

path - Path to get extended attributes

Returns:

Map<String, byte[]> describing the XAttrs of the file or directory

Throws:

IOException - raised on errors performing I/O.

getXAttrs

public Map<String,byte[]> getXAttrs(Path path,
 List<String> names)
                             throws IOException

Description copied from class: AbstractFileSystem

Get all of the xattrs for a file or directory. Only those xattrs for which the logged-in user has permissions to view are returned.

Refer to the HDFS extended attributes user documentation for details.

Overrides:

getXAttrs in class AbstractFileSystem

Parameters:

path - Path to get extended attributes

names - XAttr names.

Returns:

Map<String, byte[]> describing the XAttrs of the file or directory

Throws:

IOException - raised on errors performing I/O.

listXAttrs

public List<String> listXAttrs(Path path)
                        throws IOException

Description copied from class: AbstractFileSystem

Get all of the xattr names for a file or directory. Only the xattr names for which the logged-in user has permissions to view are returned.

Refer to the HDFS extended attributes user documentation for details.

Overrides:

listXAttrs in class AbstractFileSystem

Parameters:

path - Path to get extended attributes

Returns:

Map<String, byte[]> describing the XAttrs of the file or directory

Throws:

IOException - raised on errors performing I/O.

removeXAttr

public void removeXAttr(Path path,
 String name)
                 throws IOException

Description copied from class: AbstractFileSystem

Remove an xattr of a file or directory. The name must be prefixed with the namespace followed by ".". For example, "user.attr".

Refer to the HDFS extended attributes user documentation for details.

Overrides:

removeXAttr in class AbstractFileSystem

Parameters:

path - Path to remove extended attribute

name - xattr name

Throws:

IOException - raised on errors performing I/O.

createSnapshot

public Path createSnapshot(Path path,
 String snapshotName)
                    throws IOException

Description copied from class: AbstractFileSystem

The specification of this method matches that of FileContext.createSnapshot(Path, String).

Overrides:

createSnapshot in class AbstractFileSystem

Parameters:

path - the path.

snapshotName - snapshot name.

Returns:

path.

Throws:

IOException - raised on errors performing I/O.

renameSnapshot

public void renameSnapshot(Path path,
 String snapshotOldName,
 String snapshotNewName)
                    throws IOException

Description copied from class: AbstractFileSystem

The specification of this method matches that of FileContext.renameSnapshot(Path, String, String).

Overrides:

renameSnapshot in class AbstractFileSystem

Parameters:

path - the path.

snapshotOldName - snapshot old name.

snapshotNewName - snapshot new name.

Throws:

IOException - raised on errors performing I/O.

deleteSnapshot

public void deleteSnapshot(Path path,
 String snapshotName)
                    throws IOException

Description copied from class: AbstractFileSystem

The specification of this method matches that of FileContext.deleteSnapshot(Path, String).

Overrides:

deleteSnapshot in class AbstractFileSystem

Parameters:

path - snapshot dir.

snapshotName - snapshot name.

Throws:

IOException - raised on errors performing I/O.

satisfyStoragePolicy

public void satisfyStoragePolicy(Path path)
                          throws IOException

Description copied from class: AbstractFileSystem

Set the source path to satisfy storage policy.

Overrides:

satisfyStoragePolicy in class AbstractFileSystem

Parameters:

path - The source path referring to either a directory or a file.

Throws:

IOException - raised on errors performing I/O.

setStoragePolicy

public void setStoragePolicy(Path path,
 String policyName)
                      throws IOException

Description copied from class: AbstractFileSystem

Set the storage policy for a given file or directory.

Overrides:

setStoragePolicy in class AbstractFileSystem

Parameters:

path - file or directory path.

policyName - the name of the target storage policy. The list of supported Storage policies can be retrieved via AbstractFileSystem.getAllStoragePolicies().

Throws:

IOException - raised on errors performing I/O.

unsetStoragePolicy

public void unsetStoragePolicy(Path src)
                        throws IOException

Description copied from class: AbstractFileSystem

Unset the storage policy set for a given file or directory.

Overrides:

unsetStoragePolicy in class AbstractFileSystem

Parameters:

src - file or directory path.

Throws:

IOException - raised on errors performing I/O.

getStoragePolicy

public BlockStoragePolicySpi getStoragePolicy(Path src)
                                       throws IOException

Description copied from class: AbstractFileSystem

Retrieve the storage policy for a given file or directory.

Overrides:

getStoragePolicy in class AbstractFileSystem

Parameters:

src - file or directory path.

Returns:

storage policy for give file.

Throws:

IOException - raised on errors performing I/O.

getAllStoragePolicies

public Collection<? extends BlockStoragePolicySpi> getAllStoragePolicies()
                                                                  throws IOException

Description copied from class: AbstractFileSystem

Retrieve all the storage policies supported by this file system.

Overrides:

getAllStoragePolicies in class AbstractFileSystem

Returns:

all storage policies supported by this filesystem.

Throws:

IOException - raised on errors performing I/O.

openFileWithOptions

public CompletableFuture<FSDataInputStream> openFileWithOptions(Path path,
 OpenFileParameters parameters)
                                                         throws IOException

Description copied from class: AbstractFileSystem

Open a file with the given set of options. The base implementation performs a blocking call to AbstractFileSystem.open(Path, int)in this call; the actual outcome is in the returned CompletableFuture. This avoids having to create some thread pool, while still setting up the expectation that the get() call is needed to evaluate the result.

Overrides:

openFileWithOptions in class AbstractFileSystem

Parameters:

path - path to the file

parameters - open file parameters from the builder.

Returns:

a future which will evaluate to the opened file.

Throws:

IOException - failure to resolve the link.

hasPathCapability

public boolean hasPathCapability(Path path,
 String capability)
                          throws IOException

Description copied from interface: PathCapabilities

Probe for a specific capability under the given path. If the function returns true, this instance is explicitly declaring that the capability is available. If the function returns false, it can mean one of:

• The capability is not known.
• The capability is known but it is not supported.
• The capability is known but the filesystem does not know if it is supported under the supplied path.

The core guarantee which a caller can rely on is: if the predicate returns true, then the specific operation/behavior can be expected to be supported. However a specific call may be rejected for permission reasons, the actual file/directory not being present, or some other failure during the attempted execution of the operation.

Implementors: PathCapabilitiesSupport can be used to help implement this method.

Specified by:

hasPathCapability in interface PathCapabilities

Overrides:

hasPathCapability in class AbstractFileSystem

Parameters:

path - path to query the capability of.

capability - non-null, non-empty string to query the path for support.

Returns:

true if the capability is supported under that part of the FS.

Throws:

IOException - this should not be raised, except on problems resolving paths or relaying the call.

createMultipartUploader

public MultipartUploaderBuilder createMultipartUploader(Path basePath)
                                                 throws IOException

Description copied from class: AbstractFileSystem

Create a multipart uploader.

Overrides:

createMultipartUploader in class AbstractFileSystem

Parameters:

basePath - file path under which all files are uploaded

Returns:

a MultipartUploaderBuilder object to build the uploader

Throws:

IOException - if some early checks cause IO failures.

getEnclosingRoot

public Path getEnclosingRoot(Path path)
                      throws IOException

Description copied from class: AbstractFileSystem

Return path of the enclosing root for a given path The enclosing root path is a common ancestor that should be used for temp and staging dirs as well as within encryption zones and other restricted directories. Call makeQualified on the param path to ensure its part of the correct filesystem

Overrides:

getEnclosingRoot in class AbstractFileSystem

Parameters:

path - file path to find the enclosing root path for

Returns:

a path to the enclosing root

Throws:

IOException - early checks like failure to resolve path cause IO failures