UnderFileSystemWithLogging (Alluxio Parent 2.7.2-SNAPSHOT API)

java.lang.Object
- alluxio.underfs.UnderFileSystemWithLogging

All Implemented Interfaces:

UnderFileSystem, Closeable, AutoCloseable
```
public class UnderFileSystemWithLogging
extends Object
implements UnderFileSystem
```
This class forwards all calls to the UnderFileSystem interface to an internal implementation. For methods which throw an IOException, it is implied that an interaction with the underlying storage is possible. This class logs the enter/exit of all such methods. Methods which do not throw exceptions will not be logged.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`UnderFileSystemWithLogging.UfsCallable<T>` Interface representing a callable to the under storage system which throws an `IOException` if an error occurs during the external communication.

Nested classes/interfaces inherited from interface alluxio.underfs.UnderFileSystem
UnderFileSystem.Factory, UnderFileSystem.SpaceType

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`cleanup()` Cleans up the under file system.
`void`	`close()`
`void`	`connectFromMaster(String hostname)` Takes any necessary actions required to establish a connection to the under file system from the given master host e.g.
`void`	`connectFromWorker(String hostname)` Takes any necessary actions required to establish a connection to the under file system from the given worker host e.g.
`OutputStream`	`create(String path)` Creates a file in the under file system with the indicated name.
`OutputStream`	`create(String path, CreateOptions options)` Creates a file in the under file system with the specified `CreateOptions`.
`OutputStream`	`createNonexistingFile(String path)` Creates a file in the under file system with the indicated name.
`OutputStream`	`createNonexistingFile(String path, CreateOptions options)` Creates a file in the under file system with the specified `CreateOptions`.
`boolean`	`deleteDirectory(String path)` Deletes a directory from the under file system with the indicated name non-recursively.
`boolean`	`deleteDirectory(String path, DeleteOptions options)` Deletes a directory from the under file system with the indicated name.
`boolean`	`deleteExistingDirectory(String path)` Deletes a directory from the under file system.
`boolean`	`deleteExistingDirectory(String path, DeleteOptions options)` Deletes a directory from the under file system with the indicated name.
`boolean`	`deleteExistingFile(String path)` Deletes a file from the under file system with the indicated name.
`boolean`	`deleteFile(String path)` Deletes a file from the under file system with the indicated name.
`boolean`	`exists(String path)` Checks if a file or directory exists in under file system.
`Pair<AccessControlList,DefaultAccessControlList>`	`getAclPair(String path)` Gets the ACL and the Default ACL of a file or directory in under file system.
`SyncInfo`	`getActiveSyncInfo()` Return the active sync info for the specified syncPoints.
`long`	`getBlockSizeByte(String path)` Gets the block size of a file in under file system, in bytes.
`AlluxioConfiguration`	`getConfiguration()` Gets the under file system configuration.
`UfsDirectoryStatus`	`getDirectoryStatus(String path)` Gets the directory status.
`UfsDirectoryStatus`	`getExistingDirectoryStatus(String path)` Gets the directory status.
`UfsFileStatus`	`getExistingFileStatus(String path)` Gets the file status.
`UfsStatus`	`getExistingStatus(String path)` Gets the file or directory status.
`List<String>`	`getFileLocations(String path)` Gets the list of locations of the indicated path.
`List<String>`	`getFileLocations(String path, FileLocationOptions options)` Gets the list of locations of the indicated path given options.
`UfsFileStatus`	`getFileStatus(String path)` Gets the file status.
`String`	`getFingerprint(String path)` Computes and returns a fingerprint for the path.
`UfsMode`	`getOperationMode(Map<String,UfsMode> physicalUfsState)` An `UnderFileSystem` may be composed of one or more "physical UFS"s.
`List<String>`	`getPhysicalStores()` An `UnderFileSystem` may be composed of one or more "physical UFS"s.
`long`	`getSpace(String path, UnderFileSystem.SpaceType type)` Queries the under file system about the space of the indicated path (e.g., space left, space used and etc).
`UfsStatus`	`getStatus(String path)` Gets the file or directory status.
`UnderFileSystem`	`getUnderFileSystem()` This is only used in the test.
`String`	`getUnderFSType()` Returns the name of the under filesystem implementation.
`boolean`	`isDirectory(String path)` Checks if a directory exists in under file system.
`boolean`	`isExistingDirectory(String path)` Checks if a directory exists in under file system.
`boolean`	`isFile(String path)` Checks if a file exists in under file system.
`boolean`	`isObjectStorage()`
`boolean`	`isSeekable()` Denotes if the under storage supports seeking.
`UfsStatus[]`	`listStatus(String path)` Returns an array of statuses of the files and directories in the directory denoted by this abstract pathname.
`UfsStatus[]`	`listStatus(String path, ListOptions options)` Returns an array of statuses of the files and directories in the directory denoted by this abstract pathname, with options.
`boolean`	`mkdirs(String path)` Creates the directory named by this abstract pathname.
`boolean`	`mkdirs(String path, MkdirsOptions options)` Creates the directory named by this abstract pathname, with specified `MkdirsOptions`.
`InputStream`	`open(String path)` Opens an `InputStream` for a file in under filesystem at the indicated path.
`InputStream`	`open(String path, OpenOptions options)` Opens an `InputStream` for a file in under filesystem at the indicated path.
`InputStream`	`openExistingFile(String path)` Opens an `InputStream` for a file in under filesystem at the indicated path.
`InputStream`	`openExistingFile(String path, OpenOptions options)` Opens an `InputStream` for a file in under filesystem at the indicated path.
`boolean`	`renameDirectory(String src, String dst)` Renames a directory from `src` to `dst` in under file system.
`boolean`	`renameFile(String src, String dst)` Renames a file from `src` to `dst` in under file system.
`boolean`	`renameRenamableDirectory(String src, String dst)` Renames a directory from `src` to `dst` in under file system.
`boolean`	`renameRenamableFile(String src, String dst)` Renames a file from `src` to `dst` in under file system.
`AlluxioURI`	`resolveUri(AlluxioURI ufsBaseUri, String alluxioPath)` Returns an `AlluxioURI` representation for the `UnderFileSystem` given a base UFS URI, and the Alluxio path from the base.
`void`	`setAclEntries(String path, List<AclEntry> aclEntries)` Sets the access control list of a file or directory in under file system.
`void`	`setMode(String path, short mode)` Changes posix file mode.
`void`	`setOwner(String path, String owner, String group)` Sets the user and group of the given path.
`boolean`	`startActiveSyncPolling(long txId)` Start Active Sync.
`void`	`startSync(AlluxioURI uri)` Add Sync Point.
`boolean`	`stopActiveSyncPolling()` Stop Active Sync.
`void`	`stopSync(AlluxioURI uri)` Stop Sync Point.
`boolean`	`supportsActiveSync()` Whether this type of UFS supports active sync.
`boolean`	`supportsFlush()` Whether this type of UFS supports flush.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - cleanup
```
public void cleanup()
             throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Cleans up the under file system. If any data or files are created and not completed/aborted correctly in normal ways, they should be cleaned in this method.
    
    Specified by:
    
    cleanup in interface UnderFileSystem
    
    Throws:
    
    IOException
  - close
```
public void close()
           throws IOException
