SharedConnection (Apache HBase 2.5.0 API)

java.lang.Object
- org.apache.hadoop.hbase.SharedConnection

All Implemented Interfaces:

Closeable, AutoCloseable, Abortable, Connection
```
@InterfaceAudience.Private
public class SharedConnection
extends Object
implements Connection
```
Wraps a Connection to make it can't be closed or aborted.

Field Summary

Fields
Modifier and Type Field and Description

private Connection conn

Fields
Modifier and Type	Field and Description
`private Connection`	`conn`

Constructor Summary

Constructors
Constructor and Description

SharedConnection(Connection conn)

Constructors
Constructor and Description
`SharedConnection(Connection conn)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`abort(String why, Throwable e)` Abort the server or client.
`void`	`clearRegionLocationCache()` Clear all the entries in the region location cache, for all the tables.
`void`	`close()`
`Admin`	`getAdmin()` Retrieve an Admin implementation to administer an HBase cluster.
`BufferedMutator`	`getBufferedMutator(BufferedMutatorParams params)` Retrieve a `BufferedMutator` for performing client-side buffering of writes.
`BufferedMutator`	`getBufferedMutator(TableName tableName)` Retrieve a `BufferedMutator` for performing client-side buffering of writes.
`String`	`getClusterId()` Returns the cluster ID unique to this HBase cluster.
`org.apache.hadoop.conf.Configuration`	`getConfiguration()` Returns Configuration instance being used by this Connection instance.
`Hbck`	`getHbck()` Retrieve an Hbck implementation to fix an HBase cluster.
`Hbck`	`getHbck(ServerName masterServer)` Retrieve an Hbck implementation to fix an HBase cluster.
`RegionLocator`	`getRegionLocator(TableName tableName)` Retrieve a RegionLocator implementation to inspect region information on a table.
`TableBuilder`	`getTableBuilder(TableName tableName, ExecutorService pool)` Returns an `TableBuilder` for creating `Table`.
`boolean`	`isAborted()` Check if the server or client was aborted.
`boolean`	`isClosed()` Returns whether the connection is closed or not.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

Methods inherited from interface org.apache.hadoop.hbase.Abortable
abort

- Field Detail
  - conn
```
private final Connection conn
```
- Constructor Detail
  - SharedConnection
```
public SharedConnection(Connection conn)
```
- Method Detail
  - 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
  - isClosed
```
public boolean isClosed()
```
    Description copied from interface: Connection
    
    Returns whether the connection is closed or not.
    
    Specified by:
    
    isClosed in interface Connection
    
    Returns:
    
    true if this connection is closed
  - abort
```
public void abort(String why,
                  Throwable e)
```
    Description copied from interface: Abortable
    
    Abort the server or client.
    
    Specified by:
    
    abort in interface Abortable
    
    Parameters:
    
    why - Why we're aborting.
    
    e - Throwable that caused abort. Can be null.
  - isAborted
```
public boolean isAborted()
```
    Description copied from interface: Abortable
    
    Check if the server or client was aborted.
    
    Specified by:
    
    isAborted in interface Abortable
    
    Returns:
    
    true if the server or client was aborted, false otherwise
  - getConfiguration
```
public org.apache.hadoop.conf.Configuration getConfiguration()
```
    Description copied from interface: Connection
    
    Returns Configuration instance being used by this Connection instance.
    
    Specified by:
    
    getConfiguration in interface Connection
  - getBufferedMutator
```
public BufferedMutator getBufferedMutator(TableName tableName)
                                   throws IOException
```
    Description copied from interface: Connection
    
    Retrieve a BufferedMutator for performing client-side buffering of writes. The BufferedMutator returned by this method is thread-safe. This accessor will create a new ThreadPoolExecutor and will be shutdown once we close the BufferedMutator. This object can be used for long lived operations.
    
    The caller is responsible for calling BufferedMutator.close() on the returned BufferedMutator instance.
    
    Specified by:
    
    getBufferedMutator in interface Connection
    
    Parameters:
    
    tableName - the name of the table
    
    Returns:
    
    a BufferedMutator for the supplied tableName.
    
    Throws:
    
    IOException
  - getBufferedMutator
```
public BufferedMutator getBufferedMutator(BufferedMutatorParams params)
                                   throws IOException
