Package org.apache.hadoop.fs

Class HarFileSystem

java.lang.Object

org.apache.hadoop.conf.Configured

org.apache.hadoop.fs.FileSystem

org.apache.hadoop.fs.HarFileSystem

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, Configurable, BulkDeleteSource, PathCapabilities, DelegationTokenIssuer

public class HarFileSystem
extends FileSystem

This is an implementation of the Hadoop Archive Filesystem. This archive Filesystem has index files of the form _index* and has contents of the form part-*. The index files store the indexes of the real files. The index files are of the form _masterindex and _index. The master index is a level of indirection in to the index file to make the look ups faster. the index file is sorted with hash code of the paths that it contains and the master index contains pointers to the positions in index for ranges of hashcodes.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.fs.FileSystem

FileSystem.DirectoryEntries, FileSystem.DirListingIterator<T extends FileStatus>, FileSystem.Statistics

Field Summary

Fields

Modifier and Type	Field	Description
static int	METADATA_CACHE_ENTRIES_DEFAULT
static java.lang.String	METADATA_CACHE_ENTRIES_KEY
static int	VERSION

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

DEFAULT_FS, FS_DEFAULT_NAME_KEY, SHUTDOWN_HOOK_PRIORITY, statistics, TRASH_PREFIX, USER_HOME_PREFIX

Fields inherited from interface org.apache.hadoop.security.token.DelegationTokenIssuer

TOKEN_LOG

Constructor Summary

Constructors

Constructor	Description
HarFileSystem()	public construction of harfilesystem
HarFileSystem(FileSystem fs)	Constructor to create a HarFileSystem with an underlying filesystem.

Method Summary

Modifier and Type	Method	Description
FSDataOutputStream	append(Path f)	Append to an existing file (optional operation).
FSDataOutputStream	append(Path f, int bufferSize, Progressable progress)	Append to an existing file (optional operation).
FSDataOutputStreamBuilder	appendFile(Path path)	Create a Builder to append a file.
protected java.net.URI	canonicalizeUri(java.net.URI uri)	Canonicalize the given URI.
protected void	checkPath(Path path)	Check that a Path belongs to this FileSystem.
void	close()	Close this FileSystem instance.
void	completeLocalOutput(Path fsOutputFile, Path tmpLocalFile)	not implemented.
void	copyFromLocalFile(boolean delSrc, boolean overwrite, Path[] srcs, Path dst)	The src files are on the local disk.
void	copyFromLocalFile(boolean delSrc, boolean overwrite, Path src, Path dst)	not implemented.
void	copyToLocalFile(boolean delSrc, Path src, Path dst)	copies the file in the har filesystem to a local file.
FSDataOutputStream	create(Path f, FsPermission permission, boolean overwrite, int bufferSize, short replication, long blockSize, Progressable progress)	Create an FSDataOutputStream at the indicated Path with write-progress reporting.
FSDataOutputStreamBuilder	createFile(Path path)	Create a new FSDataOutputStreamBuilder for the file with path.
FSDataOutputStream	createNonRecursive(Path f, boolean overwrite, int bufferSize, short replication, long blockSize, Progressable progress)	Opens an FSDataOutputStream at the indicated Path with write-progress reporting.
protected PathHandle	createPathHandle(FileStatus stat, Options.HandleOpt... opts)	Hook to implement support for PathHandle operations.
boolean	delete(Path f, boolean recursive)	Not implemented.
protected java.net.URI	getCanonicalUri()	Used for delegation token related functionality.
FileSystem[]	getChildFileSystems()	Used for delegation token related functionality.
Configuration	getConf()	Return the configuration used by this object.
long	getDefaultBlockSize()	Return the number of bytes that large input files should be optimally be split into to minimize I/O time.
long	getDefaultBlockSize(Path f)	Return the number of bytes that large input files should be optimally be split into to minimize I/O time.
short	getDefaultReplication()	Get the default replication.
short	getDefaultReplication(Path f)	Get the default replication for a path.
BlockLocation[]	getFileBlockLocations(FileStatus file, long start, long len)	Get block locations from the underlying fs and fix their offsets and lengths.
FileChecksum	getFileChecksum(Path f, long length)	Get the checksum of a file, from the beginning of the file till the specific length.
FileStatus	getFileStatus(Path f)	return the filestatus of files in har archive.
static int	getHarHash(Path p)	the hash of the path p inside the filesystem
int	getHarVersion()
Path	getHomeDirectory()	return the top level archive path.
Path	getInitialWorkingDirectory()	Note: with the new FileContext class, getWorkingDirectory() will be removed.
java.lang.String	getScheme()	Return the protocol scheme for the FileSystem.
FsServerDefaults	getServerDefaults()	Return a set of server default configuration values.
FsServerDefaults	getServerDefaults(Path f)	Return a set of server default configuration values.
FsStatus	getStatus(Path p)	Returns a status object describing the use and capacity of the filesystem.
java.net.URI	getUri()	Returns the uri of this filesystem.
long	getUsed()	Return the total size of all files in the filesystem.
long	getUsed(Path path)	Return the total size of all files from a specified path.
Path	getWorkingDirectory()	return the top level archive.
boolean	hasPathCapability(Path path, java.lang.String capability)	Declare that this filesystem connector is always read only.
void	initialize(java.net.URI name, Configuration conf)	Initialize a Har filesystem per har archive.
FileStatus[]	listStatus(Path f)	liststatus returns the children of a directory after looking up the index files.
Path	makeQualified(Path path)	Qualify a path to one which uses this FileSystem and, if relative, made absolute.
boolean	mkdirs(Path f, FsPermission permission)	not implemented.
void	msync()	Synchronize client metadata state.
FSDataInputStream	open(PathHandle fd, int bufferSize)	Open an FSDataInputStream matching the PathHandle instance.
FSDataInputStream	open(Path f, int bufferSize)	Returns a har input stream which fakes end of file.
boolean	rename(Path src, Path dst)	Renames Path src to Path dst.
Path	resolvePath(Path p)	Return the fully-qualified path of path, resolving the path through any symlinks or mount point.
void	setOwner(Path p, java.lang.String username, java.lang.String groupname)	not implemented.
void	setPermission(Path p, FsPermission permission)	Not implemented.
boolean	setReplication(Path src, short replication)	Not implemented.
void	setTimes(Path p, long mtime, long atime)	Set access time of a file.
void	setWorkingDirectory(Path newDir)	Set the current working directory for the given FileSystem.
Path	startLocalOutput(Path fsOutputFile, Path tmpLocalFile)	not implemented.
boolean	truncate(Path f, long newLength)	Not implemented.

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

