AbstractBigtableConnection (Cloud Bigtable HBase Client for Java 1.12.0 API)

org.apache.hadoop.hbase.client

Class AbstractBigtableConnection

• java.lang.Object
• • org.apache.hadoop.hbase.client.AbstractBigtableConnection

• All Implemented Interfaces:

  Closeable, AutoCloseable, Abortable, CommonConnection, Connection

  Direct Known Subclasses:

  BigtableConnection, BigtableConnection

  ---

  
  

  public abstract class AbstractBigtableConnection
  extends Object
  implements Connection, CommonConnection, Closeable

  Abstract AbstractBigtableConnection class.

  Version:

  $Id: $Id

  Author:

  sduskis

• • Field Summary

    Fields 

    Modifier and Type	Field and Description
    protected Set<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, User user) The constructor called from ConnectionFactory.createConnection(Configuration) and in its many forms via reflection with this specific signature.

  • Method Summary

    All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods 

    Modifier and Type	Method and Description
    void	abort(String msg, Throwable t)
    void	close()
    HBaseRequestAdapter	createAdapter(TableName tableName)
    protected abstract SampledRowKeysAdapter	createSampledRowKeysAdapter(TableName tableName, ServerName serverName) There are some hbase 1.x and 2.x incompatibilities which require this abstract method.
    abstract Admin	getAdmin()
    BufferedMutator	getBufferedMutator(BufferedMutatorParams params)
    BufferedMutator	getBufferedMutator(TableName tableName)
    org.apache.hadoop.conf.Configuration	getConfiguration() Returns the Configuration object used by this instance.
    Set<TableName>	getDisabledTables() Getter for the field disabledTables.
    BigtableOptions	getOptions() Getter for the field options.
    RegionLocator	getRegionLocator(TableName tableName)
    BigtableSession	getSession() Getter for the field session.
    Table	getTable(String tableName) Deprecated.
    Table	getTable(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

      getTable, getTableBuilder

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

      getAllRegionInfos

• • Field Detail

    • locatorCache

      protected final Set<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,
                                           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 Connection

      Returns:

      a Configuration object.

    • getTable

      public Table getTable(TableName tableName)
                     throws IOException

      Specified by:

      getTable in interface Connection

      Throws:

      IOException

    • getBufferedMutator

      public BufferedMutator getBufferedMutator(BufferedMutatorParams params)
                                         throws IOException

      Specified by:

      getBufferedMutator in interface Connection

      Throws:

      IOException

    • createAdapter

      public HBaseRequestAdapter createAdapter(TableName tableName)

    • getBufferedMutator

      public BufferedMutator getBufferedMutator(TableName tableName)
                                         throws IOException

      Specified by:

      getBufferedMutator in interface Connection

      Throws:

      IOException

    • getTable

      @Deprecated
      public 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 RegionLocator getRegionLocator(TableName tableName)
                                     throws IOException

      Specified by:

      getRegionLocator in interface Connection

      Throws:

      IOException

    • createSampledRowKeysAdapter

      protected abstract SampledRowKeysAdapter createSampledRowKeysAdapter(TableName tableName,
                                                                           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 Abortable

    • isClosed

      public boolean isClosed()

      Specified by:

      isClosed in interface Connection

    • isAborted

      public boolean isAborted()

      Specified by:

      isAborted in interface Abortable

    • close

      public void close()
                 throws IOException

      Specified by:

      close in interface Closeable

      Specified by:

      close in interface AutoCloseable

      Specified by:

      close in interface Connection

      Throws:

      IOException

    • toString

      public String toString()

      Overrides:

      toString in class Object

    • getAdmin

      public abstract Admin getAdmin()
                              throws IOException

      Specified by:

      getAdmin in interface Connection

      Throws:

      IOException

    • getOptions

      public BigtableOptions getOptions()

      Getter for the field options.

      Specified by:

      getOptions in interface CommonConnection

      Returns:

      a BigtableOptions object.

    • getDisabledTables

      public Set<TableName> getDisabledTables()

      Getter for the field disabledTables.

      Specified by:

      getDisabledTables in interface CommonConnection

      Returns:

      a Set object.

    • getSession

      public BigtableSession getSession()

      Getter for the field session.

      Specified by:

      getSession in interface CommonConnection

      Returns:

      a BigtableSession object.