Package org.apache.hadoop.hbase.security.provider

Class SaslClientAuthenticationProviders

java.lang.Object

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

@LimitedPrivate("Authentication")
@Evolving
public final class SaslClientAuthenticationProviders
extends Object

Accessor for all SaslAuthenticationProvider instances.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
SaslClientAuthenticationProviders(org.apache.hadoop.conf.Configuration conf)	Creates a new instance of SaslClientAuthenticationProviders.

Method Summary

Modifier and Type	Method	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)	Deprecated. Since 2.5.14 and 2.6.4, will be removed in newer minor release lines.
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.
private static AuthenticationProviderSelector	instantiateSelector(org.apache.hadoop.conf.Configuration conf, Collection<SaslClientAuthenticationProvider> providers)	Instantiates the ProviderSelector implementation from the provided configuration.
static void	reset()	Deprecated. Since 2.5.14 and 2.6.4, will be removed in newer minor release lines.
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 Details

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

PROVIDER_REF

private static final AtomicReference<SaslClientAuthenticationProviders> PROVIDER_REF

providers

private final Collection<SaslClientAuthenticationProvider> providers

selector

private final AuthenticationProviderSelector selector

Constructor Details

SaslClientAuthenticationProviders

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

Creates a new instance of SaslClientAuthenticationProviders.

Parameters:

conf - the configuration to use for loading providers and selector

Method Details

getNumRegisteredProviders

public int getNumRegisteredProviders()

Returns the number of providers that have been registered.

getInstance

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

Deprecated.

Since 2.5.14 and 2.6.4, will be removed in newer minor release lines. This class should not be singleton, please do not use it any more. see HBASE-29144 for more details.

Returns a singleton instance of SaslClientAuthenticationProviders.

reset

@Deprecated
public static void reset()

Deprecated.

Since 2.5.14 and 2.6.4, will be removed in newer minor release lines. This class should not be singleton, please do not use it any more. see HBASE-29144 for more details.

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

private 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.

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