TokenUtil (Apache HBase 1.2.12 API)

java.lang.Object
- org.apache.hadoop.hbase.security.token.TokenUtil

@InterfaceAudience.Public
@InterfaceStability.Evolving
public class TokenUtil
extends Object

Utility methods for obtaining authentication tokens.

Field Summary

Fields
Modifier and Type Field and Description

private static org.apache.commons.logging.Log LOG

Fields
Modifier and Type	Field and Description
`private static org.apache.commons.logging.Log`	`LOG`

Constructor Summary

Constructors
Constructor and Description

TokenUtil()

Constructors
Constructor and Description
`TokenUtil()`

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`addTokenForJob(Connection conn, org.apache.hadoop.mapred.JobConf job, User user)` Checks for an authentication token for the given user, obtaining a new token if necessary, and adds it to the credentials for the given map reduce job.
`static void`	`addTokenForJob(Connection conn, User user, org.apache.hadoop.mapreduce.Job job)` Checks for an authentication token for the given user, obtaining a new token if necessary, and adds it to the credentials for the given map reduce job.
`static boolean`	`addTokenIfMissing(Connection conn, User user)` Checks if an authentication tokens exists for the connected cluster, obtaining one if needed and adding it to the user's credentials.
`private static org.apache.hadoop.security.token.Token<AuthenticationTokenIdentifier>`	`getAuthToken(org.apache.hadoop.conf.Configuration conf, User user)` Get the authentication token of the user for the cluster specified in the configuration
`private static org.apache.hadoop.io.Text`	`getClusterId(org.apache.hadoop.security.token.Token<AuthenticationTokenIdentifier> token)`
`static void`	`obtainAndCacheToken(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.security.UserGroupInformation user)` Deprecated. Replaced by `obtainAndCacheToken(Connection,User)`
`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(org.apache.hadoop.conf.Configuration conf)` Deprecated. Replaced by `obtainToken(Connection)`
`static org.apache.hadoop.security.token.Token<AuthenticationTokenIdentifier>`	`obtainToken(Connection conn)` Obtain and return an authentication token for the current user.
`static org.apache.hadoop.security.token.Token<AuthenticationTokenIdentifier>`	`obtainToken(Connection conn, User user)` Obtain and return an authentication token for the current user.
`static void`	`obtainTokenForJob(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.security.UserGroupInformation user, org.apache.hadoop.mapreduce.Job job)` Deprecated. Replaced by `obtainTokenForJob(Connection,User,Job)`
`static void`	`obtainTokenForJob(Connection conn, org.apache.hadoop.mapred.JobConf job, User user)` Obtain an authentication token on behalf of the given user and add it to the credentials for the given map reduce job.
`static void`	`obtainTokenForJob(Connection conn, User user, org.apache.hadoop.mapreduce.Job job)` Obtain an authentication token on behalf of the given user and add it to the credentials for the given map reduce job.
`static void`	`obtainTokenForJob(org.apache.hadoop.mapred.JobConf job, org.apache.hadoop.security.UserGroupInformation user)` Deprecated. Replaced by `obtainTokenForJob(Connection,JobConf,User)`

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.apache.commons.logging.Log LOG

Constructor Detail
- TokenUtil
```
public TokenUtil()
```

Method Detail
- obtainToken
```
@Deprecated
public static org.apache.hadoop.security.token.Token<AuthenticationTokenIdentifier> obtainToken(org.apache.hadoop.conf.Configuration conf)
                                                                                         throws IOException
```
  Deprecated. Replaced by obtainToken(Connection)
  
  Obtain and return an authentication token for the current user.
  
  Parameters:
  conf - the configuration for connecting to the cluster
  
  Returns:
  the authentication token instance
  
  Throws:
  
  IOException
- obtainToken
```
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
- obtainToken
```
public static org.apache.hadoop.security.token.Token<AuthenticationTokenIdentifier> obtainToken(Connection conn,
                                                                                User user)
                                                                                         throws IOException,
                                                                                                InterruptedException
```
  Obtain and return an authentication token for the current user.
  
  Parameters:
  conn - The HBase cluster connection
  
  Returns:
  the authentication token instance
  
  Throws:
  
  IOException
  
  InterruptedException
- getClusterId
```
private static org.apache.hadoop.io.Text getClusterId(org.apache.hadoop.security.token.Token<AuthenticationTokenIdentifier> token)
                                               throws IOException
```
  Throws:
  
  IOException
- obtainAndCacheToken
```
@Deprecated
public static void obtainAndCacheToken(org.apache.hadoop.conf.Configuration conf,
                                  org.apache.hadoop.security.UserGroupInformation user)
                                throws IOException,
                                       InterruptedException
```
  Deprecated. Replaced by obtainAndCacheToken(Connection,User)
  
  Obtain an authentication token for the given user and add it to the user's credentials.
  
  Parameters:
  conf - The configuration for connecting to the cluster
  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
- 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
- obtainTokenForJob
```
@Deprecated
public static void obtainTokenForJob(org.apache.hadoop.conf.Configuration conf,
                                org.apache.hadoop.security.UserGroupInformation user,
                                org.apache.hadoop.mapreduce.Job job)
                              throws IOException,
                                     InterruptedException
