DelegationTokenProvider (Flink : 2.0-SNAPSHOT API)

All Known Implementing Classes:

AbstractS3DelegationTokenProvider, HadoopFSDelegationTokenProvider, HBaseDelegationTokenProvider, S3HadoopDelegationTokenProvider, S3PrestoDelegationTokenProvider
```
@Experimental
public interface DelegationTokenProvider
```
Delegation token provider API. Instances of DelegationTokenProviders are loaded by DelegationTokenManager through service loader. Basically the implementation of this interface is responsible to produce the serialized form of tokens which will be handled by DelegationTokenReceiver instances both on JobManager and TaskManager side.

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class DelegationTokenProvider.ObtainedDelegationTokens
Container for obtained delegation tokens.

Field Summary

Fields
Modifier and Type Field Description

static String CONFIG_PREFIX
Config prefix of providers.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`boolean`	`delegationTokensRequired()`	Return whether delegation tokens are required for this service.
`void`	`init(Configuration configuration)`	Called by DelegationTokenManager to initialize provider after construction.
`DelegationTokenProvider.ObtainedDelegationTokens`	`obtainDelegationTokens()`	Obtain delegation tokens for this service.
`default String`	`serviceConfigPrefix()`	Config prefix of the service.
`String`	`serviceName()`	Name of the service to provide delegation tokens.

- Field Detail
  - CONFIG_PREFIX
```
static final String CONFIG_PREFIX
```
    Config prefix of providers.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - serviceName
```
String serviceName()
```
    Name of the service to provide delegation tokens. This name should be unique.
  - serviceConfigPrefix
```
default String serviceConfigPrefix()
```
    Config prefix of the service.
  - init
```
void init(Configuration configuration)
   throws Exception
```
    Called by DelegationTokenManager to initialize provider after construction.
    
    Parameters:
    
    configuration - Configuration to initialize the provider.
    
    Throws:
    
    Exception
  - delegationTokensRequired
```
boolean delegationTokensRequired()
                          throws Exception
```
    Return whether delegation tokens are required for this service.
    
    Returns:
    
    true if delegation tokens are required.
    
    Throws:
    
    Exception
  - obtainDelegationTokens
```
DelegationTokenProvider.ObtainedDelegationTokens obtainDelegationTokens()
                                                                 throws Exception
```
    Obtain delegation tokens for this service.
    
    Returns:
    
    the obtained delegation tokens.
    
    Throws:
    
    Exception