org.apache.ambari.server.controller

Class AuthToLocalBuilder

java.lang.Object

org.apache.ambari.server.controller.AuthToLocalBuilder

All Implemented Interfaces:

Cloneable

public class AuthToLocalBuilder
extends Object
implements Cloneable

AuthToLocalBuilder helps to create auth_to_local rules for use in configuration files like core-site.xml. No duplicate rules will be generated.

Allows previously existing rules to be added verbatim. Also allows new rules to be generated based on a principal and local username. For each principal added to the builder, generate a rule conforming to one of the following formats:

Qualified Principal (the principal contains a user and host): RULE:[2:$1@$0](PRIMARY@REALM)s/.*\/LOCAL_USERNAME/

Unqualified Principal (only user is specified): RULE:[1:$1@$0](PRIMARY@REALM)s/.*\/LOCAL_USERNAME/

Additionally, for each realm included in the rule set, generate a default realm rule in the format: RULE:[1:$1@$0](.*@REALM)s/@.*//

Ordering guarantees for the generated rule string are as follows:

• Rules with the same expected component count are ordered according to match component count
• Rules with different expected component count are ordered according to the default string ordering
• Rules in the form of .*@REALM are ordered after all other rules with the same expected component count

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AuthToLocalBuilder.ConcatenationType ConcatenationType is an enumeration of auth-to-local rule concatenation types.

Field Summary

Fields

Modifier and Type	Field and Description
static AuthToLocalBuilder.ConcatenationType	DEFAULT_CONCATENATION_TYPE

Constructor Summary

Constructors

Constructor and Description
AuthToLocalBuilder(String defaultRealm, Collection<String> additionalRealms, boolean caseInsensitiveUserSupport) Constructs a new AuthToLocalBuilder.
AuthToLocalBuilder(String defaultRealm, String additionalRealms, boolean caseInsensitiveUserSupport) Constructs a new AuthToLocalBuilder.

Method Summary

Modifier and Type	Method and Description
AuthToLocalBuilder	addRule(String principal, String localUsername) Adds a rule for the given principal and local user.
AuthToLocalBuilder	addRules(String authToLocalRules) Add existing rules from the given authToLocal configuration property.
Object	clone()
String	generate() Generates the auth_to_local rules used by configuration settings such as core-site/auth_to_local.
String	generate(AuthToLocalBuilder.ConcatenationType concatenationType) Generates the auth_to_local rules used by configuration settings such as core-site/auth_to_local.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONCATENATION_TYPE

public static final AuthToLocalBuilder.ConcatenationType DEFAULT_CONCATENATION_TYPE

Constructor Detail

AuthToLocalBuilder

public AuthToLocalBuilder(String defaultRealm,
                          String additionalRealms,
                          boolean caseInsensitiveUserSupport)

Constructs a new AuthToLocalBuilder.

Parameters:

defaultRealm - a String declaring the default realm

additionalRealms - a String containing a comma-delimited list of realm names to incorporate into the generated rule set

caseInsensitiveUserSupport - true indicating that case-insensitivity should be enabled; false otherwise

AuthToLocalBuilder

public AuthToLocalBuilder(String defaultRealm,
                          Collection<String> additionalRealms,
                          boolean caseInsensitiveUserSupport)

Constructs a new AuthToLocalBuilder.

Parameters:

defaultRealm - a String declaring the default realm

additionalRealms - a collection of Strings declaring the set of realm names to incorporate into the generated rule set

caseInsensitiveUserSupport - true indicating that case-insensitivity should be enabled; false otherwise

Method Detail

clone

public Object clone()
             throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

addRules

public AuthToLocalBuilder addRules(String authToLocalRules)

Add existing rules from the given authToLocal configuration property. The rules are added verbatim.

Parameters:

authToLocalRules - config property value containing the existing rules

addRule

public AuthToLocalBuilder addRule(String principal,
                                  String localUsername)

Adds a rule for the given principal and local user. The principal must contain a realm component.

The supplied principal is parsed to determine if it is qualified or unqualified and stored accordingly so that when the mapping rules are generated the appropriate rule is generated.

If a principal is added that yields a duplicate primary principal value (relative to the set of qualified or unqualified rules), that later entry will overwrite the older entry, allowing for only one mapping rule.

If the principal does not match one of the two expected patterns, it will be ignored.

Parameters:

principal - a string containing the full principal

localUsername - a string declaring that local username to map the principal to

Throws:

IllegalArgumentException - if the provided principal doesn't contain a realm element

generate

public String generate()

Generates the auth_to_local rules used by configuration settings such as core-site/auth_to_local.

Each rule is concatenated using the default ConcatenationType, like calling generate(ConcatenationType) with DEFAULT_CONCATENATION_TYPE

Returns:

a string containing the generated auth-to-local rule set

generate

public String generate(AuthToLocalBuilder.ConcatenationType concatenationType)

Generates the auth_to_local rules used by configuration settings such as core-site/auth_to_local.

Each rule is concatenated using the specified AuthToLocalBuilder.ConcatenationType. If the concatenation type is null, the default concatenation type is assumed - see DEFAULT_CONCATENATION_TYPE.

Parameters:

concatenationType - the concatenation type to use to generate the rule set string

Returns:

a string containing the generated auth-to-local rule set