org.apache.hadoop.hbase.security.provider

Class SaslClientAuthenticationProviders

java.lang.Object

org.apache.hadoop.hbase.security.provider.SaslClientAuthenticationProviders

@InterfaceAudience.LimitedPrivate(value="Authentication")
 @InterfaceStability.Evolving
public final class SaslClientAuthenticationProviders
extends Object

Accessor for all SaslAuthenticationProvider instances.

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXTRA_PROVIDERS_KEY
private static org.slf4j.Logger	LOG
private Collection<SaslClientAuthenticationProvider>	providers
private static AtomicReference<SaslClientAuthenticationProviders>	providersRef
private AuthenticationProviderSelector	selector
static String	SELECTOR_KEY

Constructor Summary

Constructors

Modifier	Constructor and Description
private	SaslClientAuthenticationProviders(Collection<SaslClientAuthenticationProvider> providers, AuthenticationProviderSelector selector)

Method Summary

Modifier and Type	Method and Description
(package private) static void	addExplicitProviders(org.apache.hadoop.conf.Configuration conf, HashMap<Byte,SaslClientAuthenticationProvider> providers) Extracts and instantiates authentication providers from the configuration.
(package private) static void	addProviderIfNotExists(SaslClientAuthenticationProvider provider, HashMap<Byte,SaslClientAuthenticationProvider> providers) Adds the given provider to the set, only if an equivalent provider does not already exist in the set.
static SaslClientAuthenticationProviders	getInstance(org.apache.hadoop.conf.Configuration conf) Returns a singleton instance of SaslClientAuthenticationProviders.
int	getNumRegisteredProviders() Returns the number of providers that have been registered.
Pair<SaslClientAuthenticationProvider,org.apache.hadoop.security.token.Token<? extends org.apache.hadoop.security.token.TokenIdentifier>>	getSimpleProvider() Returns the provider and token pair for SIMPLE authentication.
(package private) static SaslClientAuthenticationProviders	instantiate(org.apache.hadoop.conf.Configuration conf) Instantiates all client authentication providers and returns an instance of SaslClientAuthenticationProviders.
(package private) static AuthenticationProviderSelector	instantiateSelector(org.apache.hadoop.conf.Configuration conf, Collection<SaslClientAuthenticationProvider> providers) Instantiates the ProviderSelector implementation from the provided configuration.
static void	reset() Removes the cached singleton instance of SaslClientAuthenticationProviders.
Pair<SaslClientAuthenticationProvider,org.apache.hadoop.security.token.Token<? extends org.apache.hadoop.security.token.TokenIdentifier>>	selectProvider(String clusterId, User clientUser) Chooses the best authentication provider and corresponding token given the HBase cluster identifier and the user.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.slf4j.Logger LOG

SELECTOR_KEY

public static final String SELECTOR_KEY

See Also:

Constant Field Values

EXTRA_PROVIDERS_KEY

public static final String EXTRA_PROVIDERS_KEY

See Also:

Constant Field Values

providersRef

private static final AtomicReference<SaslClientAuthenticationProviders> providersRef

providers

private final Collection<SaslClientAuthenticationProvider> providers

selector

private final AuthenticationProviderSelector selector

Constructor Detail

SaslClientAuthenticationProviders

private SaslClientAuthenticationProviders(Collection<SaslClientAuthenticationProvider> providers,
                                          AuthenticationProviderSelector selector)

Method Detail

getNumRegisteredProviders

public int getNumRegisteredProviders()

Returns the number of providers that have been registered.

getInstance

public static SaslClientAuthenticationProviders getInstance(org.apache.hadoop.conf.Configuration conf)

Returns a singleton instance of SaslClientAuthenticationProviders.

reset

public static void reset()

Removes the cached singleton instance of SaslClientAuthenticationProviders.

addProviderIfNotExists

static void addProviderIfNotExists(SaslClientAuthenticationProvider provider,
                                   HashMap<Byte,SaslClientAuthenticationProvider> providers)

Adds the given provider to the set, only if an equivalent provider does not already exist in the set.

instantiateSelector

static AuthenticationProviderSelector instantiateSelector(org.apache.hadoop.conf.Configuration conf,
                                                          Collection<SaslClientAuthenticationProvider> providers)

Instantiates the ProviderSelector implementation from the provided configuration.

addExplicitProviders

static void addExplicitProviders(org.apache.hadoop.conf.Configuration conf,
                                 HashMap<Byte,SaslClientAuthenticationProvider> providers)

Extracts and instantiates authentication providers from the configuration.

instantiate

static SaslClientAuthenticationProviders instantiate(org.apache.hadoop.conf.Configuration conf)

Instantiates all client authentication providers and returns an instance of SaslClientAuthenticationProviders.

getSimpleProvider

public Pair<SaslClientAuthenticationProvider,org.apache.hadoop.security.token.Token<? extends org.apache.hadoop.security.token.TokenIdentifier>> getSimpleProvider()

Returns the provider and token pair for SIMPLE authentication. This method is a "hack" while SIMPLE authentication for HBase does not flow through the SASL codepath.

selectProvider

public Pair<SaslClientAuthenticationProvider,org.apache.hadoop.security.token.Token<? extends org.apache.hadoop.security.token.TokenIdentifier>> selectProvider(String clusterId,
                                                                                                                                                                User clientUser)

Chooses the best authentication provider and corresponding token given the HBase cluster identifier and the user.

toString

public String toString()

Overrides:

toString in class Object