```
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    IOException
  - connectFromMaster
```
public void connectFromMaster(String hostname)
                       throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Takes any necessary actions required to establish a connection to the under file system from the given master host e.g. logging in
    Depending on the implementation this may be a no-op
    
    Specified by:
    
    connectFromMaster in interface UnderFileSystem
    
    Parameters:
    
    hostname - the host that wants to connect to the under file system
    
    Throws:
    
    IOException
  - connectFromWorker
```
public void connectFromWorker(String hostname)
                       throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Takes any necessary actions required to establish a connection to the under file system from the given worker host e.g. logging in
    Depending on the implementation this may be a no-op
    
    Specified by:
    
    connectFromWorker in interface UnderFileSystem
    
    Parameters:
    
    hostname - the host that wants to connect to the under file system
    
    Throws:
    
    IOException
  - create
```
public OutputStream create(String path)
                    throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Creates a file in the under file system with the indicated name. Parents directories will be created recursively.
    
    Specified by:
    
    create in interface UnderFileSystem
    
    Parameters:
    
    path - the file name
    
    Returns:
    
    A OutputStream object
    
    Throws:
    
    IOException
  - create
```
public OutputStream create(String path,
                           CreateOptions options)
                    throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Creates a file in the under file system with the specified CreateOptions. Implementations should make sure that the path under creation appears in listings only after a successful close and that contents are written in its entirety or not at all.
    
    Specified by:
    
    create in interface UnderFileSystem
    
    Parameters:
    
    path - the file name
    
    options - the options for create
    
    Returns:
    
    A OutputStream object
    
    Throws:
    
    IOException
  - createNonexistingFile
```
public OutputStream createNonexistingFile(String path)
                                   throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Creates a file in the under file system with the indicated name. Similar to UnderFileSystem.create(String) but deals with the delete-then-create eventual consistency issue.
    
    Specified by:
    
    createNonexistingFile in interface UnderFileSystem
    
    Parameters:
    
    path - the file name
    
    Returns:
    
    A OutputStream object
    
    Throws:
    
    IOException
  - createNonexistingFile
