ChecksumFileSystem (Apache Hadoop Main 3.0.0-alpha2-SNAPSHOT API)

java.lang.Object
- org.apache.hadoop.conf.Configured
- - org.apache.hadoop.fs.FileSystem
  - - org.apache.hadoop.fs.FilterFileSystem
    - - org.apache.hadoop.fs.ChecksumFileSystem

すべての実装されたインタフェース:

Closeable, AutoCloseable, Configurable

直系の既知のサブクラス:

LocalFileSystem
```
@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract class ChecksumFileSystem
extends FilterFileSystem
```
Abstract Checksumed FileSystem. It provide a basic implementation of a Checksumed FileSystem, which creates a checksum file for each raw file. It generates & verifies checksums at the client side.

フィールドのサマリー
- クラスから継承されたフィールド org.apache.hadoop.fs.FilterFileSystem
  fs, swapScheme
- クラスから継承されたフィールド org.apache.hadoop.fs.FileSystem
  DEFAULT_FS, FS_DEFAULT_NAME_KEY, LOG, SHUTDOWN_HOOK_PRIORITY, statistics, TRASH_PREFIX

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明

ChecksumFileSystem(FileSystem fs)

コンストラクタ
コンストラクタと説明
`ChecksumFileSystem(FileSystem fs)`

メソッドのサマリー

