Package org.apache.hadoop.fs

Class CommonPathCapabilities

java.lang.Object

org.apache.hadoop.fs.CommonPathCapabilities

public final class CommonPathCapabilities
extends java.lang.Object

Common path capabilities.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ABORTABLE_STREAM	Stream abort() capability implemented by Abortable.abort().
static java.lang.String	BULK_DELETE	Capability string to probe for bulk delete: "fs.capability.bulk.delete".
static java.lang.String	DIRECTORY_LISTING_INCONSISTENT	Is this a store where parent directory listings are potentially inconsistent with direct list/getFileStatus calls? This can happen with Amazon S3 Express One Zone Storage when there are pending uploads under a path.
static java.lang.String	ETAGS_AVAILABLE	Does this FS support etags? That is: will FileStatus entries from listing/getFileStatus probes support EtagSource and return real values.
static java.lang.String	ETAGS_PRESERVED_IN_RENAME	Are etags guaranteed to be preserved across rename() operations..
static java.lang.String	FS_ACLS	Does the store support FileSystem.setAcl(Path, List), FileSystem.getAclStatus(Path) and related methods? Value: "fs.capability.paths.acls".
static java.lang.String	FS_APPEND	Does the store support FileSystem.append(Path)? Value: "fs.capability.paths.append".
static java.lang.String	FS_CHECKSUMS	Does the store support FileSystem.getFileChecksum(Path)? Value: "fs.capability.paths.checksums".
static java.lang.String	FS_CONCAT	Does the store support FileSystem.concat(Path, Path[])? Value: "fs.capability.paths.concat".
static java.lang.String	FS_EXPERIMENTAL_BATCH_LISTING	Probe for support for BatchListingOperations.
static java.lang.String	FS_LIST_CORRUPT_FILE_BLOCKS	Does the store support FileSystem.listCorruptFileBlocks(Path) ()}? Value: "fs.capability.paths.list-corrupt-file-blocks".
static java.lang.String	FS_MULTIPART_UPLOADER	Does the store support multipart uploading? Value: "fs.capability.multipart.uploader".
static java.lang.String	FS_PATHHANDLES	Does the store support FileSystem.createPathHandle(FileStatus, Options.HandleOpt...) and related methods? Value: "fs.capability.paths.pathhandles".
static java.lang.String	FS_PERMISSIONS	Does the store support FileSystem.setPermission(Path, FsPermission) and related methods? Value: "fs.capability.paths.permissions".
static java.lang.String	FS_READ_ONLY_CONNECTOR	Does this filesystem connector only support filesystem read operations? For example, the HttpFileSystem is always read-only.
static java.lang.String	FS_SNAPSHOTS	Does the store support snapshots through FileSystem.createSnapshot(Path) and related methods?? Value: "fs.capability.paths.snapshots".
static java.lang.String	FS_STORAGEPOLICY	Does the store support FileSystem.setStoragePolicy(Path, String) and related methods? Value: "fs.capability.paths.storagepolicy".
static java.lang.String	FS_SYMLINKS	Does the store support symlinks through FileSystem.createSymlink(Path, Path, boolean) and related methods? Value: "fs.capability.paths.symlinks".
static java.lang.String	FS_TRUNCATE	Does the store support FileSystem#truncate(Path, long) ? Value: "fs.capability.paths.truncate".
static java.lang.String	FS_XATTRS	Does the store support XAttributes through FileSystem#.setXAttr() and related methods? Value: "fs.capability.paths.xattrs".
static java.lang.String	LEASE_RECOVERABLE	Does this Filesystem support lease recovery operations such as LeaseRecoverable.recoverLease(Path) and LeaseRecoverable.isFileClosed(Path)}? Value: "fs.capability.lease.recoverable".
static java.lang.String	VIRTUAL_BLOCK_LOCATIONS	Capability string to probe for block locations returned in LocatedFileStatus instances from calls such as getBlockLocations() and listStatus()l to be 'virtual' rather than actual values resolved against a Distributed Filesystem including HDFS: "fs.capability.virtual.block.locations".

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

FS_ACLS

public static final java.lang.String FS_ACLS

Does the store support FileSystem.setAcl(Path, List), FileSystem.getAclStatus(Path) and related methods? Value: "fs.capability.paths.acls".

See Also:

Constant Field Values

FS_APPEND

public static final java.lang.String FS_APPEND

Does the store support FileSystem.append(Path)? Value: "fs.capability.paths.append".

See Also:

Constant Field Values

FS_CHECKSUMS

public static final java.lang.String FS_CHECKSUMS

Does the store support FileSystem.getFileChecksum(Path)? Value: "fs.capability.paths.checksums".

See Also:

Constant Field Values

FS_CONCAT

public static final java.lang.String FS_CONCAT

Does the store support FileSystem.concat(Path, Path[])? Value: "fs.capability.paths.concat".

See Also:

Constant Field Values

FS_LIST_CORRUPT_FILE_BLOCKS

public static final java.lang.String FS_LIST_CORRUPT_FILE_BLOCKS

