org.apache.hadoop.hbase

Class SharedConnection

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.

Constructor Summary

Constructors

Constructor and Description
SharedConnection(Connection conn)

Method Summary

Modifier and Type	Method and Description
void	abort(String why, Throwable e) Abort the server or client.
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.
org.apache.hadoop.conf.Configuration	getConfiguration()
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

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()

Specified by:

getConfiguration in interface Connection

Returns:

Configuration instance being used by this Connection instance.

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 BufferedMutator will use the Connection's ExecutorService. This object can be used for long lived operations.

The caller is responsible for calling BufferedMutator.close() on the returned BufferedMutator instance.

This accessor will use the connection's ExecutorService and will throw an exception in the main thread when an asynchronous exception occurs.

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. 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