Package org.apache.hadoop.yarn.security

Interface ExternalTokenManager

All Known Implementing Classes:

MapRTicketManager

public interface ExternalTokenManager

Interface to manage distribution/vendor specific tokens that are needed to secure the communication. These are tokens that are different from the default job tokens and container tokens.

Method Summary

Modifier and Type	Method	Description
void	generateToken(org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext appCtx, java.lang.String username, org.apache.hadoop.conf.Configuration conf)	Generates a token and stores it in DFS.
void	removeToken(org.apache.hadoop.yarn.api.records.ApplicationId appId, org.apache.hadoop.conf.Configuration conf)	Deletes the token from DFS.
void	uploadTokenToDistributedCache(org.apache.hadoop.yarn.api.records.ApplicationId appId)	Uploads token to DFS for the given application.

Method Detail

uploadTokenToDistributedCache

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

Uploads token to DFS for the given application. This is invoked when client submits the application. So it will be executed using the client privileges.

Parameters:

appId - application id

generateToken

void generateToken(org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext appCtx,
                   java.lang.String username,
                   org.apache.hadoop.conf.Configuration conf)

Generates a token and stores it in DFS. This is invoked on the resource manager node before the application is launched. It will be executed using the privileges of the user the resource manager runs as. When the container starts on a node, the token will be localized by @link{ResourceLocalizationService}.

removeToken

void removeToken(org.apache.hadoop.yarn.api.records.ApplicationId appId,
                 org.apache.hadoop.conf.Configuration conf)

Deletes the token from DFS. This is invoked on the resource manager node after the application completes.