```
public OutputStream createNonexistingFile(String path,
                                          CreateOptions options)
                                   throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Creates a file in the under file system with the specified CreateOptions. Similar to UnderFileSystem.create(String, CreateOptions) but deals with the delete-then-create eventual consistency issue.
    
    Specified by:
    
    createNonexistingFile in interface UnderFileSystem
    
    Parameters:
    
    path - the file name
    
    options - the options for create
    
    Returns:
    
    A OutputStream object
    
    Throws:
    
    IOException
  - deleteDirectory
```
public boolean deleteDirectory(String path)
                        throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Deletes a directory from the under file system with the indicated name non-recursively. A non-recursive delete is successful only if the directory is empty.
    
    Specified by:
    
    deleteDirectory in interface UnderFileSystem
    
    Parameters:
    
    path - of the directory to delete
    
    Returns:
    
    true if directory was found and deleted, false otherwise
    
    Throws:
    
    IOException
  - deleteDirectory
```
public boolean deleteDirectory(String path,
                               DeleteOptions options)
                        throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Deletes a directory from the under file system with the indicated name.
    
    Specified by:
    
    deleteDirectory in interface UnderFileSystem
    
    Parameters:
    
    path - of the directory to delete
    
    options - for directory delete semantics
    
    Returns:
    
    true if directory was found and deleted, false otherwise
    
    Throws:
    
    IOException
  - deleteExistingDirectory
```
public boolean deleteExistingDirectory(String path)
                                throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Deletes a directory from the under file system. Similar to UnderFileSystem.deleteDirectory(String) but deals with the create-delete eventual consistency issue.
    
    Specified by:
    
    deleteExistingDirectory in interface UnderFileSystem
    
    Parameters:
    
    path - of the directory to delete
    
    Returns:
    
    true if directory was found and deleted, false otherwise
    
    Throws:
    
    IOException
  - deleteExistingDirectory
```
public boolean deleteExistingDirectory(String path,
                                       DeleteOptions options)
                                throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Deletes a directory from the under file system with the indicated name. Similar to UnderFileSystem.deleteDirectory(String, DeleteOptions) but deals with the create-then-delete eventual consistency issue.
    
    Specified by:
    
    deleteExistingDirectory in interface UnderFileSystem
    
    Parameters:
    
    path - of the directory to delete
    
    options - for directory delete semantics
    
    Returns:
    
    true if directory was found and deleted, false otherwise
    
    Throws:
    
    IOException
  - deleteFile
```
public boolean deleteFile(String path)
                   throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Deletes a file from the under file system with the indicated name.
    
    Specified by:
    
    deleteFile in interface UnderFileSystem
    
    Parameters:
    
    path - of the file to delete
    
    Returns:
    
    true if file was found and deleted, false otherwise
    
    Throws:
    
    IOException
  - deleteExistingFile
```
public boolean deleteExistingFile(String path)
                           throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Deletes a file from the under file system with the indicated name. Similar to UnderFileSystem.deleteFile(String) but deals with the create-then-delete eventual consistency issue.
    
    Specified by:
    
    deleteExistingFile in interface UnderFileSystem
    
    Parameters:
    
    path - of the file to delete
    
    Returns:
    
    true if file was found and deleted, false otherwise
    
    Throws:
    
    IOException
  - exists
```
public boolean exists(String path)
               throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Checks if a file or directory exists in under file system.
    
    Specified by:
    
    exists in interface UnderFileSystem
    
    Parameters:
    
    path - the absolute path
    
    Returns:
    
    true if the path exists, false otherwise
    
    Throws:
    
    IOException
  - getAclPair
