org.apache.hadoop.hbase.util

Class ConnectionCache

java.lang.Object

org.apache.hadoop.hbase.util.ConnectionCache

@InterfaceAudience.Private
public class ConnectionCache
extends Object

A utility to store user specific HConnections in memory. There is a chore to clean up connections idle for too long. This class is used by REST server and Thrift server to support authentication and impersonation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	ConnectionCache.ConnectionInfo

Field Summary

Fields

Modifier and Type	Field and Description
private ChoreService	choreService
private org.apache.hadoop.conf.Configuration	conf
private Map<String,ConnectionCache.ConnectionInfo>	connections
private ThreadLocal<String>	effectiveUserNames
private KeyLocker<String>	locker
private static org.slf4j.Logger	LOG
private org.apache.hadoop.security.UserGroupInformation	realUser
private String	realUserName
private UserProvider	userProvider

Constructor Summary

Constructors

Constructor and Description
ConnectionCache(org.apache.hadoop.conf.Configuration conf, UserProvider userProvider, int cleanInterval, int maxIdleTime)

Method Summary

Modifier and Type	Method and Description
Admin	getAdmin() Caller doesn't close the admin afterwards.
String	getClusterId() Returns Cluster ID for the HBase cluster or null if there is an err making the connection.
(package private) ConnectionCache.ConnectionInfo	getCurrentConnection() Get the cached connection for the current user.
String	getEffectiveUser() Get the current thread local effective user
RegionLocator	getRegionLocator(byte[] tableName) Retrieve a regionLocator for the table.
Table	getTable(String tableName) Caller closes the table afterwards.
void	setEffectiveUser(String user) Set the current thread local effective user
void	shutdown() Called when cache is no longer needed so that it can perform cleanup operations
boolean	updateConnectionAccessTime() Updates the access time for the current connection.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.slf4j.Logger LOG

connections

private final Map<String,ConnectionCache.ConnectionInfo> connections

locker

private final KeyLocker<String> locker

realUserName

private final String realUserName

realUser

private final org.apache.hadoop.security.UserGroupInformation realUser

userProvider

private final UserProvider userProvider

conf

private final org.apache.hadoop.conf.Configuration conf

choreService

private final ChoreService choreService

effectiveUserNames

private final ThreadLocal<String> effectiveUserNames

Constructor Detail

ConnectionCache

public ConnectionCache(org.apache.hadoop.conf.Configuration conf,
                       UserProvider userProvider,
                       int cleanInterval,
                       int maxIdleTime)
                throws IOException

Throws:

IOException

Method Detail

setEffectiveUser

public void setEffectiveUser(String user)

Set the current thread local effective user

getEffectiveUser

public String getEffectiveUser()

Get the current thread local effective user

shutdown

public void shutdown()

Called when cache is no longer needed so that it can perform cleanup operations

getAdmin

public Admin getAdmin()
               throws IOException

Caller doesn't close the admin afterwards. We need to manage it and close it properly.

Throws:

IOException

getTable

public Table getTable(String tableName)
               throws IOException

Caller closes the table afterwards.

Throws:

IOException

getRegionLocator

public RegionLocator getRegionLocator(byte[] tableName)
                               throws IOException

Retrieve a regionLocator for the table. The user should close the RegionLocator.

Throws:

IOException

getCurrentConnection

ConnectionCache.ConnectionInfo getCurrentConnection()
                                             throws IOException

Get the cached connection for the current user. If none or timed out, create a new one.

Throws:

IOException

updateConnectionAccessTime

public boolean updateConnectionAccessTime()

Updates the access time for the current connection. Used to keep Connections alive for long-lived scanners.

Returns:

whether we successfully updated the last access time

getClusterId

public String getClusterId()

Returns Cluster ID for the HBase cluster or null if there is an err making the connection.