```
    Description copied from interface: Connection
    
    Retrieve a BufferedMutator for performing client-side buffering of writes. The BufferedMutator returned by this method is thread-safe. This object can be used for long lived table operations. If user passes ThreadPool in BufferedMutatorParams then we will use that otherwise we will create for the user. For user specified ThreadPool, it is the user's responsibility to shutdown. For ThreadPool created by us, we will shutdown when user calls BufferedMutator.close(). The caller is responsible for calling BufferedMutator.close() on the returned BufferedMutator instance.
    
    Specified by:
    
    getBufferedMutator in interface Connection
    
    Parameters:
    
    params - details on how to instantiate the BufferedMutator.
    
    Returns:
    
    a BufferedMutator for the supplied tableName.
    
    Throws:
    
    IOException
  - getRegionLocator
```
public RegionLocator getRegionLocator(TableName tableName)
                               throws IOException
```
    Description copied from interface: Connection
    
    Retrieve a RegionLocator implementation to inspect region information on a table. The returned RegionLocator is not thread-safe, so a new instance should be created for each using thread. This is a lightweight operation. Pooling or caching of the returned RegionLocator is neither required nor desired.
    The caller is responsible for calling Closeable.close() on the returned RegionLocator instance. RegionLocator needs to be unmanaged
    
    Specified by:
    
    getRegionLocator in interface Connection
    
    Parameters:
    
    tableName - Name of the table who's region is to be examined
    
    Returns:
    
    A RegionLocator instance
    
    Throws:
    
    IOException
  - getAdmin
```
public Admin getAdmin()
               throws IOException
```
    Description copied from interface: Connection
    
    Retrieve an Admin implementation to administer an HBase cluster. The returned Admin is not guaranteed to be thread-safe. A new instance should be created for each using thread. This is a lightweight operation. Pooling or caching of the returned Admin is not recommended.
    The caller is responsible for calling Admin.close() on the returned Admin instance.
    
    Specified by:
    
    getAdmin in interface Connection
    
    Returns:
    
    an Admin instance for cluster administration
    
    Throws:
    
    IOException
  - getTableBuilder
```
public TableBuilder getTableBuilder(TableName tableName,
                                    ExecutorService pool)
```
    Description copied from interface: Connection
    
    Returns an TableBuilder for creating Table.
    
    Specified by:
    
    getTableBuilder in interface Connection
    
    Parameters:
    
    tableName - the name of the table
    
    pool - the thread pool to use for requests like batch and scan
  - clearRegionLocationCache
```
public void clearRegionLocationCache()
```
    Description copied from interface: Connection
    
    Clear all the entries in the region location cache, for all the tables.
    If you only want to clear the cache for a specific table, use RegionLocator.clearRegionLocationCache().
    This may cause performance issue so use it with caution.
    
    Specified by:
    
    clearRegionLocationCache in interface Connection
  - getHbck
```
public Hbck getHbck()
             throws IOException
```
    Description copied from interface: Connection
    
    Retrieve an Hbck implementation to fix an HBase cluster. The returned Hbck is not guaranteed to be thread-safe. A new instance should be created by each thread. This is a lightweight operation. Pooling or caching of the returned Hbck instance is not recommended.
    The caller is responsible for calling Closeable.close() on the returned Hbck instance.
    This will be used mostly by hbck tool.
    
    Specified by:
    
    getHbck in interface Connection
    
    Returns:
    
    an Hbck instance for active master. Active master is fetched from the zookeeper.
    
    Throws:
    
    IOException
  - getHbck
```
public Hbck getHbck(ServerName masterServer)
             throws IOException
```
    Description copied from interface: Connection
    
    Retrieve an Hbck implementation to fix an HBase cluster. The returned Hbck is not guaranteed to be thread-safe. A new instance should be created by each thread. This is a lightweight operation. Pooling or caching of the returned Hbck instance is not recommended.
    The caller is responsible for calling Closeable.close() on the returned Hbck instance.
    This will be used mostly by hbck tool. This may only be used to by pass getting registered master from ZK. In situations where ZK is not available or active master is not registered with ZK and user can get master address by other means, master can be explicitly specified.
    
    Specified by:
    
    getHbck in interface Connection
    
    Parameters:
    
    masterServer - explicit ServerName for master server
    
    Returns:
    
    an Hbck instance for a specified master server
    
    Throws:
    
    IOException
  - getClusterId
```
public String getClusterId()
```
    Description copied from interface: Connection
    
    Returns the cluster ID unique to this HBase cluster.
    The default implementation is added to keep client compatibility.
    
    Specified by:
    
    getClusterId in interface Connection

Class SharedConnection

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hadoop.hbase.Abortable

Field Detail

conn

Constructor Detail

SharedConnection

Method Detail

close

isClosed

abort

isAborted

getConfiguration

getBufferedMutator

getBufferedMutator

getRegionLocator

getAdmin

getTableBuilder

clearRegionLocationCache

getHbck

getHbck

getClusterId