```
public Pair<AccessControlList,DefaultAccessControlList> getAclPair(String path)
                                                            throws IOException,
                                                                   UnimplementedException
```
    Description copied from interface: UnderFileSystem
    
    Gets the ACL and the Default ACL of a file or directory in under file system.
    
    Specified by:
    
    getAclPair in interface UnderFileSystem
    
    Parameters:
    
    path - the path to the file or directory
    
    Returns:
    
    the access control list, along with a Default ACL if it is a directory return null if ACL is unsupported or disabled
    
    Throws:
    
    IOException - if ACL is supported and enabled but cannot be retrieved
    
    UnimplementedException
  - getBlockSizeByte
```
public long getBlockSizeByte(String path)
                      throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Gets the block size of a file in under file system, in bytes.
    
    Specified by:
    
    getBlockSizeByte in interface UnderFileSystem
    
    Parameters:
    
    path - the file name
    
    Returns:
    
    the block size in bytes
    
    Throws:
    
    IOException
  - getConfiguration
```
public AlluxioConfiguration getConfiguration()
                                      throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Gets the under file system configuration.
    
    Specified by:
    
    getConfiguration in interface UnderFileSystem
    
    Returns:
    
    the configuration
    
    Throws:
    
    IOException
  - getDirectoryStatus
```
public UfsDirectoryStatus getDirectoryStatus(String path)
                                      throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Gets the directory status. The caller must already know the path is a directory. This method will throw an exception if the path exists, but is a file.
    
    Specified by:
    
    getDirectoryStatus in interface UnderFileSystem
    
    Parameters:
    
    path - the path to the directory
    
    Returns:
    
    the directory status
    
    Throws:
    
    FileNotFoundException - when the path does not exist
    
    IOException
  - getExistingDirectoryStatus
```
public UfsDirectoryStatus getExistingDirectoryStatus(String path)
                                              throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Gets the directory status. Similar to UnderFileSystem.getDirectoryStatus(String) but deals with the write-then-get-status eventual consistency issue.
    
    Specified by:
    
    getExistingDirectoryStatus in interface UnderFileSystem
    
    Parameters:
    
    path - the path to the directory
    
    Returns:
    
    the directory status
    
    Throws:
    
    IOException
  - getFileLocations
```
public List<String> getFileLocations(String path)
                              throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Gets the list of locations of the indicated path.
    
    Specified by:
    
    getFileLocations in interface UnderFileSystem
    
    Parameters:
    
    path - the file name
    
    Returns:
    
    The list of locations
    
    Throws:
    
    IOException
  - getFileLocations
```
public List<String> getFileLocations(String path,
                                     FileLocationOptions options)
                              throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Gets the list of locations of the indicated path given options.
    
    Specified by:
    
    getFileLocations in interface UnderFileSystem
    
    Parameters:
    
    path - the file name
    
    options - method options
    
    Returns:
    
    The list of locations
    
    Throws:
    
    IOException
  - getFileStatus
```
public UfsFileStatus getFileStatus(String path)
                            throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Gets the file status. The caller must already know the path is a file. This method will throw an exception if the path exists, but is a directory.
    
    Specified by:
    
    getFileStatus in interface UnderFileSystem
    
    Parameters:
    
    path - the path to the file
    
    Returns:
    
    the file status
    
    Throws:
    
    FileNotFoundException - when the path does not exist
    
    IOException
  - getExistingFileStatus
```
public UfsFileStatus getExistingFileStatus(String path)
                                    throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Gets the file status. Similar to UnderFileSystem.getFileStatus(String) but deals with the write-then-get-status eventual consistency issue.
    
    Specified by:
    
    getExistingFileStatus in interface UnderFileSystem
    
    Parameters:
    
    path - the path to the file
    
    Returns:
    
    the file status
    
    Throws:
    
    IOException
  - getFingerprint