すべてのメソッド staticメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`FSDataOutputStream`	`append(Path f, int bufferSize, Progressable progress)` Append to an existing file (optional operation).
`void`	`completeLocalOutput(Path fsOutputFile, Path tmpLocalFile)` Called when we're all done writing to the target.
`void`	`copyFromLocalFile(boolean delSrc, Path src, Path dst)` The src file is on the local disk.
`void`	`copyToLocalFile(boolean delSrc, Path src, Path dst)` The src file is under FS, and the dst is on the local disk.
`void`	`copyToLocalFile(Path src, Path dst, boolean copyCrc)` The src file is under FS, and the dst is on the local disk.
`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.
`FSDataOutputStream`	`createNonRecursive(Path f, FsPermission permission, boolean overwrite, int bufferSize, short replication, long blockSize, Progressable progress)` Opens an FSDataOutputStream at the indicated Path with write-progress reporting.
`boolean`	`delete(Path f, boolean recursive)` Implement the delete(Path, boolean) in checksum file system.
`static double`	`getApproxChkSumLength(long size)`
`int`	`getBytesPerSum()` Return the bytes Per Checksum
`Path`	`getChecksumFile(Path file)` Return the name of the checksum file associated with a file.
`long`	`getChecksumFileLength(Path file, long fileSize)` Return the length of the checksum file given the size of the actual file.
`static long`	`getChecksumLength(long size, int bytesPerSum)` Calculated the length of the checksum file in bytes.
`FileSystem`	`getRawFileSystem()` get the raw file system
`static boolean`	`isChecksumFile(Path file)` Return true iff file is a checksum file name.
`org.apache.hadoop.fs.RemoteIterator<LocatedFileStatus>`	`listLocatedStatus(Path f)` List the statuses of the files/directories in the given path if the path is a directory.
`FileStatus[]`	`listStatus(Path f)` List the statuses of the files/directories in the given path if the path is a directory.
`boolean`	`mkdirs(Path f)` Call `FileSystem.mkdirs(Path, FsPermission)` with default permission.
`void`	`modifyAclEntries(Path src, List<AclEntry> aclSpec)` Modifies ACL entries of files and directories.
`FSDataInputStream`	`open(Path f, int bufferSize)` Opens an FSDataInputStream at the indicated Path.
`void`	`removeAcl(Path src)` Removes all but the base ACL entries of files and directories.
`void`	`removeAclEntries(Path src, List<AclEntry> aclSpec)` Removes ACL entries from files and directories.
`void`	`removeDefaultAcl(Path src)` Removes all default ACL entries from files and directories.
`boolean`	`rename(Path src, Path dst)` Rename files/dirs
`boolean`	`reportChecksumFailure(Path f, FSDataInputStream in, long inPos, FSDataInputStream sums, long sumsPos)` Report a checksum error to the file system.
`void`	`setAcl(Path src, List<AclEntry> aclSpec)` Fully replaces ACL of files and directories, discarding all existing entries.
`void`	`setConf(Configuration conf)` Set the configuration to be used by this object.
`void`	`setOwner(Path src, String username, String groupname)` Set owner of a path (i.e. a file or a directory).
`void`	`setPermission(Path src, FsPermission permission)` Set permission of a path.
`boolean`	`setReplication(Path src, short replication)` Set replication for an existing file.
`void`	`setVerifyChecksum(boolean verifyChecksum)` Set whether to verify checksum.
`void`	`setWriteChecksum(boolean writeChecksum)` Set the write checksum flag.
`Path`	`startLocalOutput(Path fsOutputFile, Path tmpLocalFile)` Returns a local File that the user can write output to.
`boolean`	`truncate(Path f, long newLength)` Truncate the file in the indicated path to the indicated size.

クラスから継承されたメソッド org.apache.hadoop.fs.FilterFileSystem
access, canonicalizeUri, checkPath, close, concat, copyFromLocalFile, copyFromLocalFile, create, createNonRecursive, createSnapshot, createSymlink, deleteSnapshot, getAclStatus, getAllStoragePolicies, getCanonicalUri, getChildFileSystems, getConf, getDefaultBlockSize, getDefaultBlockSize, getDefaultReplication, getDefaultReplication, getFileBlockLocations, getFileChecksum, getFileChecksum, getFileLinkStatus, getFileStatus, getHomeDirectory, getInitialWorkingDirectory, getLinkTarget, getServerDefaults, getServerDefaults, getStatus, getStoragePolicy, getTrashRoot, getTrashRoots, getUri, getUsed, getUsed, getWorkingDirectory, getXAttr, getXAttrs, getXAttrs, initialize, listCorruptFileBlocks, listLocatedStatus, listStatusIterator, listXAttrs, makeQualified, mkdirs, primitiveCreate, primitiveMkdir, removeXAttr, renameSnapshot, resolveLink, resolvePath, setStoragePolicy, setTimes, setWorkingDirectory, setXAttr, setXAttr, supportsSymlinks, unsetStoragePolicy

クラスから継承されたメソッド org.apache.hadoop.fs.FileSystem
append, append, areSymlinksEnabled, cancelDeleteOnExit, clearStatistics, closeAll, closeAllForUGI, copyFromLocalFile, copyToLocalFile, copyToLocalFile, create, create, create, create, create, create, create, create, create, create, create, createNewFile, createNonRecursive, createSnapshot, delete, deleteOnExit, enableSymlinks, exists, fixRelativePart, get, get, get, getAllStatistics, getBlockSize, getContentSummary, getDefaultPort, getDefaultUri, getFileBlockLocations, getFileSystemClass, getFSofPath, getGlobalStorageStatistics, getLength, getLocal, getName, getNamed, getQuotaUsage, getReplication, getScheme, getStatistics, getStatistics, getStatus, getStorageStatistics, globStatus, globStatus, isDirectory, isFile, listFiles, listStatus, listStatus, listStatus, mkdirs, moveFromLocalFile, moveFromLocalFile, moveToLocalFile, newInstance, newInstance, newInstance, newInstanceLocal, open, primitiveMkdir, printStatistics, processDeleteOnExit, rename, setDefaultUri, setDefaultUri

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - ChecksumFileSystem
```
public ChecksumFileSystem(FileSystem fs)
```
- メソッドの詳細
  - getApproxChkSumLength
```
public static double getApproxChkSumLength(long size)
```
  - setConf
```
public void setConf(Configuration conf)
```
    インタフェースからコピーされた説明: Configurable
    
    Set the configuration to be used by this object.
    
    定義:
    
    setConf インタフェース内 Configurable
    
    オーバーライド:
    
    setConf クラス内 Configured
  - setVerifyChecksum
```
public void setVerifyChecksum(boolean verifyChecksum)
```
    Set whether to verify checksum.
    
    オーバーライド:
    
    setVerifyChecksum クラス内 FilterFileSystem
    
    パラメータ:
    
    verifyChecksum - Verify checksum flag
  - setWriteChecksum
```
public void setWriteChecksum(boolean writeChecksum)
```
    クラスからコピーされた説明: FileSystem
    
    Set the write checksum flag. This is only applicable if the corresponding FileSystem supports checksum. By default doesn't do anything.
    
    オーバーライド:
    
    setWriteChecksum クラス内 FilterFileSystem
    
    パラメータ:
    
    writeChecksum - Write checsum flag
  - getRawFileSystem
```
public FileSystem getRawFileSystem()
```
    get the raw file system
    
    オーバーライド:
    
    getRawFileSystem クラス内 FilterFileSystem
    
    戻り値:
    
    FileSystem being filtered
  - getChecksumFile
```
public Path getChecksumFile(Path file)
```
    Return the name of the checksum file associated with a file.
  - isChecksumFile
```
public static boolean isChecksumFile(Path file)
```
    Return true iff file is a checksum file name.
  - getChecksumFileLength
```
public long getChecksumFileLength(Path file,
                                  long fileSize)