access, append, append, append, areSymlinksEnabled, cancelDeleteOnExit, clearStatistics, closeAll, closeAllForUGI, concat, copyFromLocalFile, copyFromLocalFile, copyToLocalFile, copyToLocalFile, create, create, create, create, create, create, create, create, create, create, create, create, createBulkDelete, createDataInputStreamBuilder, createDataInputStreamBuilder, createDataOutputStreamBuilder, createFid, createMultipartUploader, createNewFile, createNonRecursive, createNonRecursive, createPathId, createSnapshot, createSnapshot, createSymlink, delete, deleteFid, deleteOnExit, deleteSnapshot, enableSymlinks, exists, fixRelativePart, get, get, get, getAclStatus, getAdditionalTokenIssuers, getAllStatistics, getAllStoragePolicies, getBlockSize, getCanonicalServiceName, getContentSummary, getDefaultPort, getDefaultUri, getDelegationToken, getEnclosingRoot, getFileBlockLocations, getFileChecksum, getFileLinkStatus, getFileSystemClass, getFSofPath, getGlobalStorageStatistics, getJobTrackerAddrs, getLength, getLinkTarget, getLocal, getName, getNamed, getPathHandle, getQuotaUsage, getReplication, getStatistics, getStatistics, getStatus, getStoragePolicy, getStorageStatistics, getTrashRoot, getTrashRoots, getXAttr, getXAttrs, getXAttrs, getZkConnectString, globStatus, globStatus, isDirectory, isFile, listCorruptFileBlocks, listFiles, listLocatedStatus, listLocatedStatus, listStatus, listStatus, listStatus, listStatusBatch, listStatusIterator, listXAttrs, mkdirs, mkdirs, mkdirsFid, mkdirsFid, modifyAclEntries, moveFromLocalFile, moveFromLocalFile, moveToLocalFile, newInstance, newInstance, newInstance, newInstanceLocal, open, open, openFid, openFid, openFid2, openFile, openFile, openFileWithOptions, openFileWithOptions, primitiveCreate, primitiveMkdir, primitiveMkdir, printStatistics, processDeleteOnExit, removeAcl, removeAclEntries, removeDefaultAcl, removeXAttr, rename, renameSnapshot, resolveLink, satisfyStoragePolicy, setAcl, setDefaultUri, setDefaultUri, setOwnerFid, setQuota, setQuotaByStorageType, setStoragePolicy, setVerifyChecksum, setWriteChecksum, setXAttr, setXAttr, supportsSymlinks, unsetStoragePolicy

