org.apache.hadoop.hbase.security.token

Class TokenProvider

java.lang.Object

org.apache.hadoop.hbase.security.token.TokenProvider

All Implemented Interfaces:

Coprocessor, RegionCoprocessor, 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, RegionCoprocessor

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.slf4j.Logger	LOG
private AuthenticationTokenSecretManager	secretManager

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

PRIORITY_HIGHEST, PRIORITY_LOWEST, PRIORITY_SYSTEM, PRIORITY_USER, VERSION

Constructor Summary

Constructors

Constructor and Description
TokenProvider()

Method Summary

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(.hbase.pb.GetAuthenticationTokenRequest) returns (.hbase.pb.GetAuthenticationTokenResponse);
Iterable<com.google.protobuf.Service>	getServices() Coprocessor endpoints providing protobuf services should override this method.
private boolean	isAllowedDelegationTokenOp(org.apache.hadoop.security.UserGroupInformation ugi)
void	start(CoprocessorEnvironment env) Called by the CoprocessorEnvironment during it's own startup to initialize the coprocessor.
void	stop(CoprocessorEnvironment env) Called by the CoprocessorEnvironment during it's own shutdown to stop the coprocessor.
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(.hbase.pb.WhoAmIRequest) returns (.hbase.pb.WhoAmIResponse);

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

getBulkLoadObserver, getEndpointObserver, getRegionObserver

Field Detail

LOG

private static final org.slf4j.Logger LOG

secretManager

private AuthenticationTokenSecretManager secretManager

Constructor Detail

TokenProvider

public TokenProvider()

Method Detail

start

public void start(CoprocessorEnvironment env)

Description copied from interface: Coprocessor

Called by the CoprocessorEnvironment during it's own startup to initialize the coprocessor.

Specified by:

start in interface Coprocessor

stop

public void stop(CoprocessorEnvironment env)
          throws IOException

Description copied from interface: Coprocessor

Called by the CoprocessorEnvironment during it's own shutdown to stop the coprocessor.

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

getServices

public Iterable<com.google.protobuf.Service> getServices()

Description copied from interface: Coprocessor

Coprocessor endpoints providing protobuf services should override this method.

Specified by:

getServices in interface Coprocessor

Returns:

Iterable of Services or empty collection. Implementations should never return null.

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(.hbase.pb.GetAuthenticationTokenRequest) returns (.hbase.pb.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(.hbase.pb.WhoAmIRequest) returns (.hbase.pb.WhoAmIResponse);

Specified by:

whoAmI in interface org.apache.hadoop.hbase.protobuf.generated.AuthenticationProtos.AuthenticationService.Interface