TokenProvider (Apache HBase 1.2.12 API)

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

All Implemented Interfaces:

Coprocessor, CoprocessorService, org.apache.hadoop.hbase.protobuf.generated.AuthenticationProtos.AuthenticationService.Interface
```
@InterfaceAudience.Private
public class TokenProvider
extends Object
implements org.apache.hadoop.hbase.protobuf.generated.AuthenticationProtos.AuthenticationService.Interface, Coprocessor, CoprocessorService
```
Provides a service for obtaining authentication tokens via the AuthenticationProtos AuthenticationService coprocessor service.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.Coprocessor
  Coprocessor.State

Field Summary

Fields
Modifier and Type Field and Description

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

private AuthenticationTokenSecretManager secretManager
- Fields inherited from interface org.apache.hadoop.hbase.Coprocessor
  PRIORITY_HIGHEST, PRIORITY_LOWEST, PRIORITY_SYSTEM, PRIORITY_USER, VERSION

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

Constructor Summary

Constructors
Constructor and Description

TokenProvider()

Constructors
Constructor and Description
`TokenProvider()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`getAuthenticationToken(com.google.protobuf.RpcController controller, org.apache.hadoop.hbase.protobuf.generated.AuthenticationProtos.GetAuthenticationTokenRequest request, com.google.protobuf.RpcCallback<org.apache.hadoop.hbase.protobuf.generated.AuthenticationProtos.GetAuthenticationTokenResponse> done)` `rpc GetAuthenticationToken(.GetAuthenticationTokenRequest) returns (.GetAuthenticationTokenResponse);`
`com.google.protobuf.Service`	`getService()`
`private boolean`	`isAllowedDelegationTokenOp(org.apache.hadoop.security.UserGroupInformation ugi)`
`void`	`start(CoprocessorEnvironment env)`
`void`	`stop(CoprocessorEnvironment env)`
`void`	`whoAmI(com.google.protobuf.RpcController controller, org.apache.hadoop.hbase.protobuf.generated.AuthenticationProtos.WhoAmIRequest request, com.google.protobuf.RpcCallback<org.apache.hadoop.hbase.protobuf.generated.AuthenticationProtos.WhoAmIResponse> done)` `rpc WhoAmI(.WhoAmIRequest) returns (.WhoAmIResponse);`

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

secretManager

private AuthenticationTokenSecretManager secretManager

Constructor Detail
- TokenProvider
```
public TokenProvider()
```

Method Detail
- start
```
public void start(CoprocessorEnvironment env)
```
  Specified by:
  
  start in interface Coprocessor
- stop
```
public void stop(CoprocessorEnvironment env)
          throws IOException
```
  Specified by:
  
  stop in interface Coprocessor
  
  Throws:
  
  IOException
- isAllowedDelegationTokenOp
```
private boolean isAllowedDelegationTokenOp(org.apache.hadoop.security.UserGroupInformation ugi)
                                    throws IOException
```
  Parameters:
  ugi - A user group information.
  
  Returns:
  true if delegation token operation is allowed
  
  Throws:
  
  IOException
- getService
```
public com.google.protobuf.Service getService()
```
  Specified by:
  
  getService in interface CoprocessorService
- getAuthenticationToken
```
public void getAuthenticationToken(com.google.protobuf.RpcController controller,
                          org.apache.hadoop.hbase.protobuf.generated.AuthenticationProtos.GetAuthenticationTokenRequest request,
                          com.google.protobuf.RpcCallback<org.apache.hadoop.hbase.protobuf.generated.AuthenticationProtos.GetAuthenticationTokenResponse> done)
```
  Description copied from interface: org.apache.hadoop.hbase.protobuf.generated.AuthenticationProtos.AuthenticationService.Interface
  
  rpc GetAuthenticationToken(.GetAuthenticationTokenRequest) returns (.GetAuthenticationTokenResponse);
  
  Specified by:
  
  getAuthenticationToken in interface org.apache.hadoop.hbase.protobuf.generated.AuthenticationProtos.AuthenticationService.Interface
- whoAmI
```
public void whoAmI(com.google.protobuf.RpcController controller,
          org.apache.hadoop.hbase.protobuf.generated.AuthenticationProtos.WhoAmIRequest request,
          com.google.protobuf.RpcCallback<org.apache.hadoop.hbase.protobuf.generated.AuthenticationProtos.WhoAmIResponse> done)
```
  Description copied from interface: org.apache.hadoop.hbase.protobuf.generated.AuthenticationProtos.AuthenticationService.Interface
  
  rpc WhoAmI(.WhoAmIRequest) returns (.WhoAmIResponse);
  
  Specified by:
  
  whoAmI in interface org.apache.hadoop.hbase.protobuf.generated.AuthenticationProtos.AuthenticationService.Interface

Class TokenProvider

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.Coprocessor

Field Summary

Fields inherited from interface org.apache.hadoop.hbase.Coprocessor

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

secretManager

Constructor Detail

TokenProvider

Method Detail

start

stop

isAllowedDelegationTokenOp

getService

getAuthenticationToken

whoAmI