Methods inherited from class org.apache.hadoop.conf.Configured

setConf

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hadoop.security.token.DelegationTokenIssuer

addDelegationTokens

Field Detail

METADATA_CACHE_ENTRIES_KEY

public static final java.lang.String METADATA_CACHE_ENTRIES_KEY

See Also:

Constant Field Values

METADATA_CACHE_ENTRIES_DEFAULT

public static final int METADATA_CACHE_ENTRIES_DEFAULT

See Also:

Constant Field Values

VERSION

public static final int VERSION

See Also:

Constant Field Values

Constructor Detail

HarFileSystem

public HarFileSystem()

public construction of harfilesystem

HarFileSystem

public HarFileSystem(FileSystem fs)

Constructor to create a HarFileSystem with an underlying filesystem.

Parameters:

fs - underlying file system

Method Detail

getScheme

public java.lang.String getScheme()

Return the protocol scheme for the FileSystem.

Overrides:

getScheme in class FileSystem

Returns:

har

initialize

public void initialize(java.net.URI name,
                       Configuration conf)
                throws java.io.IOException

Initialize a Har filesystem per har archive. The archive home directory is the top level directory in the filesystem that contains the HAR archive. Be careful with this method, you do not want to go on creating new Filesystem instances per call to path.getFileSystem(). the uri of Har is har://underlyingfsscheme-host:port/archivepath. or har:///archivepath. This assumes the underlying filesystem to be used in case not specified.

Overrides:

initialize in class FileSystem

Parameters:

name - a URI whose authority section names the host, port, etc. for this FileSystem

conf - the configuration

Throws:

java.io.IOException - on any failure to initialize this instance.

getConf

public Configuration getConf()

Description copied from interface: Configurable

Return the configuration used by this object.

Specified by:

getConf in interface Configurable

Overrides:

getConf in class Configured

Returns:

Configuration

getHarVersion

public int getHarVersion()
                  throws java.io.IOException

Throws:

java.io.IOException

getWorkingDirectory

public Path getWorkingDirectory()

return the top level archive.

Specified by:

getWorkingDirectory in class FileSystem

Returns:

the directory pathname

getInitialWorkingDirectory

public Path getInitialWorkingDirectory()

Description copied from class: FileSystem

Note: with the new FileContext class, getWorkingDirectory() will be removed. The working directory is implemented in FileContext. Some FileSystems like LocalFileSystem have an initial workingDir that we use as the starting workingDir. For other file systems like HDFS there is no built in notion of an initial workingDir.

Overrides:

getInitialWorkingDirectory in class FileSystem

Returns:

if there is built in notion of workingDir then it is returned; else a null is returned.

getStatus

public FsStatus getStatus(Path p)
                   throws java.io.IOException

Description copied from class: FileSystem

Returns a status object describing the use and capacity of the filesystem. If the filesystem has multiple partitions, the use and capacity of the partition pointed to by the specified path is reflected.

Overrides:

getStatus in class FileSystem

Parameters:

p - Path for which status should be obtained. null means the default partition.

Returns:

a FsStatus object

Throws:

java.io.IOException - see specific implementation

getCanonicalUri

protected java.net.URI getCanonicalUri()

Used for delegation token related functionality. Must delegate to underlying file system.

Overrides:

getCanonicalUri in class FileSystem

Returns:

the URI of this filesystem.

See Also:

FileSystem.canonicalizeUri(URI)

canonicalizeUri

protected java.net.URI canonicalizeUri(java.net.URI uri)

Description copied from class: FileSystem

Canonicalize the given URI. This is implementation-dependent, and may for example consist of canonicalizing the hostname using DNS and adding the default port if not specified. The default implementation simply fills in the default port if not specified and if FileSystem.getDefaultPort() returns a default port.