```
    Return the length of the checksum file given the size of the actual file.
  - getBytesPerSum
```
public int getBytesPerSum()
```
    Return the bytes Per Checksum
  - open
```
public FSDataInputStream open(Path f,
                              int bufferSize)
                       throws IOException
```
    Opens an FSDataInputStream at the indicated Path.
    
    オーバーライド:
    
    open クラス内 FilterFileSystem
    
    パラメータ:
    
    f - the file name to open
    
    bufferSize - the size of the buffer to be used.
    
    例外:
    
    IOException
  - append
```
public FSDataOutputStream append(Path f,
                                 int bufferSize,
                                 Progressable progress)
                          throws IOException
```
    クラスからコピーされた説明: FileSystem
    
    Append to an existing file (optional operation).
    
    オーバーライド:
    
    append クラス内 FilterFileSystem
    
    パラメータ:
    
    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.
    
    例外:
    
    IOException
  - truncate
```
public boolean truncate(Path f,
                        long newLength)
                 throws IOException
```
    クラスからコピーされた説明: FileSystem
    Truncate the file in the indicated path to the indicated size.
    - Fails if path is a directory.
    - Fails if path does not exist.
    - Fails if path is not closed.
    - Fails if new size is greater than current size.
    オーバーライド:
    
    truncate クラス内 FilterFileSystem
    
    パラメータ:
    
    f - The path to the file to be truncated
    
    newLength - The size the file is to be truncated to
    
    戻り値:
    
    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.
    
    例外:
    
    IOException
  - getChecksumLength
```
public static long getChecksumLength(long size,
                                     int bytesPerSum)
```
    Calculated the length of the checksum file in bytes.
    
    パラメータ:
    
    size - the length of the data file in bytes
    
    bytesPerSum - the number of bytes in a checksum block
    
    戻り値:
    
    the number of bytes in the checksum file
  - create
```
public FSDataOutputStream create(Path f,
                                 FsPermission permission,
                                 boolean overwrite,
                                 int bufferSize,
                                 short replication,
                                 long blockSize,
                                 Progressable progress)
                          throws IOException
```
    クラスからコピーされた説明: FileSystem
    
    Create an FSDataOutputStream at the indicated Path with write-progress reporting.
    
    オーバーライド:
    
    create クラス内 FilterFileSystem
    
    パラメータ:
    
    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
    
    例外:
    
    IOException
    
    関連項目:
    
    FileSystem.setPermission(Path, FsPermission)
  - createNonRecursive
```
public FSDataOutputStream createNonRecursive(Path f,
                                             FsPermission permission,
                                             boolean overwrite,
                                             int bufferSize,
                                             short replication,
                                             long blockSize,
                                             Progressable progress)
                                      throws IOException
```
    クラスからコピーされた説明: FileSystem
    
    Opens an FSDataOutputStream at the indicated Path with write-progress reporting. Same as create(), except fails if parent directory doesn't already exist.
    
    オーバーライド:
    
    createNonRecursive クラス内 FileSystem
    
    パラメータ:
    
    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
    
    例外:
    
    IOException
    
    関連項目:
    
    FileSystem.setPermission(Path, FsPermission)
  - setPermission
```
public void setPermission(Path src,
                          FsPermission permission)
                   throws IOException
```
    クラスからコピーされた説明: FileSystem
    
    Set permission of a path.
    
    オーバーライド:
    
    setPermission クラス内 FilterFileSystem
    
    パラメータ:
    
    src - The path
    
    permission - permission
    
    例外:
    
    IOException
  - setOwner
```
public void setOwner(Path src,
                     String username,
                     String groupname)
              throws IOException
```
    クラスからコピーされた説明: FileSystem
    
    Set owner of a path (i.e. a file or a directory). The parameters username and groupname cannot both be null.
    
    オーバーライド:
    
    setOwner クラス内 FilterFileSystem
    
    パラメータ:
    
    src - The path
    
    username - If it is null, the original username remains unchanged.
    
    groupname - If it is null, the original groupname remains unchanged.
    
    例外:
    
    IOException
  - setAcl
```
public void setAcl(Path src,
                   List<AclEntry> aclSpec)
            throws IOException
