## Uses of Class
org.apache.hadoop.fs.permission.FsPermission

- Packages that use FsPermission
  Package | Description
  --- | ---
  org.apache.hadoop.fs | Implementations of `AbstractFileSystem` for hdfs over rpc and hdfs over web.
  org.apache.hadoop.fs.adl | Supporting classes for metrics instrumentation.
  org.apache.hadoop.fs.azure | A distributed implementation of `FileSystem` for reading and writing files on Azure Block Storage.
  org.apache.hadoop.fs.azurebfs | A distributed implementation of `FileSystem` for reading and writing files on Azure Storage.
  org.apache.hadoop.fs.ftp |
  org.apache.hadoop.fs.permission | This package provides support for HDFS permission and ACL.
  org.apache.hadoop.fs.s3native | A distributed implementation of `FileSystem` for reading and writing files on Amazon S3.
  org.apache.hadoop.fs.viewfs | ViewFileSystem and ViewFileSystemOverloadScheme classes.
  org.apache.hadoop.hdfs.inotify |
  org.apache.hadoop.hdfs.protocol | Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.
  org.apache.hadoop.hdfs.server.namenode |
  org.apache.hadoop.yarn.logaggregation.filecontroller |

- - ### Uses of FsPermission in org.apache.hadoop.fs

    Fields in org.apache.hadoop.fs declared as FsPermission
    Modifier and Type | Field and Description
    --- | ---
    `static FsPermission` | FileContext.`DEFAULT_PERM` Default permission for directory and symlink In previous versions, this default permission was also used to create files, so files created end up with ugo+x permission.
    `static FsPermission` | FileContext.`DIR_DEFAULT_PERM` Default permission for directory
    `static FsPermission` | FileContext.`FILE_DEFAULT_PERM` Default permission for file

    Methods in org.apache.hadoop.fs that return FsPermission
    Modifier and Type | Method and Description
    --- | ---
    `FsPermission` | FileStatus.`getPermission()` Get FsPermission associated with the file.
    `protected FsPermission` | FSDataOutputStreamBuilder.`getPermission()`
    `FsPermission` | FileContext.`getUMask()`

    Methods in org.apache.hadoop.fs with parameters of type FsPermission
    Modifier and Type | Method and Description
    --- | ---
    `static FSDataOutputStream` | FileSystem.`create(FileSystem fs, Path file, FsPermission permission)` Create a file with the provided permission.
    `FSDataOutputStream` | RawLocalFileSystem.`create(Path f, FsPermission permission, boolean overwrite, int bufferSize, short replication, long blockSize, Progressable progress)`
    `abstract FSDataOutputStream` | FileSystem.`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` | FilterFileSystem.`create(Path f, FsPermission permission, boolean overwrite, int bufferSize, short replication, long blockSize, Progressable progress)`
    `FSDataOutputStream` | ChecksumFileSystem.`create(Path f, FsPermission permission, boolean overwrite, int bufferSize, short replication, long blockSize, Progressable progress)`
    `FSDataOutputStream` | FileSystem.`create(Path f, FsPermission permission, EnumSet<CreateFlag> flags, int bufferSize, short replication, long blockSize, Progressable progress)` Create an FSDataOutputStream at the indicated Path with write-progress reporting.
    `FSDataOutputStream` | FileSystem.`create(Path f, FsPermission permission, EnumSet<CreateFlag> flags, int bufferSize, short replication, long blockSize, Progressable progress, org.apache.hadoop.fs.Options.ChecksumOpt checksumOpt)` Create an FSDataOutputStream at the indicated Path with a custom checksum option.
    `FSDataOutputStream` | FilterFileSystem.`create(Path f, FsPermission permission, EnumSet<CreateFlag> flags, int bufferSize, short replication, long blockSize, Progressable progress, org.apache.hadoop.fs.Options.ChecksumOpt checksumOpt)`
    `abstract FSDataOutputStream` | AbstractFileSystem.`createInternal(Path f, EnumSet<CreateFlag> flag, FsPermission absolutePermission, int bufferSize, short replication, long blockSize, Progressable progress, org.apache.hadoop.fs.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.
    `FSDataOutputStream` | RawLocalFileSystem.`createNonRecursive(Path f, FsPermission permission, boolean overwrite, int bufferSize, short replication, long blockSize, Progressable progress)`
    `FSDataOutputStream` | FileSystem.`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.
    `FSDataOutputStream` | ChecksumFileSystem.`createNonRecursive(Path f, FsPermission permission, boolean overwrite, int bufferSize, short replication, long blockSize, Progressable progress)`
    `FSDataOutputStream` | RawLocalFileSystem.`createNonRecursive(Path f, FsPermission permission, EnumSet<CreateFlag> flags, int bufferSize, short replication, long blockSize, Progressable progress)`
    `FSDataOutputStream` | FileSystem.`createNonRecursive(Path f, FsPermission permission, EnumSet<CreateFlag> flags, int bufferSize, short replication, long blockSize, Progressable progress)` Opens an FSDataOutputStream at the indicated Path with write-progress reporting.
    `FSDataOutputStream` | FilterFileSystem.`createNonRecursive(Path f, FsPermission permission, EnumSet<CreateFlag> flags, int bufferSize, short replication, long blockSize, Progressable progress)`
    `protected OutputStream` | RawLocalFileSystem.`createOutputStreamWithMode(Path f, boolean append, FsPermission permission)`
    `void` | FileContext.`mkdir(Path dir, FsPermission permission, boolean createParent)` Make(create) a directory and all the non-existent parents.
    `abstract void` | AbstractFileSystem.`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.
    `static boolean` | FileSystem.`mkdirs(FileSystem fs, Path dir, FsPermission permission)` Create a directory with the provided permission.
    `boolean` | RawLocalFileSystem.`mkdirs(Path f, FsPermission permission)`
    `abstract boolean` | FileSystem.`mkdirs(Path f, FsPermission permission)` Make the given file and all non-existent parents into directories.
    `boolean` | FilterFileSystem.`mkdirs(Path f, FsPermission permission)`
    `protected boolean` | RawLocalFileSystem.`mkOneDirWithMode(Path p, File p2f, FsPermission permission)`
    `B` | FSDataOutputStreamBuilder.`permission(FsPermission perm)` Set permission for the file.
    `protected FSDataOutputStream` | FileSystem.`primitiveCreate(Path f, FsPermission absolutePermission, EnumSet<CreateFlag> flag, int bufferSize, short replication, long blockSize, Progressable progress, org.apache.hadoop.fs.Options.ChecksumOpt checksumOpt)` Deprecated.
    `protected FSDataOutputStream` | FilterFileSystem.`primitiveCreate(Path f, FsPermission absolutePermission, EnumSet<CreateFlag> flag, int bufferSize, short replication, long blockSize, Progressable progress, org.apache.hadoop.fs.Options.ChecksumOpt checksumOpt)`
    `protected boolean` | FileSystem.`primitiveMkdir(Path f, FsPermission absolutePermission)` Deprecated.
    `protected boolean` | FilterFileSystem.`primitiveMkdir(Path f, FsPermission abdolutePermission)`
    `protected void` | FileSystem.`primitiveMkdir(Path f, FsPermission absolutePermission, boolean createParent)` Deprecated.
    `static void` | FileUtil.`setPermission(File f, FsPermission permission)` Set permissions to the required value.
    `protected void` | FileStatus.`setPermission(FsPermission permission)` Sets permission.
    `void` | RawLocalFileSystem.`setPermission(Path p, FsPermission permission)` Use the command chmod to set permission.
    `void` | FileContext.`setPermission(Path f, FsPermission permission)` Set permission of a path.
    `void` | FileSystem.`setPermission(Path p, FsPermission permission)` Set permission of a path.
    `void` | FilterFileSystem.`setPermission(Path p, FsPermission permission)`
    `abstract void` | AbstractFileSystem.`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.
    `void` | ChecksumFileSystem.`setPermission(Path src, FsPermission permission)`
    `void` | FileContext.`setUMask(FsPermission newUmask)` Set umask to the supplied parameter.

    Constructors in org.apache.hadoop.fs with parameters of type FsPermission
    Constructor and Description
    `FileStatus(long length, boolean isdir, int block_replication, long blocksize, long modification_time, long access_time, FsPermission permission, String owner, String group, Path path)` Constructor for file systems on which symbolic links are not supported
    `FileStatus(long length, boolean isdir, int block_replication, long blocksize, long modification_time, long access_time, FsPermission permission, String owner, String group, Path symlink, Path path)`
    `FileStatus(long length, boolean isdir, int block_replication, long blocksize, long modification_time, long access_time, FsPermission permission, String owner, String group, Path symlink, Path path, boolean hasAcl, boolean isEncrypted, boolean isErasureCoded)`
    `FileStatus(long length, boolean isdir, int block_replication, long blocksize, long modification_time, long access_time, FsPermission permission, String owner, String group, Path symlink, Path path, Set<org.apache.hadoop.fs.FileStatus.AttrFlags> attr)`
    `LocatedFileStatus(long length, boolean isdir, int block_replication, long blocksize, long modification_time, long access_time, FsPermission permission, String owner, String group, Path symlink, Path path, BlockLocation[] locations)` Deprecated.
    `LocatedFileStatus(long length, boolean isdir, int block_replication, long blocksize, long modification_time, long access_time, FsPermission permission, String owner, String group, Path symlink, Path path, boolean hasAcl, boolean isEncrypted, boolean isErasureCoded, BlockLocation[] locations)` Constructor.
    `LocatedFileStatus(long length, boolean isdir, int block_replication, long blocksize, long modification_time, long access_time, FsPermission permission, String owner, String group, Path symlink, Path path, Set<org.apache.hadoop.fs.FileStatus.AttrFlags> attr, BlockLocation[] locations)` Constructor.

  - ### Uses of FsPermission in org.apache.hadoop.fs.adl

    Methods in org.apache.hadoop.fs.adl with parameters of type FsPermission
    Modifier and Type | Method and Description
    --- | ---
    `FSDataOutputStream` | AdlFileSystem.`create(Path f, FsPermission permission, boolean overwrite, int bufferSize, short replication, long blockSize, Progressable progress)` Create call semantic is handled differently in case of ADL.
    `FSDataOutputStream` | AdlFileSystem.`createNonRecursive(Path f, FsPermission permission, EnumSet<CreateFlag> flags, int bufferSize, short replication, long blockSize, Progressable progress)` Deprecated. API only for 0.20-append
    `boolean` | AdlFileSystem.`mkdirs(Path path, FsPermission permission)` Make the given file and all non-existent parents into directories.
    `void` | AdlFileSystem.`setPermission(Path path, FsPermission permission)` Set permission of a path.

  - ### Uses of FsPermission in org.apache.hadoop.fs.azure

    Methods in org.apache.hadoop.fs.azure with parameters of type FsPermission
    Modifier and Type | Method and Description
    --- | ---
    `FSDataOutputStream` | NativeAzureFileSystem.`create(Path f, FsPermission permission, boolean overwrite, int bufferSize, short replication, long blockSize, Progressable progress)`
    `protected FSDataOutputStream` | NativeAzureFileSystem.`createInternal(Path f, FsPermission permission, boolean overwrite, org.apache.hadoop.fs.azure.SelfRenewingLease parentFolderLease)` This is the version of the create call that is meant for internal usage.
    `FSDataOutputStream` | NativeAzureFileSystem.`createNonRecursive(Path f, FsPermission permission, boolean overwrite, int bufferSize, short replication, long blockSize, Progressable progress)`
    `FSDataOutputStream` | NativeAzureFileSystem.`createNonRecursive(Path f, FsPermission permission, EnumSet<CreateFlag> flags, int bufferSize, short replication, long blockSize, Progressable progress)`
    `boolean` | NativeAzureFileSystem.`mkdirs(Path f, FsPermission permission)`
    `boolean` | NativeAzureFileSystem.`mkdirs(Path f, FsPermission permission, boolean noUmask)`
    `void` | NativeAzureFileSystem.`setPermission(Path p, FsPermission permission)`

  - ### Uses of FsPermission in org.apache.hadoop.fs.azurebfs

    Methods in org.apache.hadoop.fs.azurebfs with parameters of type FsPermission
    Modifier and Type | Method and Description
    --- | ---
    `void` | AzureBlobFileSystemStore.`createDirectory(Path path, FsPermission permission, FsPermission umask)`
    `OutputStream` | AzureBlobFileSystemStore.`createFile(Path path, boolean overwrite, FsPermission permission, FsPermission umask)`
    `void` | AzureBlobFileSystemStore.`setPermission(Path path, FsPermission permission)`

  - ### Uses of FsPermission in org.apache.hadoop.fs.ftp

    Methods in org.apache.hadoop.fs.ftp with parameters of type FsPermission
    Modifier and Type | Method and Description
    --- | ---
    `FSDataOutputStream` | FTPFileSystem.`create(Path file, FsPermission permission, boolean overwrite, int bufferSize, short replication, long blockSize, Progressable progress)` A stream obtained via this call must be closed before using other APIs of this class or else the invocation will block.
    `boolean` | FTPFileSystem.`mkdirs(Path file, FsPermission permission)`

  - ### Uses of FsPermission in org.apache.hadoop.fs.permission

    Subclasses of FsPermission in org.apache.hadoop.fs.permission with annotations of type with type parameters of type that implement declared as with annotations of type with type parameters of type with annotations of type with annotations of type with type parameters of type that return that return types with arguments of type with parameters of type with type arguments of type that throw with annotations of type with annotations of type with parameters of type with type arguments of type that throw
    Modifier and Type | Class and Description
    --- | ---
    `class` | `FsCreateModes` A class that stores both masked and unmasked create modes and is a drop-in replacement for masked permission.

    Methods in org.apache.hadoop.fs.permission with annotations of type with type parameters of type that implement declared as with annotations of type with type parameters of type with annotations of type with annotations of type with type parameters of type that return that return types with arguments of type with parameters of type with type arguments of type that throw with annotations of type with annotations of type with parameters of type with type arguments of type that throw FsPermission
    Modifier and Type | Method and Description
    --- | ---
    `FsPermission` | FsPermission.`applyUMask(FsPermission umask)` Apply a umask to this permission and return a new one.
    `static FsPermission` | FsCreateModes.`applyUMask(FsPermission mode, FsPermission umask)` Create from unmasked mode and umask.
    `static FsPermission` | FsPermission.`createImmutable(short permission)` Create an immutable `FsPermission` object.
    `static FsPermission` | FsPermission.`getCachePoolDefault()` Get the default permission for cache pools.
    `static FsPermission` | FsPermission.`getDefault()` Get the default permission for directory and symlink.
    `static FsPermission` | FsPermission.`getDirDefault()` Get the default permission for directory.
    `static FsPermission` | FsPermission.`getFileDefault()` Get the default permission for file.
    `FsPermission` | FsCreateModes.`getMasked()`
    `FsPermission` | FsPermission.`getMasked()` Get masked permission if exists.
    `FsPermission` | AclStatus.`getPermission()` Returns the permission set for the path
    `static FsPermission` | FsPermission.`getUMask(Configuration conf)` Get the user file creation mask (umask) `UMASK_LABEL` config param has umask value that is either symbolic or octal.
    `FsPermission` | FsCreateModes.`getUnmasked()`
    `FsPermission` | FsPermission.`getUnmasked()` Get unmasked permission if exists.
    `static FsPermission` | FsPermission.`read(DataInput in)` Create and initialize a `FsPermission` from `DataInput`.
    `static FsPermission` | FsPermission.`valueOf(String unixSymbolicPermission)` Create a FsPermission from a Unix symbolic permission string

    Methods in org.apache.hadoop.fs.permission with annotations of type with type parameters of type that implement declared as with annotations of type with type parameters of type with annotations of type with annotations of type with type parameters of type that return that return types with arguments of type with parameters of type with type arguments of type that throw with annotations of type with annotations of type with parameters of type with type arguments of type that throw FsPermission
    Modifier and Type | Method and Description
    --- | ---
    `FsPermission` | FsPermission.`applyUMask(FsPermission umask)` Apply a umask to this permission and return a new one.
    `static FsPermission` | FsCreateModes.`applyUMask(FsPermission mode, FsPermission umask)` Create from unmasked mode and umask.
    `static FsCreateModes` | FsCreateModes.`create(FsPermission masked, FsPermission unmasked)` Create from masked and unmasked modes.
    `FsAction` | AclStatus.`getEffectivePermission(AclEntry entry, FsPermission permArg)` Get the effective permission for the AclEntry.
    `static void` | FsPermission.`setUMask(Configuration conf, FsPermission umask)` Set the user file creation mask (umask)

    Constructors in org.apache.hadoop.fs.permission with annotations of type with type parameters of type that implement declared as with annotations of type with type parameters of type with annotations of type with annotations of type with type parameters of type that return that return types with arguments of type with parameters of type with type arguments of type that throw with annotations of type with annotations of type with parameters of type with type arguments of type that throw FsPermission
    Constructor and Description
    `FsPermission(FsPermission other)` Copy constructor

  - ### Uses of FsPermission in org.apache.hadoop.fs.s3native

    Methods in org.apache.hadoop.fs.s3native with parameters of type FsPermission
    Modifier and Type | Method and Description
    --- | ---
    `FSDataOutputStream` | NativeS3FileSystem.`create(Path f, FsPermission permission, boolean overwrite, int bufferSize, short replication, long blockSize, Progressable progress)` Deprecated.
    `boolean` | NativeS3FileSystem.`mkdirs(Path f, FsPermission permission)` Deprecated.

  - ### Uses of FsPermission in org.apache.hadoop.fs.viewfs

    Methods in org.apache.hadoop.fs.viewfs with annotations of type with type parameters of type that implement declared as with annotations of type with type parameters of type with annotations of type with annotations of type with type parameters of type that return that return types with arguments of type with parameters of type with type arguments of type that throw with annotations of type with annotations of type with parameters of type with type arguments of type that throw FsPermission
    Modifier and Type | Method and Description
    --- | ---
    `FSDataOutputStream` | ViewFileSystem.`create(Path f, FsPermission permission, boolean overwrite, int bufferSize, short replication, long blockSize, Progressable progress)`
    `FSDataOutputStream` | ViewFs.`createInternal(Path f, EnumSet<CreateFlag> flag, FsPermission absolutePermission, int bufferSize, short replication, long blockSize, Progressable progress, org.apache.hadoop.fs.Options.ChecksumOpt checksumOpt, boolean createParent)`
    `FSDataOutputStream` | ViewFileSystem.`createNonRecursive(Path f, FsPermission permission, EnumSet<CreateFlag> flags, int bufferSize, short replication, long blockSize, Progressable progress)`
    `void` | ViewFs.`mkdir(Path dir, FsPermission permission, boolean createParent)`
    `boolean` | ViewFileSystem.`mkdirs(Path dir, FsPermission permission)`
    `void` | ViewFileSystem.`setPermission(Path f, FsPermission permission)`
    `void` | ViewFs.`setPermission(Path f, FsPermission permission)`

  - ### Uses of FsPermission in org.apache.hadoop.hdfs.inotify

    Methods in org.apache.hadoop.hdfs.inotify that return FsPermission
    Modifier and Type | Method and Description
    --- | ---
    `FsPermission` | Event.CreateEvent.`getPerms()`
    `FsPermission` | Event.MetadataUpdateEvent.`getPerms()`

  - ### Uses of FsPermission in org.apache.hadoop.hdfs.protocol

    Methods in org.apache.hadoop.hdfs.protocol that return FsPermission
    Modifier and Type | Method and Description
    --- | ---
    `FsPermission` | CachePoolInfo.`getMode()`

    Methods in org.apache.hadoop.hdfs.protocol with parameters of type FsPermission
    Modifier and Type | Method and Description
    --- | ---
    `CachePoolInfo` | CachePoolInfo.`setMode(FsPermission mode)`

  - ### Uses of FsPermission in org.apache.hadoop.hdfs.server.namenode

    Methods in org.apache.hadoop.hdfs.server.namenode that return FsPermission
    Modifier and Type | Method and Description
    --- | ---
    `FsPermission` | UGIResolver.`permission(FileStatus s)`

  - ### Uses of FsPermission in org.apache.hadoop.yarn.logaggregation.filecontroller

    Fields in org.apache.hadoop.yarn.logaggregation.filecontroller declared as FsPermission
    Modifier and Type | Field and Description
    --- | ---
    `protected static FsPermission` | LogAggregationFileController.`APP_DIR_PERMISSIONS` Permissions for the Application directory.
    `protected static FsPermission` | LogAggregationFileController.`APP_LOG_FILE_UMASK` Umask for the log file.
    `protected static FsPermission` | LogAggregationFileController.`TLDIR_PERMISSIONS` Permissions for the top level directory under which app directories will be created.

    Methods in org.apache.hadoop.yarn.logaggregation.filecontroller with parameters of type FsPermission
    Modifier and Type | Method and Description
    --- | ---
    `protected boolean` | LogAggregationFileController.`checkExists(FileSystem fs, Path path, FsPermission fsPerm)`
    `protected void` | LogAggregationFileController.`createDir(FileSystem fs, Path path, FsPermission fsPerm)`

Copyright © 2022 Apache Software Foundation. All rights reserved.