Does the store support FileSystem.listCorruptFileBlocks(Path) ()}? Value: "fs.capability.paths.list-corrupt-file-blocks".

See Also:

Constant Field Values

FS_PATHHANDLES

public static final java.lang.String FS_PATHHANDLES

Does the store support FileSystem.createPathHandle(FileStatus, Options.HandleOpt...) and related methods? Value: "fs.capability.paths.pathhandles".

See Also:

Constant Field Values

FS_PERMISSIONS

public static final java.lang.String FS_PERMISSIONS

Does the store support FileSystem.setPermission(Path, FsPermission) and related methods? Value: "fs.capability.paths.permissions".

See Also:

Constant Field Values

FS_READ_ONLY_CONNECTOR

public static final java.lang.String FS_READ_ONLY_CONNECTOR

Does this filesystem connector only support filesystem read operations? For example, the HttpFileSystem is always read-only. This is different from "is the specific instance and path read only?", which must be determined by checking permissions (where supported), or attempting write operations under a path. Value: "fs.capability.paths.read-only-connector".

See Also:

Constant Field Values

FS_SNAPSHOTS

public static final java.lang.String FS_SNAPSHOTS

Does the store support snapshots through FileSystem.createSnapshot(Path) and related methods?? Value: "fs.capability.paths.snapshots".

See Also:

Constant Field Values

FS_STORAGEPOLICY

public static final java.lang.String FS_STORAGEPOLICY

Does the store support FileSystem.setStoragePolicy(Path, String) and related methods? Value: "fs.capability.paths.storagepolicy".

See Also:

Constant Field Values

FS_SYMLINKS

public static final java.lang.String FS_SYMLINKS

Does the store support symlinks through FileSystem.createSymlink(Path, Path, boolean) and related methods? Value: "fs.capability.paths.symlinks".

See Also:

Constant Field Values

FS_TRUNCATE

public static final java.lang.String FS_TRUNCATE

Does the store support FileSystem#truncate(Path, long) ? Value: "fs.capability.paths.truncate".

See Also:

Constant Field Values

FS_XATTRS

public static final java.lang.String FS_XATTRS

Does the store support XAttributes through FileSystem#.setXAttr() and related methods? Value: "fs.capability.paths.xattrs".

See Also:

Constant Field Values

FS_EXPERIMENTAL_BATCH_LISTING

@Unstable
public static final java.lang.String FS_EXPERIMENTAL_BATCH_LISTING

Probe for support for BatchListingOperations.

See Also:

Constant Field Values

FS_MULTIPART_UPLOADER

public static final java.lang.String FS_MULTIPART_UPLOADER

Does the store support multipart uploading? Value: "fs.capability.multipart.uploader".

See Also:

Constant Field Values

ABORTABLE_STREAM

public static final java.lang.String ABORTABLE_STREAM

Stream abort() capability implemented by Abortable.abort(). Value: "fs.capability.outputstream.abortable".

See Also:

Constant Field Values

ETAGS_AVAILABLE

public static final java.lang.String ETAGS_AVAILABLE

Does this FS support etags? That is: will FileStatus entries from listing/getFileStatus probes support EtagSource and return real values.

See Also:

Constant Field Values

ETAGS_PRESERVED_IN_RENAME

public static final java.lang.String ETAGS_PRESERVED_IN_RENAME

Are etags guaranteed to be preserved across rename() operations.. FileSystems MUST NOT declare support for this feature unless this holds.

See Also:

Constant Field Values

LEASE_RECOVERABLE

public static final java.lang.String LEASE_RECOVERABLE

Does this Filesystem support lease recovery operations such as LeaseRecoverable.recoverLease(Path) and LeaseRecoverable.isFileClosed(Path)}? Value: "fs.capability.lease.recoverable".

See Also:

Constant Field Values

DIRECTORY_LISTING_INCONSISTENT

public static final java.lang.String DIRECTORY_LISTING_INCONSISTENT

Is this a store where parent directory listings are potentially inconsistent with direct list/getFileStatus calls? This can happen with Amazon S3 Express One Zone Storage when there are pending uploads under a path. Application code can use this flag to decide whether or not to treat FileNotFoundExceptions on treewalk as errors or something to downgrade. Value: "fs.capability.directory.listing.inconsistent".

See Also:

Constant Field Values

BULK_DELETE

public static final java.lang.String BULK_DELETE

Capability string to probe for bulk delete: "fs.capability.bulk.delete".

See Also:

Constant Field Values

VIRTUAL_BLOCK_LOCATIONS

public static final java.lang.String VIRTUAL_BLOCK_LOCATIONS

Capability string to probe for block locations returned in LocatedFileStatus instances from calls such as getBlockLocations() and listStatus()l to be 'virtual' rather than actual values resolved against a Distributed Filesystem including HDFS: "fs.capability.virtual.block.locations".

Key implications from this path capability being true:

1. Work can be scheduled anywhere
2. Creation of the location list is a low cost-client side operation

Implication #2 means there is no performance penalty from use of FileSystem operations which return lists or iterators of LocatedFileStatus.

See Also:

Constant Field Values