```
    クラスからコピーされた説明: FileSystem
    
    Fully replaces ACL of files and directories, discarding all existing entries.
    
    オーバーライド:
    
    setAcl クラス内 FilterFileSystem
    
    パラメータ:
    
    src - Path to modify
    
    aclSpec - List describing modifications, must include entries for user, group, and others for compatibility with permission bits.
    
    例外:
    
    IOException - if an ACL could not be modified
  - modifyAclEntries
```
public void modifyAclEntries(Path src,
                             List<AclEntry> aclSpec)
                      throws IOException
```
    クラスからコピーされた説明: FileSystem
    
    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.)
    
    オーバーライド:
    
    modifyAclEntries クラス内 FilterFileSystem
    
    パラメータ:
    
    src - Path to modify
    
    aclSpec - List describing modifications
    
    例外:
    
    IOException - if an ACL could not be modified
  - removeAcl
```
public void removeAcl(Path src)
               throws IOException
```
    クラスからコピーされた説明: FileSystem
    
    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.
    
    オーバーライド:
    
    removeAcl クラス内 FilterFileSystem
    
    パラメータ:
    
    src - Path to modify
    
    例外:
    
    IOException - if an ACL could not be removed
  - removeAclEntries
```
public void removeAclEntries(Path src,
                             List<AclEntry> aclSpec)
                      throws IOException
```
    クラスからコピーされた説明: FileSystem
    
    Removes ACL entries from files and directories. Other ACL entries are retained.
    
    オーバーライド:
    
    removeAclEntries クラス内 FilterFileSystem
    
    パラメータ:
    
    src - Path to modify
    
    aclSpec - List describing entries to remove
    
    例外:
    
    IOException - if an ACL could not be modified
  - removeDefaultAcl
```
public void removeDefaultAcl(Path src)
                      throws IOException
```
    クラスからコピーされた説明: FileSystem
    
    Removes all default ACL entries from files and directories.
    
    オーバーライド:
    
    removeDefaultAcl クラス内 FilterFileSystem
    
    パラメータ:
    
    src - Path to modify
    
    例外:
    
    IOException - if an ACL could not be modified
  - setReplication
```
public boolean setReplication(Path src,
                              short replication)
                       throws IOException
```
    Set replication for an existing file. Implement the abstract setReplication of FileSystem
    
    オーバーライド:
    
    setReplication クラス内 FilterFileSystem
    
    パラメータ:
    
    src - file name
    
    replication - new replication
    
    戻り値:
    
    true if successful; false if file does not exist or is a directory
    
    例外:
    
    IOException
  - rename
```
public boolean rename(Path src,
                      Path dst)
               throws IOException
```
    Rename files/dirs
    
    オーバーライド:
    
    rename クラス内 FilterFileSystem
    
    パラメータ:
    
    src - path to be renamed
    
    dst - new path after rename
    
    戻り値:
    
    true if rename is successful
    
    例外:
    
    IOException - on failure
  - delete
```
public boolean delete(Path f,
                      boolean recursive)
               throws IOException
```
    Implement the delete(Path, boolean) in checksum file system.
    
    オーバーライド:
    
    delete クラス内 FilterFileSystem
    
    パラメータ:
    
    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.
    
    戻り値:
    
    true if delete is successful else false.
    
    例外:
    
    IOException
  - listStatus
```
public FileStatus[] listStatus(Path f)
                        throws IOException
```
    List the statuses of the files/directories in the given path if the path is a directory.
    
    オーバーライド:
    
    listStatus クラス内 FilterFileSystem
    
    パラメータ:
    
    f - given path
    
    戻り値:
    
    the statuses of the files/directories in the given path
    
    例外:
    
    IOException
    
    FileNotFoundException - when the path does not exist; IOException see specific implementation
  - listLocatedStatus
```
public org.apache.hadoop.fs.RemoteIterator<LocatedFileStatus> listLocatedStatus(Path f)
                                                                         throws IOException
```
    List the statuses of the files/directories in the given path if the path is a directory.
    
    オーバーライド:
    
    listLocatedStatus クラス内 FilterFileSystem
    
    パラメータ:
    
    f - given path
    
    戻り値:
    
    the statuses of the files/directories in the given patch
    
    例外:
    
    IOException
    
    FileNotFoundException - If f does not exist
  - mkdirs
```
public boolean mkdirs(Path f)
               throws IOException