```
public String getFingerprint(String path)
```
    Description copied from interface: UnderFileSystem
    
    Computes and returns a fingerprint for the path. The fingerprint is used to determine if two UFS files are identical. The fingerprint must be deterministic, and must not change if a file is only renamed (identical content and permissions). Returns Constants.INVALID_UFS_FINGERPRINT if there is any error.
    
    Specified by:
    
    getFingerprint in interface UnderFileSystem
    
    Parameters:
    
    path - the path to compute the fingerprint for
    
    Returns:
    
    the string representing the fingerprint
  - getOperationMode
```
public UfsMode getOperationMode(Map<String,UfsMode> physicalUfsState)
```
    Description copied from interface: UnderFileSystem
    
    An UnderFileSystem may be composed of one or more "physical UFS"s. This method is used to determine the operation mode based on the physical UFS operation modes. For example, if this UnderFileSystem is composed of physical UFS hdfs://ns1/ and hdfs://ns2/ with read operations split b/w the two, with physicalUfsState{hdfs://ns1/:NO_ACCESS, hdfs://ns2/:READ_WRITE} this method can return READ_ONLY to allow reads to proceed from hdfs://ns2/.
    
    Specified by:
    
    getOperationMode in interface UnderFileSystem
    
    Parameters:
    
    physicalUfsState - the state of physical UFSs for this UnderFileSystem; keys are expected to be normalized (ending with /)
    
    Returns:
    
    the desired operation mode for this UFS
  - getSpace
```
public long getSpace(String path,
                     UnderFileSystem.SpaceType type)
              throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Queries the under file system about the space of the indicated path (e.g., space left, space used and etc).
    
    Specified by:
    
    getSpace in interface UnderFileSystem
    
    Parameters:
    
    path - the path to query
    
    type - the type of queries
    
    Returns:
    
    The space in bytes
    
    Throws:
    
    IOException
  - getStatus
```
public UfsStatus getStatus(String path)
                    throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Gets the file or directory status. The caller does not need to know if the path is a file or directory. This method will determine the path type, and will return the appropriate status.
    
    Specified by:
    
    getStatus in interface UnderFileSystem
    
    Parameters:
    
    path - the path to get the status
    
    Returns:
    
    the file or directory status
    
    Throws:
    
    FileNotFoundException - when the path does not exist
    
    IOException
  - getExistingStatus
```
public UfsStatus getExistingStatus(String path)
                            throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Gets the file or directory status. Similar to UnderFileSystem.getStatus(String) but deals with the write-then-get-status eventual consistency issue.
    
    Specified by:
    
    getExistingStatus in interface UnderFileSystem
    
    Parameters:
    
    path - the path to get the status
    
    Returns:
    
    the file or directory status
    
    Throws:
    
    IOException
  - getUnderFSType
```
public String getUnderFSType()
```
    Description copied from interface: UnderFileSystem
    
    Returns the name of the under filesystem implementation. The name should be lowercase and not include any spaces, e.g. "hdfs", "s3".
    
    Specified by:
    
    getUnderFSType in interface UnderFileSystem
    
    Returns:
    
    name of the under filesystem implementation
  - isDirectory
```
public boolean isDirectory(String path)
                    throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Checks if a directory exists in under file system.
    
    Specified by:
    
    isDirectory in interface UnderFileSystem
    
    Parameters:
    
    path - the absolute directory path
    
    Returns:
    
    true if the path exists and is a directory, false otherwise
    
    Throws:
    
    IOException
  - isExistingDirectory
```
public boolean isExistingDirectory(String path)
                            throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Checks if a directory exists in under file system. Similar to UnderFileSystem.isDirectory(String) but deals with the write-then-list eventual consistency issue.
    
    Specified by:
    
    isExistingDirectory in interface UnderFileSystem
    
    Parameters:
    
    path - the absolute directory path
    
    Returns:
    
    true if the path exists and is a directory, false otherwise
    
    Throws:
    
    IOException
  - isFile
```
public boolean isFile(String path)
               throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Checks if a file exists in under file system.
    
    Specified by:
    
    isFile in interface UnderFileSystem
    
    Parameters:
    
    path - the absolute file path
    
    Returns:
    
    true if the path exists and is a file, false otherwise
    
    Throws:
    
    IOException
  - getPhysicalStores
