Package org.apache.hadoop.hdfs.server.namenode.ha

Class AbstractNNFailoverProxyProvider<T>

java.lang.Object

org.apache.hadoop.hdfs.server.namenode.ha.AbstractNNFailoverProxyProvider<T>

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, org.apache.hadoop.io.retry.FailoverProxyProvider<T>

Direct Known Subclasses:

ConfiguredFailoverProxyProvider, IPFailoverProxyProvider, ObserverReadProxyProvider, RouterObserverReadProxyProvider, WrappedFailoverProxyProvider

public abstract class AbstractNNFailoverProxyProvider<T>
extends java.lang.Object
implements org.apache.hadoop.io.retry.FailoverProxyProvider<T>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractNNFailoverProxyProvider.NNProxyInfo<T>	ProxyInfo to a NameNode.

Nested classes/interfaces inherited from interface org.apache.hadoop.io.retry.FailoverProxyProvider

org.apache.hadoop.io.retry.FailoverProxyProvider.ProxyInfo<T extends java.lang.Object>

Field Summary

Fields

Modifier and Type	Field	Description
protected org.apache.hadoop.conf.Configuration	conf
protected HAProxyFactory<T>	factory
protected java.util.concurrent.atomic.AtomicBoolean	fallbackToSimpleAuth
protected static org.slf4j.Logger	LOG
protected org.apache.hadoop.security.UserGroupInformation	ugi
protected java.lang.Class<T>	xface

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractNNFailoverProxyProvider()
protected	AbstractNNFailoverProxyProvider(org.apache.hadoop.conf.Configuration conf, java.net.URI uri, java.lang.Class<T> xface, HAProxyFactory<T> factory)

Method Summary

Modifier and Type	Method	Description
protected AbstractNNFailoverProxyProvider.NNProxyInfo<T>	createProxyIfNeeded(AbstractNNFailoverProxyProvider.NNProxyInfo<T> pi)	Create a proxy if it has not been created yet.
java.util.concurrent.atomic.AtomicBoolean	getFallbackToSimpleAuth()
java.lang.Class<T>	getInterface()
protected java.util.List<AbstractNNFailoverProxyProvider.NNProxyInfo<T>>	getProxyAddresses(java.net.URI uri, java.lang.String addressKey)	Get list of configured NameNode proxy addresses.
static boolean	getRandomOrder(org.apache.hadoop.conf.Configuration conf, java.net.URI nameNodeUri)	Check whether random order is configured for failover proxy provider for the namenode/nameservice.
void	setFallbackToSimpleAuth(java.util.concurrent.atomic.AtomicBoolean fallbackToSimpleAuth)	Set for tracking if a secure client falls back to simple auth.
abstract boolean	useLogicalURI()	Inquire whether logical HA URI is used for the implementation.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.apache.hadoop.io.retry.FailoverProxyProvider

getProxy, performFailover

Field Detail

LOG

protected static final org.slf4j.Logger LOG

conf

protected org.apache.hadoop.conf.Configuration conf

xface

protected java.lang.Class<T> xface

factory

protected HAProxyFactory<T> factory

ugi

protected org.apache.hadoop.security.UserGroupInformation ugi

fallbackToSimpleAuth

protected java.util.concurrent.atomic.AtomicBoolean fallbackToSimpleAuth

Constructor Detail

AbstractNNFailoverProxyProvider

protected AbstractNNFailoverProxyProvider()

AbstractNNFailoverProxyProvider

protected AbstractNNFailoverProxyProvider(org.apache.hadoop.conf.Configuration conf,
                                          java.net.URI uri,
                                          java.lang.Class<T> xface,
                                          HAProxyFactory<T> factory)

Method Detail

useLogicalURI

public abstract boolean useLogicalURI()

Inquire whether logical HA URI is used for the implementation. If it is used, a special token handling may be needed to make sure a token acquired from a node in the HA pair can be used against the other node.

Returns:

true if logical HA URI is used. false, if not used.

setFallbackToSimpleAuth

public void setFallbackToSimpleAuth(java.util.concurrent.atomic.AtomicBoolean fallbackToSimpleAuth)

Set for tracking if a secure client falls back to simple auth. This method is synchronized only to stifle a Findbugs warning.

Parameters:

fallbackToSimpleAuth - - set to true or false during this method to indicate if a secure client falls back to simple auth

getFallbackToSimpleAuth

public java.util.concurrent.atomic.AtomicBoolean getFallbackToSimpleAuth()

getInterface

public java.lang.Class<T> getInterface()

Specified by:

getInterface in interface org.apache.hadoop.io.retry.FailoverProxyProvider<T>

createProxyIfNeeded

protected AbstractNNFailoverProxyProvider.NNProxyInfo<T> createProxyIfNeeded(AbstractNNFailoverProxyProvider.NNProxyInfo<T> pi)

Create a proxy if it has not been created yet.

getProxyAddresses

protected java.util.List<AbstractNNFailoverProxyProvider.NNProxyInfo<T>> getProxyAddresses(java.net.URI uri,
                                                                                           java.lang.String addressKey)

Get list of configured NameNode proxy addresses. Randomize the list if requested.

getRandomOrder

public static boolean getRandomOrder(org.apache.hadoop.conf.Configuration conf,
                                     java.net.URI nameNodeUri)

Check whether random order is configured for failover proxy provider for the namenode/nameservice.

Parameters:

conf - Configuration

nameNodeUri - The URI of namenode/nameservice

Returns:

random order configuration