org.apache.hadoop.hbase.client

Class AbstractBigtableConnection

java.lang.Object

org.apache.hadoop.hbase.client.AbstractBigtableConnection

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.hadoop.hbase.Abortable, CommonConnection, org.apache.hadoop.hbase.client.Connection

@InternalApi(value="For internal usage only")
public abstract class AbstractBigtableConnection
extends Object
implements org.apache.hadoop.hbase.client.Connection, CommonConnection, Closeable

Abstract AbstractBigtableConnection class.

For internal use only - public for technical reasons.

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<org.apache.hadoop.hbase.client.RegionLocator>	locatorCache

Constructor Summary

Constructors

Modifier	Constructor and Description
	AbstractBigtableConnection(org.apache.hadoop.conf.Configuration conf) Constructor for AbstractBigtableConnection.
protected	AbstractBigtableConnection(org.apache.hadoop.conf.Configuration conf, boolean managed, ExecutorService pool, org.apache.hadoop.hbase.security.User user) The constructor called from ConnectionFactory.createConnection(Configuration) and in its many forms via reflection with this specific signature.

Method Summary

Modifier and Type	Method and Description
void	abort(String msg, Throwable t)
void	close()
HBaseRequestAdapter	createAdapter(org.apache.hadoop.hbase.TableName tableName)
protected abstract SampledRowKeysAdapter	createSampledRowKeysAdapter(org.apache.hadoop.hbase.TableName tableName, org.apache.hadoop.hbase.ServerName serverName) There are some hbase 1.x and 2.x incompatibilities which require this abstract method.
abstract org.apache.hadoop.hbase.client.Admin	getAdmin()
BigtableApi	getBigtableApi() Returns BigtableApi object to access bigtable data and admin client APIs.
BigtableHBaseSettings	getBigtableSettings() Returns instance of bigtable settings for classic or veneer client.
org.apache.hadoop.hbase.client.BufferedMutator	getBufferedMutator(org.apache.hadoop.hbase.client.BufferedMutatorParams params)
org.apache.hadoop.hbase.client.BufferedMutator	getBufferedMutator(org.apache.hadoop.hbase.TableName tableName)
org.apache.hadoop.conf.Configuration	getConfiguration() Returns the Configuration object used by this instance.
Set<org.apache.hadoop.hbase.TableName>	getDisabledTables() Getter for the field disabledTables.
org.apache.hadoop.hbase.client.RegionLocator	getRegionLocator(org.apache.hadoop.hbase.TableName tableName)
org.apache.hadoop.hbase.client.Table	getTable(String tableName) Deprecated.
org.apache.hadoop.hbase.client.Table	getTable(org.apache.hadoop.hbase.TableName tableName)
boolean	isAborted()
boolean	isClosed()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hadoop.hbase.client.Connection

getClusterId, getTable

Methods inherited from interface org.apache.hadoop.hbase.client.CommonConnection

getAllRegionInfos

Field Detail

locatorCache

protected final Set<org.apache.hadoop.hbase.client.RegionLocator> locatorCache

Constructor Detail

AbstractBigtableConnection

public AbstractBigtableConnection(org.apache.hadoop.conf.Configuration conf)
                           throws IOException

Constructor for AbstractBigtableConnection.

Parameters:

conf - a Configuration object.

Throws:

IOException - if any.

AbstractBigtableConnection

protected AbstractBigtableConnection(org.apache.hadoop.conf.Configuration conf,
                                     boolean managed,
                                     ExecutorService pool,
                                     org.apache.hadoop.hbase.security.User user)
                              throws IOException

The constructor called from ConnectionFactory.createConnection(Configuration) and in its many forms via reflection with this specific signature.

Parameters:

conf - The configuration for this channel. See BigtableOptionsFactory for more details.

managed - This should always be false. It's an artifact of old HBase behavior.

pool - An ExecutorService to run HBase/Bigtable object conversions on. The RPCs themselves run via NIO, and not on a waiting thread