```
public List<String> getPhysicalStores()
```
    Description copied from interface: UnderFileSystem
    
    An UnderFileSystem may be composed of one or more "physical UFS"s. This method returns all underlying physical stores; normalized with only scheme and authority.
    
    Specified by:
    
    getPhysicalStores in interface UnderFileSystem
    
    Returns:
    
    physical UFSs this UnderFileSystem is composed of
  - isObjectStorage
```
public boolean isObjectStorage()
```
    Specified by:
    
    isObjectStorage in interface UnderFileSystem
    
    Returns:
    
    true if under storage is an object store, false otherwise
  - listStatus
```
public UfsStatus[] listStatus(String path)
                       throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Returns an array of statuses of the files and directories in the directory denoted by this abstract pathname.
    If this abstract pathname does not denote a directory, then this method returns null. Otherwise an array of statuses is returned, one for each file or directory in the directory. Names denoting the directory itself and the directory's parent directory are not included in the result. Each string is a file name rather than a complete path.
    There is no guarantee that the name strings in the resulting array will appear in any specific order; they are not, in particular, guaranteed to appear in alphabetical order.
    
    Specified by:
    
    listStatus in interface UnderFileSystem
    
    Parameters:
    
    path - the abstract pathname to list
    
    Returns:
    
    An array with the statuses of the files and directories in the directory denoted by this abstract pathname. The array will be empty if the directory is empty. Returns null if this abstract pathname does not denote a directory.
    
    Throws:
    
    IOException
  - listStatus
```
public UfsStatus[] listStatus(String path,
                              ListOptions options)
                       throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Returns an array of statuses of the files and directories in the directory denoted by this abstract pathname, with options.
    If this abstract pathname does not denote a directory, then this method returns null. Otherwise an array of statuses is returned, one for each file or directory. Names denoting the directory itself and the directory's parent directory are not included in the result. Each string is a path relative to the given directory.
    There is no guarantee that the name strings in the resulting array will appear in any specific order; they are not, in particular, guaranteed to appear in alphabetical order.
    
    Specified by:
    
    listStatus in interface UnderFileSystem
    
    Parameters:
    
    path - the abstract pathname to list
    
    options - for list directory
    
    Returns:
    
    An array of statuses naming the files and directories in the directory denoted by this abstract pathname. The array will be empty if the directory is empty. Returns null if this abstract pathname does not denote a directory.
    
    Throws:
    
    IOException
  - mkdirs
```
public boolean mkdirs(String path)
               throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Creates the directory named by this abstract pathname. If the folder already exists, the method returns false. The method creates any necessary but nonexistent parent directories.
    
    Specified by:
    
    mkdirs in interface UnderFileSystem
    
    Parameters:
    
    path - the folder to create
    
    Returns:
    
    true if and only if the directory was created; false otherwise
    
    Throws:
    
    IOException
  - mkdirs
```
public boolean mkdirs(String path,
                      MkdirsOptions options)
               throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Creates the directory named by this abstract pathname, with specified MkdirsOptions. If the folder already exists, the method returns false.
    
    Specified by:
    
    mkdirs in interface UnderFileSystem
    
    Parameters:
    
    path - the folder to create
    
    options - the options for mkdirs
    
    Returns:
    
    true if and only if the directory was created; false otherwise
    
    Throws:
    
    IOException
  - open
```
public InputStream open(String path)
                 throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Opens an InputStream for a file in under filesystem at the indicated path.
    
    Specified by:
    
    open in interface UnderFileSystem
    
    Parameters:
    
    path - the file name
    
    Returns:
    
    The InputStream object
    
    Throws:
    
    IOException
  - open
```
public InputStream open(String path,
                        OpenOptions options)
                 throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Opens an InputStream for a file in under filesystem at the indicated path.
    
    Specified by:
    
    open in interface UnderFileSystem
    
    Parameters:
    
    path - the file name
    
    options - to open input stream
    
    Returns:
    
    The InputStream object
    
    Throws:
    
    IOException
  - openExistingFile
