Package org.apache.hadoop.tools

Class CopyListingFileStatus

java.lang.Object

org.apache.hadoop.tools.CopyListingFileStatus

All Implemented Interfaces:

org.apache.hadoop.io.Writable

@LimitedPrivate("Distcp support tools")
@Unstable
public final class CopyListingFileStatus
extends java.lang.Object
implements org.apache.hadoop.io.Writable

CopyListingFileStatus is a view of FileStatus, recording additional data members useful to distcp. This is the datastructure persisted in the sequence files generated in the CopyCommitter when deleting files. Any tool working with these generated files needs to be aware of an important stability guarantee: there is none; expect it to change across minor Hadoop releases without any support for reading the files of different versions. Tools parsing the listings must be built and tested against the point release of Hadoop which they intend to support.

Constructor Summary

Constructors

Constructor	Description
CopyListingFileStatus()	Default constructor.
CopyListingFileStatus(long length, boolean isdir, int blockReplication, long blocksize, long modificationTime, long accessTime, org.apache.hadoop.fs.permission.FsPermission permission, java.lang.String owner, java.lang.String group, org.apache.hadoop.fs.Path path, long chunkOffset, long chunkLength, org.apache.hadoop.fs.Path symlink)
CopyListingFileStatus(long length, boolean isdir, int blockReplication, long blocksize, long modificationTime, long accessTime, org.apache.hadoop.fs.permission.FsPermission permission, java.lang.String owner, java.lang.String group, org.apache.hadoop.fs.Path path, org.apache.hadoop.fs.Path symlink)
CopyListingFileStatus(org.apache.hadoop.fs.FileStatus fileStatus)	Creates a new CopyListingFileStatus by copying the members of the given FileStatus.
CopyListingFileStatus(org.apache.hadoop.fs.FileStatus fileStatus, long chunkOffset, long chunkLength)
CopyListingFileStatus(CopyListingFileStatus other)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
long	getAccessTime()
java.util.List<org.apache.hadoop.fs.permission.AclEntry>	getAclEntries()	Returns the full logical ACL.
long	getBlockSize()
long	getChunkLength()
long	getChunkOffset()
java.lang.String	getGroup()
long	getLen()
long	getModificationTime()
java.lang.String	getOwner()
org.apache.hadoop.fs.Path	getPath()
org.apache.hadoop.fs.permission.FsPermission	getPermission()
short	getReplication()
long	getSizeToCopy()
org.apache.hadoop.fs.Path	getSourceLink()
org.apache.hadoop.fs.Path	getSymlink()
java.util.Map<java.lang.String,byte[]>	getXAttrs()	Returns all xAttrs.
int	hashCode()
boolean	isDirectory()
boolean	isErasureCoded()
boolean	isSplit()
boolean	isSymlink()
void	readFields(java.io.DataInput in)
void	setAclEntries(java.util.List<org.apache.hadoop.fs.permission.AclEntry> aclEntries)	Sets optional ACL entries.
void	setChunkLength(long chunkLength)
void	setChunkOffset(long offset)
void	setPath(org.apache.hadoop.fs.Path path)
void	setSourceLink(org.apache.hadoop.fs.Path p)
void	setSymlink(org.apache.hadoop.fs.Path p)
void	setXAttrs(java.util.Map<java.lang.String,byte[]> xAttrs)	Sets optional xAttrs.
java.lang.String	toString()
void	write(java.io.DataOutput out)

Methods inherited from class java.lang.Object

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

Constructor Detail

CopyListingFileStatus

public CopyListingFileStatus()

Default constructor.

CopyListingFileStatus

public CopyListingFileStatus(org.apache.hadoop.fs.FileStatus fileStatus)
                      throws java.io.IOException

Creates a new CopyListingFileStatus by copying the members of the given FileStatus.

Parameters:

fileStatus - FileStatus to copy

Throws:

java.io.IOException

CopyListingFileStatus

public CopyListingFileStatus(org.apache.hadoop.fs.FileStatus fileStatus,
                             long chunkOffset,
                             long chunkLength)
                      throws java.io.IOException

Throws:

java.io.IOException

CopyListingFileStatus

public CopyListingFileStatus(long length,
                             boolean isdir,
                             int blockReplication,
                             long blocksize,
                             long modificationTime,
                             long accessTime,
                             org.apache.hadoop.fs.permission.FsPermission permission,
                             java.lang.String owner,
                             java.lang.String group,
                             org.apache.hadoop.fs.Path path,
                             org.apache.hadoop.fs.Path symlink)

CopyListingFileStatus

public CopyListingFileStatus(long length,
                             boolean isdir,
                             int blockReplication,
                             long blocksize,
                             long modificationTime,
                             long accessTime,
                             org.apache.hadoop.fs.permission.FsPermission permission,
                             java.lang.String owner,
                             java.lang.String group,
                             org.apache.hadoop.fs.Path path,
                             long chunkOffset,
                             long chunkLength,
                             org.apache.hadoop.fs.Path symlink)

CopyListingFileStatus

public CopyListingFileStatus(CopyListingFileStatus other)

Method Detail

getPath

public org.apache.hadoop.fs.Path getPath()

getLen

public long getLen()

getBlockSize

public long getBlockSize()

isDirectory

public boolean isDirectory()

getReplication

public short getReplication()

getModificationTime

public long getModificationTime()

getOwner

public java.lang.String getOwner()

getGroup

public java.lang.String getGroup()

getAccessTime

public long getAccessTime()

getPermission

public org.apache.hadoop.fs.permission.FsPermission getPermission()

isErasureCoded

public boolean isErasureCoded()

getAclEntries

public java.util.List<org.apache.hadoop.fs.permission.AclEntry> getAclEntries()

Returns the full logical ACL.

Returns:

List containing full logical ACL

setAclEntries

public void setAclEntries(java.util.List<org.apache.hadoop.fs.permission.AclEntry> aclEntries)

Sets optional ACL entries.

Parameters:

aclEntries - List containing all ACL entries

getXAttrs

public java.util.Map<java.lang.String,byte[]> getXAttrs()

Returns all xAttrs.

Returns:

Map containing all xAttrs

setXAttrs

public void setXAttrs(java.util.Map<java.lang.String,byte[]> xAttrs)

Sets optional xAttrs.

Parameters:

xAttrs - Map containing all xAttrs

getChunkOffset

public long getChunkOffset()

setChunkOffset

public void setChunkOffset(long offset)

getChunkLength

public long getChunkLength()

setChunkLength

public void setChunkLength(long chunkLength)

setSymlink

public void setSymlink(org.apache.hadoop.fs.Path p)

getSymlink

public org.apache.hadoop.fs.Path getSymlink()

setSourceLink

public void setSourceLink(org.apache.hadoop.fs.Path p)

getSourceLink

public org.apache.hadoop.fs.Path getSourceLink()

isSymlink

public boolean isSymlink()

setPath

public void setPath(org.apache.hadoop.fs.Path path)

isSplit

public boolean isSplit()

getSizeToCopy

public long getSizeToCopy()

write

public void write(java.io.DataOutput out)
           throws java.io.IOException

Specified by:

write in interface org.apache.hadoop.io.Writable

Throws:

java.io.IOException

readFields

public void readFields(java.io.DataInput in)
                throws java.io.IOException

Specified by:

readFields in interface org.apache.hadoop.io.Writable

Throws:

java.io.IOException

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object