org.apache.hadoop.hive.registry.impl

Class ZkRegistryBase<InstanceType extends ServiceInstance>

java.lang.Object

org.apache.hadoop.hive.registry.impl.ZkRegistryBase<InstanceType>

Direct Known Subclasses:

HS2ActivePassiveHARegistry, LlapZookeeperRegistryImpl, TezAmRegistryImpl

public abstract class ZkRegistryBase<InstanceType extends ServiceInstance>
extends Object

This is currently used for implementation inheritance only; it doesn't provide a unified flow into which one can just plug a few abstract method implementations, because providing one with getInstance method is a huge pain involving lots of generics. Also, different registries may have slightly different usage patterns anyway and noone would use a registry without knowing what type it is. So, it's mostly a grab bag of methods used by ServiceInstanceSet and other parts of each implementation.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.hadoop.conf.Configuration	conf
protected boolean	doCheckAcls
protected org.apache.hadoop.registry.client.binding.RegistryUtils.ServiceRecordMarshal	encoder
protected static String	hostname Local hostname.
protected static UUID	UNIQUE_ID
static String	UNIQUE_IDENTIFIER
protected static String	USER_SCOPE_PATH_PREFIX
protected static String	WORKER_GROUP
protected static String	WORKER_PREFIX
protected String	workersPath
protected org.apache.curator.framework.CuratorFramework	zooKeeperClient

Constructor Summary

Constructors

Constructor and Description
ZkRegistryBase(String instanceName, org.apache.hadoop.conf.Configuration conf, String rootNs, String nsPrefix, String userScopePathPrefix, String workerPrefix, String workerGroup, String zkSaslLoginContextName, String zkPrincipal, String zkKeytab, HiveConf.ConfVars aclsConfig)

Method Summary

Modifier and Type	Method and Description
protected abstract InstanceType	createServiceInstance(org.apache.hadoop.registry.client.types.ServiceRecord srv)
protected org.apache.curator.framework.recipes.cache.PathChildrenCache	ensureInstancesCache(long clusterReadyTimeoutMs)
protected Collection<InstanceType>	getAllInternal()
protected Set<InstanceType>	getByHostInternal(String host)
protected InstanceType	getInstanceByPath(String path)
protected String	getRegistrationZnodePath()
static String	getRootNamespace(String userProvidedNamespace, String defaultNamespacePrefix)
protected static byte[]	getWorkerData(org.apache.curator.framework.recipes.cache.ChildData childData, String workerNodePrefix)
protected abstract String	getZkPathUser(org.apache.hadoop.conf.Configuration conf)
protected void	populateCache(org.apache.curator.framework.recipes.cache.PathChildrenCache instancesCache, boolean doInvokeListeners)
protected String	registerServiceRecord(org.apache.hadoop.registry.client.types.ServiceRecord srv)
protected String	registerServiceRecord(org.apache.hadoop.registry.client.types.ServiceRecord srv, String uniqueId)
void	registerStateChangeListener(ServiceInstanceStateChangeListener<InstanceType> listener)
protected int	sizeInternal()
void	start()
void	stop()
protected void	unregisterInternal()
protected void	updateServiceRecord(org.apache.hadoop.registry.client.types.ServiceRecord srv, boolean doCheckAcls, boolean closeOnFailure)

Methods inherited from class java.lang.Object

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

Field Detail

USER_SCOPE_PATH_PREFIX

protected static final String USER_SCOPE_PATH_PREFIX

See Also:

Constant Field Values

WORKER_PREFIX

protected static final String WORKER_PREFIX

See Also:

Constant Field Values

WORKER_GROUP

protected static final String WORKER_GROUP

See Also:

Constant Field Values

UNIQUE_IDENTIFIER

public static final String UNIQUE_IDENTIFIER

See Also:

Constant Field Values

UNIQUE_ID

protected static final UUID UNIQUE_ID

conf

protected final org.apache.hadoop.conf.Configuration conf

zooKeeperClient

protected final org.apache.curator.framework.CuratorFramework zooKeeperClient

workersPath

protected final String workersPath

encoder

protected final org.apache.hadoop.registry.client.binding.RegistryUtils.ServiceRecordMarshal encoder

doCheckAcls

protected final boolean doCheckAcls

hostname

protected static final String hostname

Local hostname.

Constructor Detail

ZkRegistryBase

public ZkRegistryBase(String instanceName,
                      org.apache.hadoop.conf.Configuration conf,
                      String rootNs,
                      String nsPrefix,
                      String userScopePathPrefix,
                      String workerPrefix,
                      String workerGroup,
                      String zkSaslLoginContextName,
                      String zkPrincipal,
                      String zkKeytab,
                      HiveConf.ConfVars aclsConfig)

Parameters:

rootNs - A single root namespace override. Not recommended.

nsPrefix - The namespace prefix to use with default namespaces (appends 'sasl' for secure else 'unsecure' to namespace prefix to get effective root namespace).

userScopePathPrefix - The prefix to use for the user-specific part of the path.

workerPrefix - The prefix to use for each worker znode.

workerGroup - group name to use for all workers

zkSaslLoginContextName - SASL login context name for ZK security; null if not needed.

zkPrincipal - ZK security principal.

zkKeytab - ZK security keytab.

aclsConfig - A config setting to use to determine if ACLs should be verified.

Method Detail

getRootNamespace

public static String getRootNamespace(String userProvidedNamespace,
                                      String defaultNamespacePrefix)

getZkPathUser

protected abstract String getZkPathUser(org.apache.hadoop.conf.Configuration conf)

registerServiceRecord

protected final String registerServiceRecord(org.apache.hadoop.registry.client.types.ServiceRecord srv)
                                      throws IOException

Throws:

IOException

registerServiceRecord

protected final String registerServiceRecord(org.apache.hadoop.registry.client.types.ServiceRecord srv,
                                             String uniqueId)
                                      throws IOException

Throws:

IOException

updateServiceRecord

protected final void updateServiceRecord(org.apache.hadoop.registry.client.types.ServiceRecord srv,
                                         boolean doCheckAcls,
                                         boolean closeOnFailure)
                                  throws IOException

Throws:

IOException

populateCache

protected final void populateCache(org.apache.curator.framework.recipes.cache.PathChildrenCache instancesCache,
                                   boolean doInvokeListeners)

createServiceInstance

protected abstract InstanceType createServiceInstance(org.apache.hadoop.registry.client.types.ServiceRecord srv)
                                               throws IOException

Throws:

IOException

getWorkerData

protected static byte[] getWorkerData(org.apache.curator.framework.recipes.cache.ChildData childData,
                                      String workerNodePrefix)

sizeInternal

protected final int sizeInternal()

getByHostInternal

protected final Set<InstanceType> getByHostInternal(String host)

getAllInternal

protected final Collection<InstanceType> getAllInternal()

registerStateChangeListener

public void registerStateChangeListener(ServiceInstanceStateChangeListener<InstanceType> listener)
                                 throws IOException

Throws:

IOException

ensureInstancesCache

protected final org.apache.curator.framework.recipes.cache.PathChildrenCache ensureInstancesCache(long clusterReadyTimeoutMs)
                                                                                           throws IOException

Throws:

IOException

start

public void start()
           throws IOException

Throws:

IOException

unregisterInternal

protected void unregisterInternal()

stop

public void stop()

getInstanceByPath

protected final InstanceType getInstanceByPath(String path)

getRegistrationZnodePath

protected final String getRegistrationZnodePath()