```
    クラスからコピーされた説明: FileSystem
    
    Call FileSystem.mkdirs(Path, FsPermission) with default permission.
    
    オーバーライド:
    
    mkdirs クラス内 FileSystem
    
    例外:
    
    IOException
  - copyFromLocalFile
```
public void copyFromLocalFile(boolean delSrc,
                              Path src,
                              Path dst)
                       throws IOException
```
    クラスからコピーされた説明: FilterFileSystem
    
    The src file is on the local disk. Add it to FS at the given dst name. delSrc indicates if the source should be removed
    
    オーバーライド:
    
    copyFromLocalFile クラス内 FilterFileSystem
    
    パラメータ:
    
    delSrc - whether to delete the src
    
    src - path
    
    dst - path
    
    例外:
    
    IOException
  - copyToLocalFile
```
public void copyToLocalFile(boolean delSrc,
                            Path src,
                            Path dst)
                     throws IOException
```
    The src file is under FS, and the dst is on the local disk. Copy it from FS control to the local dst name.
    
    オーバーライド:
    
    copyToLocalFile クラス内 FilterFileSystem
    
    パラメータ:
    
    delSrc - whether to delete the src
    
    src - path
    
    dst - path
    
    例外:
    
    IOException
  - copyToLocalFile
```
public void copyToLocalFile(Path src,
                            Path dst,
                            boolean copyCrc)
                     throws IOException
```
    The src file is under FS, and the dst is on the local disk. Copy it from FS control to the local dst name. If src and dst are directories, the copyCrc parameter determines whether to copy CRC files.
    
    例外:
    
    IOException
  - startLocalOutput
```
public Path startLocalOutput(Path fsOutputFile,
                             Path tmpLocalFile)
                      throws IOException
```
    クラスからコピーされた説明: FilterFileSystem
    
    Returns a local File that the user can write output to. The caller provides both the eventual FS target name and the local working file. If the FS is local, we write directly into the target. If the FS is remote, we write into the tmp local area.
    
    オーバーライド:
    
    startLocalOutput クラス内 FilterFileSystem
    
    パラメータ:
    
    fsOutputFile - path of output file
    
    tmpLocalFile - path of local tmp file
    
    例外:
    
    IOException
  - completeLocalOutput
```
public void completeLocalOutput(Path fsOutputFile,
                                Path tmpLocalFile)
                         throws IOException
```
    クラスからコピーされた説明: FilterFileSystem
    
    Called when we're all done writing to the target. A local FS will do nothing, because we've written to exactly the right place. A remote FS will copy the contents of tmpLocalFile to the correct target at fsOutputFile.
    
    オーバーライド:
    
    completeLocalOutput クラス内 FilterFileSystem
    
    パラメータ:
    
    fsOutputFile - path of output file
    
    tmpLocalFile - path to local tmp file
    
    例外:
    
    IOException
  - reportChecksumFailure
```
public boolean reportChecksumFailure(Path f,
                                     FSDataInputStream in,
                                     long inPos,
                                     FSDataInputStream sums,
                                     long sumsPos)
```
    Report a checksum error to the file system.
    
    パラメータ:
    
    f - the file name containing the error
    
    in - the stream open on the file
    
    inPos - the position of the beginning of the bad data in the file
    
    sums - the stream open on the checksum file
    
    sumsPos - the position of the beginning of the bad data in the checksum file
    
    戻り値:
    
    if retry is necessary

クラス ChecksumFileSystem

フィールドのサマリー

クラスから継承されたフィールド org.apache.hadoop.fs.FilterFileSystem

クラスから継承されたフィールド org.apache.hadoop.fs.FileSystem

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド org.apache.hadoop.fs.FilterFileSystem

クラスから継承されたメソッド org.apache.hadoop.fs.FileSystem

クラスから継承されたメソッド java.lang.Object

コンストラクタの詳細

ChecksumFileSystem

メソッドの詳細

getApproxChkSumLength

setConf

setVerifyChecksum

setWriteChecksum

getRawFileSystem

getChecksumFile

isChecksumFile

getChecksumFileLength

getBytesPerSum

open

append

truncate

getChecksumLength

create

createNonRecursive

setPermission

setOwner

setAcl

modifyAclEntries

removeAcl

removeAclEntries

removeDefaultAcl

setReplication

rename

delete

listStatus

listLocatedStatus

mkdirs

copyFromLocalFile

copyToLocalFile

copyToLocalFile

startLocalOutput

completeLocalOutput

reportChecksumFailure