```
public InputStream openExistingFile(String path)
                             throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Opens an InputStream for a file in under filesystem at the indicated path. Similar to UnderFileSystem.open(String) but deals with the write-then-read eventual consistency issue.
    
    Specified by:
    
    openExistingFile in interface UnderFileSystem
    
    Parameters:
    
    path - the file name
    
    Returns:
    
    The InputStream object
    
    Throws:
    
    IOException
  - openExistingFile
```
public InputStream openExistingFile(String path,
                                    OpenOptions options)
                             throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Opens an InputStream for a file in under filesystem at the indicated path. Similar to UnderFileSystem.open(String, OpenOptions) but deals with the write-then-read eventual consistency issue.
    
    Specified by:
    
    openExistingFile in interface UnderFileSystem
    
    Parameters:
    
    path - the file name
    
    options - to open input stream
    
    Returns:
    
    The InputStream object
    
    Throws:
    
    IOException
  - renameDirectory
```
public boolean renameDirectory(String src,
                               String dst)
                        throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Renames a directory from src to dst in under file system.
    
    Specified by:
    
    renameDirectory in interface UnderFileSystem
    
    Parameters:
    
    src - the source directory path
    
    dst - the destination directory path
    
    Returns:
    
    true if succeed, false otherwise
    
    Throws:
    
    IOException
  - renameRenamableDirectory
```
public boolean renameRenamableDirectory(String src,
                                        String dst)
                                 throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Renames a directory from src to dst in under file system. Similar to UnderFileSystem.renameDirectory(String, String) but deals with the write-src-then-rename and delete-dst-then-rename eventual consistency issue.
    
    Specified by:
    
    renameRenamableDirectory in interface UnderFileSystem
    
    Parameters:
    
    src - the source directory path
    
    dst - the destination directory path
    
    Returns:
    
    true if succeed, false otherwise
    
    Throws:
    
    IOException
  - renameFile
```
public boolean renameFile(String src,
                          String dst)
                   throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Renames a file from src to dst in under file system.
    
    Specified by:
    
    renameFile in interface UnderFileSystem
    
    Parameters:
    
    src - the source file path
    
    dst - the destination file path
    
    Returns:
    
    true if succeed, false otherwise
    
    Throws:
    
    IOException
  - renameRenamableFile
```
public boolean renameRenamableFile(String src,
                                   String dst)
                            throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Renames a file from src to dst in under file system. Similar to UnderFileSystem.renameFile(String, String) but deals with the write-src-then-rename and delete-dst-then-rename eventual consistency issue.
    
    Specified by:
    
    renameRenamableFile in interface UnderFileSystem
    
    Parameters:
    
    src - the source file path
    
    dst - the destination file path
    
    Returns:
    
    true if succeed, false otherwise
    
    Throws:
    
    IOException
  - resolveUri
```
public AlluxioURI resolveUri(AlluxioURI ufsBaseUri,
                             String alluxioPath)
```
    Description copied from interface: UnderFileSystem
    
    Returns an AlluxioURI representation for the UnderFileSystem given a base UFS URI, and the Alluxio path from the base. The default implementation simply concatenates the path to the base URI. This should be overridden if a subclass needs alternate functionality.
    
    Specified by:
    
    resolveUri in interface UnderFileSystem
    
    Parameters:
    
    ufsBaseUri - the base AlluxioURI in the ufs
    
    alluxioPath - the path in Alluxio from the given base
    
    Returns:
    
    the UFS AlluxioURI representing the Alluxio path
  - setAclEntries
```
public void setAclEntries(String path,
                          List<AclEntry> aclEntries)
                   throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Sets the access control list of a file or directory in under file system. if the ufs does not support acls, this is a noop. This will overwrite the ACL and defaultACL in the UFS.
    
    Specified by:
    
    setAclEntries in interface UnderFileSystem
    
    Parameters:
    
    path - the path to the file or directory
    
    aclEntries - the access control list + default acl represented in a list of acl entries
    
    Throws:
    
    IOException
  - setOwner
```
public void setOwner(String path,
                     String owner,
                     String group)
              throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Sets the user and group of the given path. An empty implementation should be provided if unsupported.
    
    Specified by:
    
    setOwner in interface UnderFileSystem
    
    Parameters:
    
    path - the path of the file
    
    owner - the new owner to set, unchanged if null
    
    group - the new group to set, unchanged if null
    
    Throws:
    
    IOException
  - setMode
