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
java.lang.Iterable<org.apache.hadoop.fs.Path>	getAllLocalPathsForRead(java.lang.String path)	Get all paths from the local FS for reading for a given Auxiliary Service.
org.apache.hadoop.fs.Path	getLocalPathForRead(java.lang.String path)	Get a path from the local FS for reading for a given Auxiliary Service.
org.apache.hadoop.fs.Path	getLocalPathForWrite(java.lang.String path)	Get a path from the local FS for writing for a given Auxiliary Service.
org.apache.hadoop.fs.Path	getLocalPathForWrite(java.lang.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 Detail

getLocalPathForRead

org.apache.hadoop.fs.Path getLocalPathForRead(java.lang.String path)
                                       throws java.io.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:

java.io.IOException - if the file read encounters a problem

getLocalPathForWrite

org.apache.hadoop.fs.Path getLocalPathForWrite(java.lang.String path)
                                        throws java.io.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:

java.io.IOException - if the path creations fails

getLocalPathForWrite

org.apache.hadoop.fs.Path getLocalPathForWrite(java.lang.String path,
                                               long size)
                                        throws java.io.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:

java.io.IOException - if the path creations fails

getAllLocalPathsForRead

java.lang.Iterable<org.apache.hadoop.fs.Path> getAllLocalPathsForRead(java.lang.String path)
                                                               throws java.io.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:

java.io.IOException - if the file read encounters a problem