Package org.apache.hadoop.yarn.server.api

Interface AuxiliaryLocalPathHandler

@Public @Evolving public interface AuxiliaryLocalPathHandler
An Interface that can retrieve local directories to read from or write to. Components can implement this interface to link it to their own Directory Handler Service

  • Method Summary

    Modifier and Type
    Method
    Description
    Iterable<org.apache.hadoop.fs.Path>
    getAllLocalPathsForRead(String path)
    Get all paths from the local FS for reading for a given Auxiliary Service.
    org.apache.hadoop.fs.Path
    getLocalPathForRead(String path)
    Get a path from the local FS for reading for a given Auxiliary Service.
    org.apache.hadoop.fs.Path
    getLocalPathForWrite(String path)
    Get a path from the local FS for writing for a given Auxiliary Service.
    org.apache.hadoop.fs.Path
    getLocalPathForWrite(String path, long size)
    Get a path from the local FS for writing a file of an estimated size for a given Auxiliary Service.

  • Method Details

    • getLocalPathForRead

      org.apache.hadoop.fs.Path getLocalPathForRead(String path) throws IOException
      Get a path from the local FS for reading for a given Auxiliary Service.
      Parameters:
      path - the requested path
      Returns:
      the complete path to the file on a local disk
      Throws:
      IOException - if the file read encounters a problem

    • getLocalPathForWrite

      org.apache.hadoop.fs.Path getLocalPathForWrite(String path) throws IOException
      Get a path from the local FS for writing for a given Auxiliary Service.
      Parameters:
      path - the requested path
      Returns:
      the complete path to the file on a local disk
      Throws:
      IOException - if the path creations fails

    • getLocalPathForWrite

      org.apache.hadoop.fs.Path getLocalPathForWrite(String path, long size) throws IOException
      Get a path from the local FS for writing a file of an estimated size for a given Auxiliary Service.
      Parameters:
      path - the requested path
      size - the size of the file that is going to be written
      Returns:
      the complete path to the file on a local disk
      Throws:
      IOException - if the path creations fails

    • getAllLocalPathsForRead

      Iterable<org.apache.hadoop.fs.Path> getAllLocalPathsForRead(String path) throws IOException
      Get all paths from the local FS for reading for a given Auxiliary Service.
      Parameters:
      path - the requested path
      Returns:
      the complete path list to the file on a local disk as an Iterable
      Throws:
      IOException - if the file read encounters a problem