user - This is an artifact of HBase which Cloud Bigtable ignores. User information is captured in the Credentials configuration in conf.

Throws:

IOException - if the setup is not correct. The most likely issue is ALPN or OpenSSL misconfiguration.

Method Detail

getConfiguration

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

Returns the Configuration object used by this instance. The reference returned is not a copy, so any change made to it will affect this instance.

Specified by:

getConfiguration in interface CommonConnection

Specified by:

getConfiguration in interface org.apache.hadoop.hbase.client.Connection

Returns:

a Configuration object.

getTable

public org.apache.hadoop.hbase.client.Table getTable(org.apache.hadoop.hbase.TableName tableName)
                                              throws IOException

Specified by:

getTable in interface org.apache.hadoop.hbase.client.Connection

Throws:

IOException

getBufferedMutator

public org.apache.hadoop.hbase.client.BufferedMutator getBufferedMutator(org.apache.hadoop.hbase.client.BufferedMutatorParams params)
                                                                  throws IOException

Specified by:

getBufferedMutator in interface org.apache.hadoop.hbase.client.Connection

Throws:

IOException

createAdapter

public HBaseRequestAdapter createAdapter(org.apache.hadoop.hbase.TableName tableName)

getBufferedMutator

public org.apache.hadoop.hbase.client.BufferedMutator getBufferedMutator(org.apache.hadoop.hbase.TableName tableName)
                                                                  throws IOException

Specified by:

getBufferedMutator in interface org.apache.hadoop.hbase.client.Connection

Throws:

IOException

getTable

@Deprecated
public org.apache.hadoop.hbase.client.Table getTable(String tableName)
                                                          throws IOException

Deprecated.

This should not be used. The hbase shell needs this in hbase 0.99.2. Remove this once 1.0.0 comes out.

Parameters:

tableName - a String object.

Returns:

a Table object.

Throws:

IOException - if any.

getRegionLocator

public org.apache.hadoop.hbase.client.RegionLocator getRegionLocator(org.apache.hadoop.hbase.TableName tableName)
                                                              throws IOException

Specified by:

getRegionLocator in interface org.apache.hadoop.hbase.client.Connection

Throws:

IOException

createSampledRowKeysAdapter

protected abstract SampledRowKeysAdapter createSampledRowKeysAdapter(org.apache.hadoop.hbase.TableName tableName,
                                                                     org.apache.hadoop.hbase.ServerName serverName)

There are some hbase 1.x and 2.x incompatibilities which require this abstract method. See SampledRowKeysAdapter for more details.

Parameters:

tableName - a TableName object.

serverName - a ServerName object.

Returns:

a SampledRowKeysAdapter object.

abort

public void abort(String msg,
                  Throwable t)

Specified by:

abort in interface org.apache.hadoop.hbase.Abortable

isClosed

public boolean isClosed()

Specified by:

isClosed in interface org.apache.hadoop.hbase.client.Connection

isAborted

public boolean isAborted()

Specified by:

isAborted in interface org.apache.hadoop.hbase.Abortable

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface org.apache.hadoop.hbase.client.Connection

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

getAdmin

public abstract org.apache.hadoop.hbase.client.Admin getAdmin()
                                                       throws IOException

Specified by:

getAdmin in interface org.apache.hadoop.hbase.client.Connection

Throws:

IOException

getBigtableSettings

public BigtableHBaseSettings getBigtableSettings()

Description copied from interface: CommonConnection

Returns instance of bigtable settings for classic or veneer client.

Specified by:

getBigtableSettings in interface CommonConnection

Returns:

a BigtableHBaseSettings instance.

getDisabledTables

public Set<org.apache.hadoop.hbase.TableName> getDisabledTables()

Getter for the field disabledTables.

Specified by:

getDisabledTables in interface CommonConnection

Returns:

a Set object.

getBigtableApi

public BigtableApi getBigtableApi()

Description copied from interface: CommonConnection

Returns BigtableApi object to access bigtable data and admin client APIs.

Specified by:

getBigtableApi in interface CommonConnection