Package org.apache.hadoop.yarn.server.resourcemanager.placement.csmappingrule

Class MappingRuleMatchers

java.lang.Object

org.apache.hadoop.yarn.server.resourcemanager.placement.csmappingrule.MappingRuleMatchers

public class MappingRuleMatchers
extends java.lang.Object

This class contains all the matcher and some helper methods to generate them.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MappingRuleMatchers.AndMatcher	AndMatcher is a basic boolean matcher which takes multiple other matcher as it's arguments, and on match it checks if all of them are true.
static class	MappingRuleMatchers.MatchAllMatcher	MatchAllMatcher is a matcher which matches everything.
static class	MappingRuleMatchers.OrMatcher	OrMatcher is a basic boolean matcher which takes multiple other matcher as its arguments, and on match it checks if any of them are true.
static class	MappingRuleMatchers.UserGroupMatcher	The GroupMatcher will check if any of the user's groups match the provided group name.
static class	MappingRuleMatchers.VariableMatcher	VariableMatcher will check if a provided variable's value matches the provided value.

Method Summary

Modifier and Type	Method	Description
static MappingRuleMatcher	createAllMatcher()	Convenience method to create a matcher that matches all
static MappingRuleMatcher	createApplicationNameMatcher(java.lang.String name)	Convenience method to create a variable matcher which matches against the submitted application's name.
static MappingRuleMatcher	createUserGroupMatcher(java.lang.String groupName)	Convenience method to create a group matcher which matches against the groups of the user.
static MappingRuleMatcher	createUserGroupMatcher(java.lang.String userName, java.lang.String groupName)	Convenience method to create a composite matcher which matches against the user's user name and the user's primary group.
static MappingRuleMatcher	createUserMatcher(java.lang.String userName)	Convenience method to create a variable matcher which matches against the username.

Methods inherited from class java.lang.Object

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

Method Detail

createUserMatcher

public static MappingRuleMatcher createUserMatcher(java.lang.String userName)

Convenience method to create a variable matcher which matches against the username.

Parameters:

userName - The username to be matched

Returns:

VariableMatcher with %user as the variable

createUserGroupMatcher

public static MappingRuleMatcher createUserGroupMatcher(java.lang.String groupName)

Convenience method to create a group matcher which matches against the groups of the user.

Parameters:

groupName - The groupName to be matched

Returns:

UserGroupMatcher

createUserGroupMatcher

public static MappingRuleMatcher createUserGroupMatcher(java.lang.String userName,
                                                        java.lang.String groupName)

Convenience method to create a composite matcher which matches against the user's user name and the user's primary group. Only matches if both matches.

Parameters:

userName - The username to be matched

groupName - The groupName to be matched

Returns:

AndMatcher with two matchers one for userName and one for primaryGroup

createApplicationNameMatcher

public static MappingRuleMatcher createApplicationNameMatcher(java.lang.String name)

Convenience method to create a variable matcher which matches against the submitted application's name.

Parameters:

name - The name to be matched

Returns:

VariableMatcher with %application as the variable

createAllMatcher

public static MappingRuleMatcher createAllMatcher()

Convenience method to create a matcher that matches all

Returns:

MatchAllMatcher.