org.apache.hadoop.hbase.security.token

Class ClientTokenUtil

java.lang.Object

org.apache.hadoop.hbase.security.token.ClientTokenUtil

@InterfaceAudience.Public
public final class ClientTokenUtil
extends Object

Utility methods for obtaining authentication tokens, that do not require hbase-server.

Field Summary

Fields

Modifier and Type	Field and Description
private static com.google.protobuf.ServiceException	injectedException
private static org.slf4j.Logger	LOG

Constructor Summary

Constructors

Modifier	Constructor and Description
private	ClientTokenUtil()

Method Summary

Modifier and Type	Method and Description
private static void	injectFault()
static void	obtainAndCacheToken(Connection conn, User user) Obtain an authentication token for the given user and add it to the user's credentials.
static org.apache.hadoop.security.token.Token<AuthenticationTokenIdentifier>	obtainToken(Connection conn) Obtain and return an authentication token for the current user.
(package private) static org.apache.hadoop.security.token.Token<AuthenticationTokenIdentifier>	obtainToken(Connection conn, User user) Obtain and return an authentication token for the given user.
(package private) static org.apache.hadoop.security.token.Token<AuthenticationTokenIdentifier>	toToken(org.apache.hadoop.hbase.protobuf.generated.AuthenticationProtos.Token proto) Converts a protobuf Token message back into a Token instance.
(package private) static org.apache.hadoop.hbase.protobuf.generated.AuthenticationProtos.Token	toToken(org.apache.hadoop.security.token.Token<AuthenticationTokenIdentifier> token) Converts a Token instance (with embedded identifier) to the protobuf representation.

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

injectedException

private static com.google.protobuf.ServiceException injectedException

Constructor Detail

ClientTokenUtil

private ClientTokenUtil()

Method Detail

injectFault

private static void injectFault()
                         throws com.google.protobuf.ServiceException

Throws:

com.google.protobuf.ServiceException

obtainToken

@InterfaceAudience.Private
public static org.apache.hadoop.security.token.Token<AuthenticationTokenIdentifier> obtainToken(Connection conn)
                                                                                                                    throws IOException

Obtain and return an authentication token for the current user.

Parameters:

conn - The HBase cluster connection

Returns:

the authentication token instance

Throws:

IOException - if a remote error or serialization problem occurs.

toToken

@InterfaceAudience.Private
static org.apache.hadoop.hbase.protobuf.generated.AuthenticationProtos.Token toToken(org.apache.hadoop.security.token.Token<AuthenticationTokenIdentifier> token)

Converts a Token instance (with embedded identifier) to the protobuf representation.

Parameters:

token - the Token instance to copy

Returns:

the protobuf Token message

toToken

@InterfaceAudience.Private
static org.apache.hadoop.security.token.Token<AuthenticationTokenIdentifier> toToken(org.apache.hadoop.hbase.protobuf.generated.AuthenticationProtos.Token proto)

Converts a protobuf Token message back into a Token instance.

Parameters:

proto - the protobuf Token message

Returns:

the Token instance

obtainToken

@InterfaceAudience.Private
static org.apache.hadoop.security.token.Token<AuthenticationTokenIdentifier> obtainToken(Connection conn,
                                                                                                                    User user)
                                                                                                             throws IOException,
                                                                                                                    InterruptedException

Obtain and return an authentication token for the given user.

Parameters:

conn - The HBase cluster connection

user - The user to obtain a token for

Returns:

the authentication token instance

Throws:

IOException

InterruptedException

obtainAndCacheToken

public static void obtainAndCacheToken(Connection conn,
                                       User user)
                                throws IOException,
                                       InterruptedException

Obtain an authentication token for the given user and add it to the user's credentials.

Parameters:

conn - The HBase cluster connection

user - The user for whom to obtain the token

Throws:

IOException - If making a remote call to the authentication service fails

InterruptedException - If executing as the given user is interrupted