@InterfaceAudience.Public @InterfaceStability.Evolving public class ViewFs extends AbstractFileSystem
To use viewfs one would typically set the default file system in the config (i.e. fs.defaultFS < = viewfs:///) along with the mount table config variables as described below.
** Config variables to specify the mount table entries **
The file system is initialized from the standard Hadoop config through
config variables.
See FsConstants for URI and Scheme constants;
See Constants for config var constants;
see ConfigUtil for convenient lib.
All the mount table config entries for view fs are prefixed by fs.viewfs.mounttable. For example the above example can be specified with the following config variables:
**** Merge Mounts **** (NOTE: merge mounts are not implemented yet.)
One can also use "MergeMounts" to merge several directories (this is sometimes called union-mounts or junction-mounts in the literature. For example of the home directories are stored on say two file systems (because they do not fit on one) then one could specify a mount entry such as following merges two dirs:
| Modifier and Type | Class and Description |
|---|---|
static class |
ViewFs.MountPoint |
statistics| Constructor and Description |
|---|
ViewFs(Configuration conf) |
| Modifier and Type | Method and 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. |
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. |
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.
|
List<Token<?>> |
getDelegationTokens(String renewer)
Get one or more delegation tokens associated with the filesystem.
|
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). |
Path |
getHomeDirectory()
Return the current user's home directory in this file system.
|
Path |
getLinkTarget(Path f)
Partially resolves the path.
|
ViewFs.MountPoint[] |
getMountPoints() |
FsServerDefaults |
getServerDefaults()
Return a set of server default configuration values.
|
BlockStoragePolicySpi |
getStoragePolicy(Path src)
Retrieve the storage policy for a given file or directory.
|
int |
getUriDefaultPort()
The default port of this file system.
|
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 |
isValidName(String src)
Returns true if the specified string is considered valid in the path part
of a URI by 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. |
RemoteIterator<FileStatus> |
listStatusIterator(Path f)
The specification of this method matches that of
FileContext.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.
|
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.
|
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. |
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 f)
Return the fully-qualified path of path f resolving the path
through any internal symlinks or mount point
|
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,
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.
|
checkPath, checkScheme, clearStatistics, create, createFileSystem, equals, get, getAllStatistics, getAllStoragePolicies, getCanonicalServiceName, getFsStatus, getInitialWorkingDirectory, getStatistics, getStatistics, getUri, getUriPath, hashCode, listCorruptFileBlocks, listLocatedStatus, makeQualified, open, printStatistics, rename, setXAttrpublic ViewFs(Configuration conf) throws IOException, URISyntaxException
IOExceptionURISyntaxExceptionpublic FsServerDefaults getServerDefaults() throws IOException
AbstractFileSystemgetServerDefaults in class AbstractFileSystemIOException - an I/O error occurredpublic int getUriDefaultPort()
AbstractFileSystemgetUriDefaultPort in class AbstractFileSystempublic Path getHomeDirectory()
AbstractFileSystemgetHomeDirectory in class AbstractFileSystempublic Path resolvePath(Path f) throws FileNotFoundException, AccessControlException, org.apache.hadoop.fs.UnresolvedLinkException, IOException
AbstractFileSystemresolvePath in class AbstractFileSystemf - path to be resolvedFileNotFoundExceptionAccessControlExceptionorg.apache.hadoop.fs.UnresolvedLinkExceptionIOExceptionpublic FSDataOutputStream createInternal(Path f, EnumSet<CreateFlag> flag, FsPermission absolutePermission, int bufferSize, short replication, long blockSize, Progressable progress, Options.ChecksumOpt checksumOpt, boolean createParent) throws AccessControlException, FileAlreadyExistsException, FileNotFoundException, ParentNotDirectoryException, UnsupportedFileSystemException, org.apache.hadoop.fs.UnresolvedLinkException, IOException
AbstractFileSystemAbstractFileSystem.create(Path, EnumSet, Options.CreateOpts...) except that the opts
have been declared explicitly.createInternal in class AbstractFileSystemAccessControlExceptionFileAlreadyExistsExceptionFileNotFoundExceptionParentNotDirectoryExceptionUnsupportedFileSystemExceptionorg.apache.hadoop.fs.UnresolvedLinkExceptionIOExceptionpublic boolean delete(Path f, boolean recursive) throws AccessControlException, FileNotFoundException, org.apache.hadoop.fs.UnresolvedLinkException, IOException
AbstractFileSystemFileContext.delete(Path, boolean) except that Path f must be for
this file system.delete in class AbstractFileSystemAccessControlExceptionFileNotFoundExceptionorg.apache.hadoop.fs.UnresolvedLinkExceptionIOExceptionpublic BlockLocation[] getFileBlockLocations(Path f, long start, long len) throws AccessControlException, FileNotFoundException, org.apache.hadoop.fs.UnresolvedLinkException, IOException
AbstractFileSystemFileContext.getFileBlockLocations(Path, long, long) except that
Path f must be for this file system.getFileBlockLocations in class AbstractFileSystemAccessControlExceptionFileNotFoundExceptionorg.apache.hadoop.fs.UnresolvedLinkExceptionIOExceptionpublic FileChecksum getFileChecksum(Path f) throws AccessControlException, FileNotFoundException, org.apache.hadoop.fs.UnresolvedLinkException, IOException
AbstractFileSystemFileContext.getFileChecksum(Path) except that Path f must be for
this file system.getFileChecksum in class AbstractFileSystemAccessControlExceptionFileNotFoundExceptionorg.apache.hadoop.fs.UnresolvedLinkExceptionIOExceptionpublic FileStatus getFileStatus(Path f) throws AccessControlException, FileNotFoundException, org.apache.hadoop.fs.UnresolvedLinkException, IOException
AbstractFileSystemFileContext.getFileStatus(Path)
except that an UnresolvedLinkException may be thrown if a symlink is
encountered in the path.getFileStatus in class AbstractFileSystemAccessControlExceptionFileNotFoundExceptionorg.apache.hadoop.fs.UnresolvedLinkExceptionIOExceptionpublic void access(Path path, FsAction mode) throws AccessControlException, FileNotFoundException, org.apache.hadoop.fs.UnresolvedLinkException, IOException
AbstractFileSystemFileContext.access(Path, FsAction)
except that an UnresolvedLinkException may be thrown if a symlink is
encountered in the path.AccessControlExceptionFileNotFoundExceptionorg.apache.hadoop.fs.UnresolvedLinkExceptionIOExceptionpublic FileStatus getFileLinkStatus(Path f) throws AccessControlException, FileNotFoundException, UnsupportedFileSystemException, IOException
AbstractFileSystemFileContext.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).getFileLinkStatus in class AbstractFileSystemAccessControlExceptionFileNotFoundExceptionUnsupportedFileSystemExceptionIOExceptionpublic FsStatus getFsStatus() throws AccessControlException, FileNotFoundException, IOException
AbstractFileSystemFileContext.getFsStatus(Path).getFsStatus in class AbstractFileSystemAccessControlExceptionFileNotFoundExceptionIOExceptionpublic RemoteIterator<FileStatus> listStatusIterator(Path f) throws AccessControlException, FileNotFoundException, org.apache.hadoop.fs.UnresolvedLinkException, IOException
AbstractFileSystemFileContext.listStatus(Path) except that Path f must be for this
file system.listStatusIterator in class AbstractFileSystemAccessControlExceptionFileNotFoundExceptionorg.apache.hadoop.fs.UnresolvedLinkExceptionIOExceptionpublic FileStatus[] listStatus(Path f) throws AccessControlException, FileNotFoundException, org.apache.hadoop.fs.UnresolvedLinkException, IOException
AbstractFileSystemFileContext.Util.listStatus(Path) except that Path f must be
for this file system.listStatus in class AbstractFileSystemAccessControlExceptionFileNotFoundExceptionorg.apache.hadoop.fs.UnresolvedLinkExceptionIOExceptionpublic void mkdir(Path dir, FsPermission permission, boolean createParent) throws AccessControlException, FileAlreadyExistsException, FileNotFoundException, org.apache.hadoop.fs.UnresolvedLinkException, IOException
AbstractFileSystemFileContext.mkdir(Path, FsPermission, boolean) except that the Path
f must be fully qualified and the permission is absolute (i.e.
umask has been applied).mkdir in class AbstractFileSystemAccessControlExceptionFileAlreadyExistsExceptionFileNotFoundExceptionorg.apache.hadoop.fs.UnresolvedLinkExceptionIOExceptionpublic FSDataInputStream open(Path f, int bufferSize) throws AccessControlException, FileNotFoundException, org.apache.hadoop.fs.UnresolvedLinkException, IOException
AbstractFileSystemFileContext.open(Path, int) except that Path f must be for this
file system.open in class AbstractFileSystemAccessControlExceptionFileNotFoundExceptionorg.apache.hadoop.fs.UnresolvedLinkExceptionIOExceptionpublic boolean truncate(Path f, long newLength) throws AccessControlException, FileNotFoundException, org.apache.hadoop.fs.UnresolvedLinkException, IOException
AbstractFileSystemFileContext.truncate(Path, long) except that Path f must be for
this file system.truncate in class AbstractFileSystemAccessControlExceptionFileNotFoundExceptionorg.apache.hadoop.fs.UnresolvedLinkExceptionIOExceptionpublic void renameInternal(Path src, Path dst, boolean overwrite) throws IOException, org.apache.hadoop.fs.UnresolvedLinkException
AbstractFileSystemFileContext.rename(Path, Path, Options.Rename...) except that Path
f must be for this file system.renameInternal in class AbstractFileSystemIOExceptionorg.apache.hadoop.fs.UnresolvedLinkExceptionpublic void renameInternal(Path src, Path dst) throws AccessControlException, FileAlreadyExistsException, FileNotFoundException, ParentNotDirectoryException, org.apache.hadoop.fs.UnresolvedLinkException, IOException
AbstractFileSystemFileContext.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)renameInternal in class AbstractFileSystemAccessControlExceptionFileAlreadyExistsExceptionFileNotFoundExceptionParentNotDirectoryExceptionorg.apache.hadoop.fs.UnresolvedLinkExceptionIOExceptionpublic boolean supportsSymlinks()
AbstractFileSystemsupportsSymlinks in class AbstractFileSystempublic void createSymlink(Path target, Path link, boolean createParent) throws IOException, org.apache.hadoop.fs.UnresolvedLinkException
AbstractFileSystemFileContext.createSymlink(Path, Path, boolean);createSymlink in class AbstractFileSystemIOExceptionorg.apache.hadoop.fs.UnresolvedLinkExceptionpublic Path getLinkTarget(Path f) throws IOException
AbstractFileSystemFSLinkResolver, and differs from the similarly named method
FileContext.getLinkTarget(Path).getLinkTarget in class AbstractFileSystemIOException - subclass implementations may throw IOExceptionpublic void setOwner(Path f, String username, String groupname) throws AccessControlException, FileNotFoundException, org.apache.hadoop.fs.UnresolvedLinkException, IOException
AbstractFileSystemFileContext.setOwner(Path, String, String) except that Path f must
be for this file system.setOwner in class AbstractFileSystemAccessControlExceptionFileNotFoundExceptionorg.apache.hadoop.fs.UnresolvedLinkExceptionIOExceptionpublic void setPermission(Path f, FsPermission permission) throws AccessControlException, FileNotFoundException, org.apache.hadoop.fs.UnresolvedLinkException, IOException
AbstractFileSystemFileContext.setPermission(Path, FsPermission) except that Path f
must be for this file system.setPermission in class AbstractFileSystemAccessControlExceptionFileNotFoundExceptionorg.apache.hadoop.fs.UnresolvedLinkExceptionIOExceptionpublic boolean setReplication(Path f, short replication) throws AccessControlException, FileNotFoundException, org.apache.hadoop.fs.UnresolvedLinkException, IOException
AbstractFileSystemFileContext.setReplication(Path, short) except that Path f must be
for this file system.setReplication in class AbstractFileSystemAccessControlExceptionFileNotFoundExceptionorg.apache.hadoop.fs.UnresolvedLinkExceptionIOExceptionpublic void setTimes(Path f, long mtime, long atime) throws AccessControlException, FileNotFoundException, org.apache.hadoop.fs.UnresolvedLinkException, IOException
AbstractFileSystemFileContext.setTimes(Path, long, long) except that Path f must be
for this file system.setTimes in class AbstractFileSystemAccessControlExceptionFileNotFoundExceptionorg.apache.hadoop.fs.UnresolvedLinkExceptionIOExceptionpublic void setVerifyChecksum(boolean verifyChecksum) throws AccessControlException, IOException
AbstractFileSystemFileContext.setVerifyChecksum(boolean, Path) except that Path f
must be for this file system.setVerifyChecksum in class AbstractFileSystemAccessControlExceptionIOExceptionpublic ViewFs.MountPoint[] getMountPoints()
public List<Token<?>> getDelegationTokens(String renewer) throws IOException
AbstractFileSystemrenewer - the account name that is allowed to renew the token.IOExceptionpublic boolean isValidName(String src)
AbstractFileSystemisValidName in class AbstractFileSystemsrc - String source filename to check, path part of the URIpublic void modifyAclEntries(Path path, List<AclEntry> aclSpec) throws IOException
AbstractFileSystemmodifyAclEntries in class AbstractFileSystempath - Path to modifyaclSpec - ListIOException - if an ACL could not be modifiedpublic void removeAclEntries(Path path, List<AclEntry> aclSpec) throws IOException
AbstractFileSystemremoveAclEntries in class AbstractFileSystempath - Path to modifyaclSpec - ListIOException - if an ACL could not be modifiedpublic void removeDefaultAcl(Path path) throws IOException
AbstractFileSystemremoveDefaultAcl in class AbstractFileSystempath - Path to modifyIOException - if an ACL could not be modifiedpublic void removeAcl(Path path) throws IOException
AbstractFileSystemremoveAcl in class AbstractFileSystempath - Path to modifyIOException - if an ACL could not be removedpublic void setAcl(Path path, List<AclEntry> aclSpec) throws IOException
AbstractFileSystemsetAcl in class AbstractFileSystempath - Path to modifyaclSpec - ListIOException - if an ACL could not be modifiedpublic AclStatus getAclStatus(Path path) throws IOException
AbstractFileSystemgetAclStatus in class AbstractFileSystempath - Path to getIOException - if an ACL could not be readpublic void setXAttr(Path path, String name, byte[] value, EnumSet<XAttrSetFlag> flag) throws IOException
AbstractFileSystemsetXAttr in class AbstractFileSystempath - Path to modifyname - xattr name.value - xattr value.flag - xattr set flagIOExceptionpublic byte[] getXAttr(Path path, String name) throws IOException
AbstractFileSystemgetXAttr in class AbstractFileSystempath - Path to get extended attributename - xattr name.IOExceptionpublic Map<String,byte[]> getXAttrs(Path path) throws IOException
AbstractFileSystemgetXAttrs in class AbstractFileSystempath - Path to get extended attributesIOExceptionpublic Map<String,byte[]> getXAttrs(Path path, List<String> names) throws IOException
AbstractFileSystemgetXAttrs in class AbstractFileSystempath - Path to get extended attributesnames - XAttr names.IOExceptionpublic List<String> listXAttrs(Path path) throws IOException
AbstractFileSystemlistXAttrs in class AbstractFileSystempath - Path to get extended attributesIOExceptionpublic void removeXAttr(Path path, String name) throws IOException
AbstractFileSystemremoveXAttr in class AbstractFileSystempath - Path to remove extended attributename - xattr nameIOExceptionpublic Path createSnapshot(Path path, String snapshotName) throws IOException
AbstractFileSystemFileContext.createSnapshot(Path, String).createSnapshot in class AbstractFileSystemIOExceptionpublic void renameSnapshot(Path path, String snapshotOldName, String snapshotNewName) throws IOException
AbstractFileSystemFileContext.renameSnapshot(Path, String, String).renameSnapshot in class AbstractFileSystemIOExceptionpublic void deleteSnapshot(Path path, String snapshotName) throws IOException
AbstractFileSystemFileContext.deleteSnapshot(Path, String).deleteSnapshot in class AbstractFileSystemIOExceptionpublic void setStoragePolicy(Path path, String policyName) throws IOException
AbstractFileSystemsetStoragePolicy in class AbstractFileSystempath - file or directory path.policyName - the name of the target storage policy. The list
of supported Storage policies can be retrieved
via AbstractFileSystem.getAllStoragePolicies().IOExceptionpublic void unsetStoragePolicy(Path src) throws IOException
AbstractFileSystemunsetStoragePolicy in class AbstractFileSystemsrc - file or directory path.IOExceptionpublic BlockStoragePolicySpi getStoragePolicy(Path src) throws IOException
getStoragePolicy in class AbstractFileSystemsrc - file or directory path.IOExceptionCopyright © 2017 Apache Software Foundation. All Rights Reserved.