Package org.apache.hadoop.yarn.util

Class YarnAppUtil

java.lang.Object

org.apache.hadoop.yarn.util.YarnAppUtil

public class YarnAppUtil
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
static org.apache.hadoop.fs.permission.FsPermission	APP_DIR_PERMISSION	File permission to be used for any application specific directory.
static org.apache.hadoop.fs.permission.FsPermission	APP_FILE_PERMISSION	File permission used for any application specific file.
static org.slf4j.Logger	LOG
static org.apache.hadoop.fs.permission.FsPermission	RM_STAGING_DIR_PERMISSION	Permission for the staging directory on RM.
static org.apache.hadoop.fs.permission.FsPermission	RM_SYSTEM_DIR_PERMISSION	Permission for the system directory on RM.

Constructor Summary

Constructors

Constructor	Description
YarnAppUtil()

Method Summary

Modifier and Type	Method	Description
static org.apache.hadoop.fs.Path	getMapRTicketPath(org.apache.hadoop.fs.Path appDir)
static java.lang.String	getNMPrivateRelativeTicketLocation(java.lang.String appIdStr)	Returns the MapR ticket location relative to NodeManager private directory.
static org.apache.hadoop.fs.Path	getNMPrivateTicketPath(java.lang.String appIdStr, org.apache.hadoop.conf.Configuration conf)	Returns the absolute MapR ticket path on NodeManager private directory.
static org.apache.hadoop.fs.Path	getNMPrivateTicketPathForRead(java.lang.String appIdStr, org.apache.hadoop.conf.Configuration conf)	Returns the absolute MapR ticket path on NodeManager private directory.
static org.apache.hadoop.fs.Path	getNMPrivateTicketPathForWrite(java.lang.String appIdStr, org.apache.hadoop.conf.Configuration conf)	Returns the absolute MapR ticket path on NodeManager private directory.
static org.apache.hadoop.fs.Path	getRMDirWithVolume(java.lang.String appIdStr, org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.conf.Configuration conf, java.lang.String rmSubDir, boolean lookUpAllDirs)
static org.apache.hadoop.fs.Path	getRMStagedMapRTicketPath(java.lang.String appIdStr, org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.conf.Configuration conf)	Returns the path of MapR ticket for the given app from the staging directory on resource manager.
static org.apache.hadoop.fs.Path	getRMStagingDir(java.lang.String appIdStr, org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.conf.Configuration conf)	Returns staging dir for the given app on resource manager.
static org.apache.hadoop.fs.Path	getRMStagingDirForWrite(java.lang.String appIdStr, org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.conf.Configuration conf)	Returns staging dir for the given app on resource manager.
static org.apache.hadoop.fs.Path	getRMSystemDir(java.lang.String appIdStr, org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.conf.Configuration conf)	Returns system dir for the given app on resource manager.
static org.apache.hadoop.fs.Path	getRMSystemDirForWrite(java.lang.String appIdStr, org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.conf.Configuration conf)	Returns system dir for the given app on resource manager.
static org.apache.hadoop.fs.Path	getRMSystemMapRTicketPath(java.lang.String appIdStr, org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.conf.Configuration conf)	Returns the path of MapR ticket for the given app from the system directory on resource manager.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

public static final org.slf4j.Logger LOG

APP_DIR_PERMISSION

public static final org.apache.hadoop.fs.permission.FsPermission APP_DIR_PERMISSION

File permission to be used for any application specific directory. It is rwx------. This ensures that only the app owner can access it. mapr user is a special user and can therefore still access it.

APP_FILE_PERMISSION

public static final org.apache.hadoop.fs.permission.FsPermission APP_FILE_PERMISSION

File permission used for any application specific file. It is world-wide readable and owner writable : rw-r--r--. This is needed to make sure the mapr user can read such files. Other users cannot read the file because APP_DIR_PERMISSION disallows any user other than the app owner to access it. mapr user is an exception to this rule.

RM_SYSTEM_DIR_PERMISSION

public static final org.apache.hadoop.fs.permission.FsPermission RM_SYSTEM_DIR_PERMISSION

Permission for the system directory on RM. This directory is used only by mapr user. Hence no permission for other and group.

RM_STAGING_DIR_PERMISSION

public static final org.apache.hadoop.fs.permission.FsPermission RM_STAGING_DIR_PERMISSION

Permission for the staging directory on RM. This directory is used to upload client specific files such as MapR ticket as the client user itself and so needs to be accessible by all users.