Overrides:

canonicalizeUri in class FileSystem

Parameters:

uri - url.

Returns:

URI

See Also:

NetUtils.getCanonicalUri(URI, int)

getUri

public java.net.URI getUri()

Returns the uri of this filesystem. The uri is of the form har://underlyingfsschema-host:port/pathintheunderlyingfs

Specified by:

getUri in class FileSystem

Returns:

the URI of this filesystem.

checkPath

protected void checkPath(Path path)

Description copied from class: FileSystem

Check that a Path belongs to this FileSystem. The base implementation performs case insensitive equality checks of the URIs' schemes and authorities. Subclasses may implement slightly different checks.

Overrides:

checkPath in class FileSystem

Parameters:

path - to check

resolvePath

public Path resolvePath(Path p)
                 throws java.io.IOException

Description copied from class: FileSystem

Return the fully-qualified path of path, resolving the path through any symlinks or mount point.

Overrides:

resolvePath in class FileSystem

Parameters:

p - path to be resolved

Returns:

fully qualified path

Throws:

java.io.FileNotFoundException - if the path is not present

java.io.IOException - for any other error

makeQualified

public Path makeQualified(Path path)

Description copied from class: FileSystem

Qualify a path to one which uses this FileSystem and, if relative, made absolute.

Overrides:

makeQualified in class FileSystem

Parameters:

path - to qualify.

Returns:

this path if it contains a scheme and authority and is absolute, or a new path that includes a path and authority and is fully qualified

See Also:

Path.makeQualified(URI, Path)

getFileBlockLocations

public BlockLocation[] getFileBlockLocations(FileStatus file,
                                             long start,
                                             long len)
                                      throws java.io.IOException

Get block locations from the underlying fs and fix their offsets and lengths.

Overrides:

getFileBlockLocations in class FileSystem

Parameters:

file - the input file status to get block locations

start - the start of the desired range in the contained file

len - the length of the desired range

Returns:

block locations for this segment of file

Throws:

java.io.IOException - raised on errors performing I/O.

getHarHash

public static int getHarHash(Path p)

the hash of the path p inside the filesystem

Parameters:

p - the path in the harfilesystem

Returns:

the hash code of the path.

getFileStatus

public FileStatus getFileStatus(Path f)
                         throws java.io.IOException

return the filestatus of files in har archive. The permission returned are that of the archive index files. The permissions are not persisted while creating a hadoop archive.

Specified by:

getFileStatus in class FileSystem

Parameters:

f - the path in har filesystem

Returns:

filestatus.

Throws:

java.io.IOException - raised on errors performing I/O.

msync

public void msync()
           throws java.io.IOException,
                  java.lang.UnsupportedOperationException

Description copied from class: FileSystem

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 FileSystem

Throws:

java.io.IOException - If an I/O error occurred.

java.lang.UnsupportedOperationException - if the operation is unsupported.

getFileChecksum

public FileChecksum getFileChecksum(Path f,
                                    long length)

Description copied from class: FileSystem

Get the checksum of a file, from the beginning of the file till the specific length.

Overrides:

getFileChecksum in class FileSystem

Parameters:

f - The file path

length - The length of the file range for checksum calculation

Returns:

null since no checksum algorithm is implemented.

open

public FSDataInputStream open(Path f,
                              int bufferSize)
                       throws java.io.IOException

Returns a har input stream which fakes end of file. It reads the index files to get the part file name and the size and start of the file.

Specified by:

open in class FileSystem

Parameters:

f - the file name to open

bufferSize - the size of the buffer to be used.

Returns:

input stream.

Throws:

java.io.IOException - IO failure

createPathHandle

protected PathHandle createPathHandle(FileStatus stat,
                                      Options.HandleOpt... opts)

Description copied from class: FileSystem

Hook to implement support for PathHandle operations.

Overrides:

createPathHandle in class FileSystem

Parameters:

stat - Referent in the target FileSystem

opts - Constraints that determine the validity of the PathHandle reference.

Returns:

path handle.

open

public FSDataInputStream open(PathHandle fd,
                              int bufferSize)
                       throws java.io.IOException

Description copied from class: FileSystem

Open an FSDataInputStream matching the PathHandle instance. The implementation may encode metadata in PathHandle to address the resource directly and verify that the resource referenced satisfies constraints specified at its construciton.