```
public void setMode(String path,
                    short mode)
             throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Changes posix file mode.
    
    Specified by:
    
    setMode in interface UnderFileSystem
    
    Parameters:
    
    path - the path of the file
    
    mode - the mode to set in short format, e.g. 0777
    
    Throws:
    
    IOException
  - supportsFlush
```
public boolean supportsFlush()
                      throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Whether this type of UFS supports flush.
    
    Specified by:
    
    supportsFlush in interface UnderFileSystem
    
    Returns:
    
    true if this type of UFS supports flush, false otherwise
    
    Throws:
    
    IOException
  - supportsActiveSync
```
public boolean supportsActiveSync()
```
    Description copied from interface: UnderFileSystem
    
    Whether this type of UFS supports active sync.
    
    Specified by:
    
    supportsActiveSync in interface UnderFileSystem
    
    Returns:
    
    true if this type of UFS supports active sync, false otherwise
  - startActiveSyncPolling
```
public boolean startActiveSyncPolling(long txId)
                               throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Start Active Sync.
    
    Specified by:
    
    startActiveSyncPolling in interface UnderFileSystem
    
    Parameters:
    
    txId - the transaction id to start receiving event
    
    Returns:
    
    true if active sync started
    
    Throws:
    
    IOException
  - stopActiveSyncPolling
```
public boolean stopActiveSyncPolling()
                              throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Stop Active Sync.
    
    Specified by:
    
    stopActiveSyncPolling in interface UnderFileSystem
    
    Returns:
    
    true if active sync stopped
    
    Throws:
    
    IOException
  - getActiveSyncInfo
```
public SyncInfo getActiveSyncInfo()
                           throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Return the active sync info for the specified syncPoints.
    
    Specified by:
    
    getActiveSyncInfo in interface UnderFileSystem
    
    Returns:
    
    active sync info consisting of what changed for these sync points
    
    Throws:
    
    IOException
  - startSync
```
public void startSync(AlluxioURI uri)
               throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Add Sync Point.
    
    Specified by:
    
    startSync in interface UnderFileSystem
    
    Parameters:
    
    uri - ufs uri to start
    
    Throws:
    
    IOException
  - stopSync
```
public void stopSync(AlluxioURI uri)
              throws IOException
```
    Description copied from interface: UnderFileSystem
    
    Stop Sync Point.
    
    Specified by:
    
    stopSync in interface UnderFileSystem
    
    Parameters:
    
    uri - ufs uri to stop
    
    Throws:
    
    IOException
  - getUnderFileSystem
```
public UnderFileSystem getUnderFileSystem()
```
    This is only used in the test.
    
    Returns:
    
    the underlying UnderFileSystem
  - isSeekable
```
public boolean isSeekable()
```
    Description copied from interface: UnderFileSystem
    
    Denotes if the under storage supports seeking. Note, the under file system subclass that returns true for this method should return the input stream extending SeekableUnderFileInputStream in the UnderFileSystem.open(String, OpenOptions) method.
    
    Specified by:
    
    isSeekable in interface UnderFileSystem
    
    Returns:
    
    true if under storage is seekable, false otherwise

Class UnderFileSystemWithLogging

Nested Class Summary

Nested classes/interfaces inherited from interface alluxio.underfs.UnderFileSystem

Method Summary

Methods inherited from class java.lang.Object

Method Detail

cleanup

close

connectFromMaster

connectFromWorker

create

create

createNonexistingFile

createNonexistingFile

deleteDirectory

deleteDirectory

deleteExistingDirectory

deleteExistingDirectory

deleteFile

deleteExistingFile

exists

getAclPair

getBlockSizeByte

getConfiguration

getDirectoryStatus

getExistingDirectoryStatus

getFileLocations

getFileLocations

getFileStatus

getExistingFileStatus

getFingerprint

getOperationMode

getSpace

getStatus

getExistingStatus

getUnderFSType

isDirectory

isExistingDirectory

isFile

getPhysicalStores

isObjectStorage

listStatus

listStatus

mkdirs

mkdirs

open

open

openExistingFile

openExistingFile

renameDirectory

renameRenamableDirectory

renameFile

renameRenamableFile

resolveUri

setAclEntries

setOwner

setMode

supportsFlush

supportsActiveSync

startActiveSyncPolling

stopActiveSyncPolling

getActiveSyncInfo

startSync

stopSync

getUnderFileSystem

isSeekable