Package org.apache.hadoop.yarn.server.nodemanager.containermanager.localizer.security

Interface ExternalTokenLocalizer

All Known Implementing Classes:

MapRTicketLocalizer

public interface ExternalTokenLocalizer

Interface to plug in a token localizer that can localize any distribution specific tokens from DFS on to some node local directory. These are tokens that are different from the default job tokens and container tokens.

The localized tokens will then be copied over to the container specific temp directory before localizing other resources and also before launching the task.

Method Summary

Modifier and Type	Method	Description
void	cleanup(org.apache.hadoop.yarn.api.records.ApplicationId appId)	Cleans up any resources tracked for the given application.
java.lang.String	getTokenEnvVar()	Returns the environment variable name that needs to be set to point to the external token path.
org.apache.hadoop.fs.Path	getTokenPath(java.lang.String appIdStr, org.apache.hadoop.conf.Configuration conf)	Returns the path of the localized token for given application id.
void	run(org.apache.hadoop.yarn.api.records.ContainerId containerId, java.lang.String user, org.apache.hadoop.conf.Configuration conf)	Localizes any distribution specific tokens.

Method Detail

run

void run(org.apache.hadoop.yarn.api.records.ContainerId containerId,
         java.lang.String user,
         org.apache.hadoop.conf.Configuration conf)

Localizes any distribution specific tokens. This method will be invoked with the privileges of the user account used to run NodeManager service.

Parameters:

containerId - container id

user - user

conf - YarnConfiguration instance

getTokenPath

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

Returns the path of the localized token for given application id.

Parameters:

appIdStr - application id

conf - YarnConfiguration instance

Throws:

java.io.IOException

getTokenEnvVar

java.lang.String getTokenEnvVar()

Returns the environment variable name that needs to be set to point to the external token path. This environment variable will be available to both the localization process and the actual container process running the task.

cleanup

void cleanup(org.apache.hadoop.yarn.api.records.ApplicationId appId)

Cleans up any resources tracked for the given application.

Parameters:

appId - application id