Package org.apache.hadoop.yarn.server.resourcemanager.security

Class AppPriorityACLsManager

java.lang.Object

org.apache.hadoop.yarn.server.resourcemanager.security.AppPriorityACLsManager

public class AppPriorityACLsManager
extends java.lang.Object

Manager class to store and check permission for Priority ACLs.

Constructor Summary

Constructors

Constructor	Description
AppPriorityACLsManager(org.apache.hadoop.conf.Configuration conf)

Method Summary

Modifier and Type	Method	Description
void	addPrioirityACLs(java.util.List<AppPriorityACLGroup> priorityACLGroups, java.lang.String queueName)	Each Queue could have configured with different priority acl's groups.
boolean	checkAccess(org.apache.hadoop.security.UserGroupInformation callerUGI, java.lang.String queueName, org.apache.hadoop.yarn.api.records.Priority submittedPriority)	Priority based checkAccess to ensure that given user has enough permission to submit application at a given priority level.
void	clearPriorityACLs(java.lang.String queueName)	Clear priority acl during refresh.
org.apache.hadoop.yarn.api.records.Priority	getDefaultPriority(java.lang.String queueName, org.apache.hadoop.security.UserGroupInformation user)	If an application is submitted without any priority, and submitted user has a default priority, this method helps to update this default priority as app's priority.

Methods inherited from class java.lang.Object

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

Constructor Detail

AppPriorityACLsManager

public AppPriorityACLsManager(org.apache.hadoop.conf.Configuration conf)

Method Detail

clearPriorityACLs

public void clearPriorityACLs(java.lang.String queueName)

Clear priority acl during refresh.

Parameters:

queueName - Queue Name

addPrioirityACLs

public void addPrioirityACLs(java.util.List<AppPriorityACLGroup> priorityACLGroups,
                             java.lang.String queueName)

Each Queue could have configured with different priority acl's groups. This method helps to store each such ACL list against queue.

Parameters:

priorityACLGroups - List of Priority ACL Groups.

queueName - Queue Name associate with priority acl groups.

checkAccess

public boolean checkAccess(org.apache.hadoop.security.UserGroupInformation callerUGI,
                           java.lang.String queueName,
                           org.apache.hadoop.yarn.api.records.Priority submittedPriority)

Priority based checkAccess to ensure that given user has enough permission to submit application at a given priority level.

Parameters:

callerUGI - User who submits the application.

queueName - Queue to which application is submitted.

submittedPriority - priority of the application.

Returns:

True or False to indicate whether application can be submitted at submitted priority level or not.

getDefaultPriority

public org.apache.hadoop.yarn.api.records.Priority getDefaultPriority(java.lang.String queueName,
                                                                      org.apache.hadoop.security.UserGroupInformation user)

If an application is submitted without any priority, and submitted user has a default priority, this method helps to update this default priority as app's priority.

Parameters:

queueName - Submitted queue

user - User who submitted this application

Returns:

Default priority associated with given user.