```
  Deprecated. Replaced by obtainTokenForJob(Connection,User,Job)
  
  Obtain an authentication token on behalf of the given user and add it to the credentials for the given map reduce job.
  
  Parameters:
  conf - The configuration for connecting to the cluster
  user - The user for whom to obtain the token
  job - The job instance in which the token should be stored
  
  Throws:
  
  IOException - If making a remote call to the authentication service fails
  
  InterruptedException - If executing as the given user is interrupted
- obtainTokenForJob
```
public static void obtainTokenForJob(Connection conn,
                     User user,
                     org.apache.hadoop.mapreduce.Job job)
                              throws IOException,
                                     InterruptedException
```
  Obtain an authentication token on behalf of the given user and add it to the credentials for the given map reduce job.
  
  Parameters:
  conn - The HBase cluster connection
  user - The user for whom to obtain the token
  job - The job instance in which the token should be stored
  
  Throws:
  
  IOException - If making a remote call to the authentication service fails
  
  InterruptedException - If executing as the given user is interrupted
- obtainTokenForJob
```
@Deprecated
public static void obtainTokenForJob(org.apache.hadoop.mapred.JobConf job,
                                org.apache.hadoop.security.UserGroupInformation user)
                              throws IOException,
                                     InterruptedException
```
  Deprecated. Replaced by obtainTokenForJob(Connection,JobConf,User)
  
  Obtain an authentication token on behalf of the given user and add it to the credentials for the given map reduce job.
  
  Parameters:
  user - The user for whom to obtain the token
  job - The job configuration in which the token should be stored
  
  Throws:
  
  IOException - If making a remote call to the authentication service fails
  
  InterruptedException - If executing as the given user is interrupted
- obtainTokenForJob
```
public static void obtainTokenForJob(Connection conn,
                     org.apache.hadoop.mapred.JobConf job,
                     User user)
                              throws IOException,
                                     InterruptedException
```
  Obtain an authentication token on behalf of the given user and add it to the credentials for the given map reduce job.
  
  Parameters:
  conn - The HBase cluster connection
  user - The user for whom to obtain the token
  job - The job configuration in which the token should be stored
  
  Throws:
  
  IOException - If making a remote call to the authentication service fails
  
  InterruptedException - If executing as the given user is interrupted
- addTokenForJob
```
public static void addTokenForJob(Connection conn,
                  org.apache.hadoop.mapred.JobConf job,
                  User user)
                           throws IOException,
                                  InterruptedException
```
  Checks for an authentication token for the given user, obtaining a new token if necessary, and adds it to the credentials for the given map reduce job.
  
  Parameters:
  conn - The HBase cluster connection
  user - The user for whom to obtain the token
  job - The job configuration in which the token should be stored
  
  Throws:
  
  IOException - If making a remote call to the authentication service fails
  
  InterruptedException - If executing as the given user is interrupted
- addTokenForJob
```
public static void addTokenForJob(Connection conn,
                  User user,
                  org.apache.hadoop.mapreduce.Job job)
                           throws IOException,
                                  InterruptedException
```
  Checks for an authentication token for the given user, obtaining a new token if necessary, and adds it to the credentials for the given map reduce job.
  
  Parameters:
  conn - The HBase cluster connection
  user - The user for whom to obtain the token
  job - The job instance in which the token should be stored
  
  Throws:
  
  IOException - If making a remote call to the authentication service fails
  
  InterruptedException - If executing as the given user is interrupted
- addTokenIfMissing
```
public static boolean addTokenIfMissing(Connection conn,
                        User user)
                                 throws IOException,
                                        InterruptedException
```
  Checks if an authentication tokens exists for the connected cluster, obtaining one if needed and adding it to the user's credentials.
  
  Parameters:
  conn - The HBase cluster connection
  user - The user for whom to obtain the token
  
  Returns:
  true if the token was added, false if it already existed
  
  Throws:
  
  IOException - If making a remote call to the authentication service fails
  
  InterruptedException - If executing as the given user is interrupted
- getAuthToken
```
private static org.apache.hadoop.security.token.Token<AuthenticationTokenIdentifier> getAuthToken(org.apache.hadoop.conf.Configuration conf,
                                                                                 User user)
                                                                                           throws IOException,
                                                                                                  InterruptedException
```
  Get the authentication token of the user for the cluster specified in the configuration
  
  Returns:
  null if the user does not have the token, otherwise the auth token for the cluster.
  
  Throws:
  
  IOException
  
  InterruptedException

Class TokenUtil

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

Constructor Detail

TokenUtil

Method Detail

obtainToken

obtainToken

obtainToken

getClusterId

obtainAndCacheToken

obtainAndCacheToken

obtainTokenForJob

obtainTokenForJob

obtainTokenForJob

obtainTokenForJob

addTokenForJob

addTokenForJob

addTokenIfMissing

getAuthToken