Constructor Detail

YarnAppUtil

public YarnAppUtil()

Method Detail

getRMStagingDir

public static org.apache.hadoop.fs.Path getRMStagingDir(java.lang.String appIdStr,
                                                        org.apache.hadoop.fs.FileSystem fs,
                                                        org.apache.hadoop.conf.Configuration conf)
                                                 throws java.io.IOException

Returns staging dir for the given app on resource manager.

Throws:

java.io.IOException

getRMStagingDirForWrite

public static org.apache.hadoop.fs.Path getRMStagingDirForWrite(java.lang.String appIdStr,
                                                                org.apache.hadoop.fs.FileSystem fs,
                                                                org.apache.hadoop.conf.Configuration conf)
                                                         throws java.io.IOException

Returns staging dir for the given app on resource manager. It does not lookup through all staging directories on all volumes, because is used for "create" activity, not for "read" or "delete"

Throws:

java.io.IOException

getRMSystemDirForWrite

public static org.apache.hadoop.fs.Path getRMSystemDirForWrite(java.lang.String appIdStr,
                                                               org.apache.hadoop.fs.FileSystem fs,
                                                               org.apache.hadoop.conf.Configuration conf)
                                                        throws java.io.IOException

Returns system dir for the given app on resource manager. It does not lookup through all system directories on all volumes, because is used for "create" activity, not for "read" or "delete"

Throws:

java.io.IOException

getRMSystemDir

public static org.apache.hadoop.fs.Path getRMSystemDir(java.lang.String appIdStr,
                                                       org.apache.hadoop.fs.FileSystem fs,
                                                       org.apache.hadoop.conf.Configuration conf)
                                                throws java.io.IOException

Returns system dir for the given app on resource manager.

Throws:

java.io.IOException

getRMDirWithVolume

public static org.apache.hadoop.fs.Path getRMDirWithVolume(java.lang.String appIdStr,
                                                           org.apache.hadoop.fs.FileSystem fs,
                                                           org.apache.hadoop.conf.Configuration conf,
                                                           java.lang.String rmSubDir,
                                                           boolean lookUpAllDirs)
                                                    throws java.io.IOException

Throws:

java.io.IOException

getRMStagedMapRTicketPath

public static org.apache.hadoop.fs.Path getRMStagedMapRTicketPath(java.lang.String appIdStr,
                                                                  org.apache.hadoop.fs.FileSystem fs,
                                                                  org.apache.hadoop.conf.Configuration conf)
                                                           throws java.io.IOException

Returns the path of MapR ticket for the given app from the staging directory on resource manager.

Throws:

java.io.IOException

getRMSystemMapRTicketPath

public static org.apache.hadoop.fs.Path getRMSystemMapRTicketPath(java.lang.String appIdStr,
                                                                  org.apache.hadoop.fs.FileSystem fs,
                                                                  org.apache.hadoop.conf.Configuration conf)
                                                           throws java.io.IOException

Returns the path of MapR ticket for the given app from the system directory on resource manager.

Throws:

java.io.IOException

getMapRTicketPath

public static org.apache.hadoop.fs.Path getMapRTicketPath(org.apache.hadoop.fs.Path appDir)

getNMPrivateRelativeTicketLocation

public static java.lang.String getNMPrivateRelativeTicketLocation(java.lang.String appIdStr)

Returns the MapR ticket location relative to NodeManager private directory.

getNMPrivateTicketPath

public static org.apache.hadoop.fs.Path getNMPrivateTicketPath(java.lang.String appIdStr,
                                                               org.apache.hadoop.conf.Configuration conf)

Returns the absolute MapR ticket path on NodeManager private directory.

getNMPrivateTicketPathForWrite

public static org.apache.hadoop.fs.Path getNMPrivateTicketPathForWrite(java.lang.String appIdStr,
                                                                       org.apache.hadoop.conf.Configuration conf)
                                                                throws java.io.IOException

Returns the absolute MapR ticket path on NodeManager private directory. See LocalDirAllocator#getLocalPathForWrite

Throws:

java.io.IOException

getNMPrivateTicketPathForRead

public static org.apache.hadoop.fs.Path getNMPrivateTicketPathForRead(java.lang.String appIdStr,
                                                                      org.apache.hadoop.conf.Configuration conf)
                                                               throws java.io.IOException

Returns the absolute MapR ticket path on NodeManager private directory. See LocalDirAllocator#getLocalPathToRead

Throws:

java.io.IOException