Overrides:

open in class FileSystem

Parameters:

fd - PathHandle object returned by the FS authority.

bufferSize - the size of the buffer to use

Returns:

input stream.

Throws:

InvalidPathHandleException - If PathHandle constraints are not satisfied

java.io.IOException - IO failure

getChildFileSystems

public FileSystem[] getChildFileSystems()

Used for delegation token related functionality. Must delegate to underlying file system.

Overrides:

getChildFileSystems in class FileSystem

Returns:

FileSystems that are direct children of this FileSystem, or null for "no children"

create

public FSDataOutputStream create(Path f,
                                 FsPermission permission,
                                 boolean overwrite,
                                 int bufferSize,
                                 short replication,
                                 long blockSize,
                                 Progressable progress)
                          throws java.io.IOException

Description copied from class: FileSystem

Create an FSDataOutputStream at the indicated Path with write-progress reporting.

Specified by:

create in class FileSystem

Parameters:

f - the file name to open

permission - file permission

overwrite - if a file with this name already exists, then if true, the file will be overwritten, and if false an error will be thrown.

bufferSize - the size of the buffer to be used.

replication - required block replication for the file.

blockSize - block size

progress - the progress reporter

Returns:

output stream.

Throws:

java.io.IOException - IO failure

See Also:

FileSystem.setPermission(Path, FsPermission)

createNonRecursive

public FSDataOutputStream createNonRecursive(Path f,
                                             boolean overwrite,
                                             int bufferSize,
                                             short replication,
                                             long blockSize,
                                             Progressable progress)
                                      throws java.io.IOException

Description copied from class: FileSystem

Opens an FSDataOutputStream at the indicated Path with write-progress reporting. Same as create(), except fails if parent directory doesn't already exist.

Overrides:

createNonRecursive in class FileSystem

Parameters:

f - the file name to open

overwrite - if a file with this name already exists, then if true, the file will be overwritten, and if false an error will be thrown.

bufferSize - the size of the buffer to be used.

replication - required block replication for the file.

blockSize - block size

progress - the progress reporter

Returns:

output stream.

Throws:

java.io.IOException - IO failure

See Also:

FileSystem.setPermission(Path, FsPermission)

append

public FSDataOutputStream append(Path f,
                                 int bufferSize,
                                 Progressable progress)
                          throws java.io.IOException

Description copied from class: FileSystem

Append to an existing file (optional operation).

Specified by:

append in class FileSystem

Parameters:

f - the existing file to be appended.

bufferSize - the size of the buffer to be used.

progress - for reporting progress if it is not null.

Returns:

output stream.

Throws:

java.io.IOException - IO failure

close

public void close()
           throws java.io.IOException

Description copied from class: FileSystem

Close this FileSystem instance. Will release any held locks, delete all files queued for deletion through calls to FileSystem.deleteOnExit(Path), and remove this FS instance from the cache, if cached. After this operation, the outcome of any method call on this FileSystem instance, or any input/output stream created by it is undefined.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Overrides:

close in class FileSystem

Throws:

java.io.IOException - IO failure

setReplication

public boolean setReplication(Path src,
                              short replication)
                       throws java.io.IOException

Not implemented.

Overrides:

setReplication in class FileSystem

Parameters:

src - file name

replication - new replication

Returns:

true if successful, or the feature in unsupported; false if replication is supported but the file does not exist, or is a directory

Throws:

java.io.IOException - an IO failure.

rename

public boolean rename(Path src,
                      Path dst)
               throws java.io.IOException

Description copied from class: FileSystem

Renames Path src to Path dst.

Specified by:

rename in class FileSystem

Parameters:

src - path to be renamed

dst - new path after rename

Returns:

true if rename is successful

Throws:

java.io.IOException - on failure

append

public FSDataOutputStream append(Path f)
                          throws java.io.IOException

Description copied from class: FileSystem

Append to an existing file (optional operation). Same as append(f, getConf().getInt(IO_FILE_BUFFER_SIZE_KEY, IO_FILE_BUFFER_SIZE_DEFAULT), null)

Overrides:

append in class FileSystem

Parameters:

f - the existing file to be appended.

Returns:

output stream.

Throws:

java.io.IOException - IO failure

truncate

public boolean truncate(Path f,
                        long newLength)
                 throws java.io.IOException

Not implemented.

Overrides:

truncate in class FileSystem

Parameters:

f - The path to the file to be truncated

newLength - The size the file is to be truncated to

Returns:

true if the file has been truncated to the desired newLength and is immediately available to be reused for write operations such as append, or false if a background process of adjusting the length of the last block has been started, and clients should wait for it to complete before proceeding with further file updates.

Throws:

java.io.IOException - IO failure

delete

public boolean delete(Path f,
                      boolean recursive)
               throws java.io.IOException

Not implemented.

Specified by:

delete in class FileSystem

Parameters:

f - the path to delete.

recursive - if path is a directory and set to true, the directory is deleted else throws an exception. In case of a file the recursive can be set to either true or false.

Returns:

true if delete is successful else false.

Throws:

java.io.IOException - IO failure

listStatus

public FileStatus[] listStatus(Path f)
                        throws java.io.IOException

liststatus returns the children of a directory after looking up the index files.

Specified by:

listStatus in class FileSystem

Parameters:

f - given path

Returns:

the statuses of the files/directories in the given patch

Throws:

java.io.FileNotFoundException - when the path does not exist

java.io.IOException - see specific implementation

getHomeDirectory

public Path getHomeDirectory()

return the top level archive path.

Overrides:

getHomeDirectory in class FileSystem

Returns:

the path.

setWorkingDirectory

public void setWorkingDirectory(Path newDir)

Description copied from class: FileSystem

Set the current working directory for the given FileSystem. All relative paths will be resolved relative to it.

Specified by:

setWorkingDirectory in class FileSystem

Parameters:

newDir - Path of new working directory

mkdirs

public boolean mkdirs(Path f,
                      FsPermission permission)
               throws java.io.IOException

not implemented.

Specified by:

mkdirs in class FileSystem

Parameters:

f - path to create

permission - to apply to f

Returns:

if mkdir success true, not false.

Throws:

java.io.IOException - IO failure

copyFromLocalFile

public void copyFromLocalFile(boolean delSrc,
                              boolean overwrite,
                              Path src,
                              Path dst)
                       throws java.io.IOException

not implemented.

Overrides:

copyFromLocalFile in class FileSystem

Parameters:

delSrc - whether to delete the src

overwrite - whether to overwrite an existing file

src - path

dst - path

Throws:

java.io.IOException - IO failure

copyFromLocalFile

public void copyFromLocalFile(boolean delSrc,
                              boolean overwrite,
                              Path[] srcs,
                              Path dst)
                       throws java.io.IOException

Description copied from class: FileSystem

The src files are on the local disk. Add it to the filesystem at the given dst name. delSrc indicates if the source should be removed

Overrides:

copyFromLocalFile in class FileSystem

Parameters:

delSrc - whether to delete the src

overwrite - whether to overwrite an existing file

srcs - array of paths which are source

dst - path

Throws:

java.io.IOException - IO failure

copyToLocalFile

public void copyToLocalFile(boolean delSrc,
                            Path src,
                            Path dst)
                     throws java.io.IOException

copies the file in the har filesystem to a local file.

Overrides:

copyToLocalFile in class FileSystem

Parameters:

delSrc - whether to delete the src

src - path src file in the remote filesystem

dst - path local destination

Throws:

java.io.IOException - IO failure

startLocalOutput

public Path startLocalOutput(Path fsOutputFile,
                             Path tmpLocalFile)
                      throws java.io.IOException

not implemented.

Overrides:

startLocalOutput in class FileSystem

Parameters:

fsOutputFile - path of output file

tmpLocalFile - path of local tmp file

Returns:

the path.

Throws:

java.io.IOException - IO failure

completeLocalOutput

public void completeLocalOutput(Path fsOutputFile,
                                Path tmpLocalFile)
                         throws java.io.IOException

not implemented.

Overrides:

completeLocalOutput in class FileSystem

Parameters:

fsOutputFile - path of output file

tmpLocalFile - path to local tmp file

Throws:

java.io.IOException - IO failure

setOwner

public void setOwner(Path p,
                     java.lang.String username,
                     java.lang.String groupname)
              throws java.io.IOException

not implemented.

Overrides:

setOwner in class FileSystem

Parameters:

p - The path

username - If it is null, the original username remains unchanged.

groupname - If it is null, the original groupname remains unchanged.

Throws:

java.io.IOException - IO failure

setTimes

public void setTimes(Path p,
                     long mtime,
                     long atime)
              throws java.io.IOException

Description copied from class: FileSystem

Set access time of a file.

Overrides:

setTimes in class FileSystem

Parameters:

p - The path

mtime - Set the modification time of this file. The number of milliseconds since Jan 1, 1970. A value of -1 means that this call should not set modification time.

atime - Set the access time of this file. The number of milliseconds since Jan 1, 1970. A value of -1 means that this call should not set access time.

Throws:

java.io.IOException - IO failure

setPermission

public void setPermission(Path p,
                          FsPermission permission)
                   throws java.io.IOException

Not implemented.

Overrides:

setPermission in class FileSystem

Parameters:

p - The path

permission - permission

Throws:

java.io.IOException - IO failure

hasPathCapability

public boolean hasPathCapability(Path path,
                                 java.lang.String capability)
                          throws java.io.IOException

Declare that this filesystem connector is always read only. The base FileSystem implementation generally has no knowledge of the capabilities of actual implementations. Unless it has a way to explicitly determine the capabilities, this method returns false. 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 FileSystem

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:

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

getServerDefaults

public FsServerDefaults getServerDefaults()
                                   throws java.io.IOException

Description copied from class: FileSystem

Return a set of server default configuration values.

Overrides:

getServerDefaults in class FileSystem

Returns:

server default configuration values

Throws:

java.io.IOException - IO failure

getServerDefaults

public FsServerDefaults getServerDefaults(Path f)
                                   throws java.io.IOException

Description copied from class: FileSystem

Return a set of server default configuration values.

Overrides:

getServerDefaults in class FileSystem

Parameters:

f - path is used to identify an FS since an FS could have another FS that it could be delegating the call to

Returns:

server default configuration values

Throws:

java.io.IOException - IO failure

getUsed

public long getUsed()
             throws java.io.IOException

Description copied from class: FileSystem

Return the total size of all files in the filesystem.

Overrides:

getUsed in class FileSystem

Returns:

the number of path used.

Throws:

java.io.IOException - IO failure

getUsed

public long getUsed(Path path)
             throws java.io.IOException

Return the total size of all files from a specified path.

Overrides:

getUsed in class FileSystem

Parameters:

path - the path.

Returns:

the number of path content summary.

Throws:

java.io.IOException - IO failure

getDefaultBlockSize

public long getDefaultBlockSize()

Description copied from class: FileSystem

Return the number of bytes that large input files should be optimally be split into to minimize I/O time.

Overrides:

getDefaultBlockSize in class FileSystem

Returns:

default block size.

getDefaultBlockSize

public long getDefaultBlockSize(Path f)

Description copied from class: FileSystem

Return the number of bytes that large input files should be optimally be split into to minimize I/O time. The given path will be used to locate the actual filesystem. The full path does not have to exist.

Overrides:

getDefaultBlockSize in class FileSystem

Parameters:

f - path of file

Returns:

the default block size for the path's filesystem

getDefaultReplication

public short getDefaultReplication()

Description copied from class: FileSystem

Get the default replication.

Overrides:

getDefaultReplication in class FileSystem

Returns:

the replication; the default value is "1".

getDefaultReplication

public short getDefaultReplication(Path f)

Description copied from class: FileSystem

Get the default replication for a path. The given path will be used to locate the actual FileSystem to query. The full path does not have to exist.

Overrides:

getDefaultReplication in class FileSystem

Parameters:

f - of the file

Returns:

default replication for the path's filesystem

createFile

public FSDataOutputStreamBuilder createFile(Path path)

Description copied from class: FileSystem

Create a new FSDataOutputStreamBuilder for the file with path. Files are overwritten by default.

Overrides:

createFile in class FileSystem

Parameters:

path - file path

Returns:

a FSDataOutputStreamBuilder object to build the file HADOOP-14384. Temporarily reduce the visibility of method before the builder interface becomes stable.

appendFile

public FSDataOutputStreamBuilder appendFile(Path path)

Description copied from class: FileSystem

Create a Builder to append a file.

Overrides:

appendFile in class FileSystem

Parameters:

path - file path.

Returns:

a FSDataOutputStreamBuilder to build file append request.