org.apache.flink.runtime.security.token

Class HadoopFSDelegationTokenProvider

java.lang.Object

org.apache.flink.runtime.security.token.HadoopFSDelegationTokenProvider

All Implemented Interfaces:

DelegationTokenProvider

@Experimental
public class HadoopFSDelegationTokenProvider
extends Object
implements DelegationTokenProvider

Delegation token provider for Hadoop filesystems.

Constructor Summary

Constructors

Constructor and Description
HadoopFSDelegationTokenProvider()

Method Summary

Modifier and Type	Method and Description
boolean	delegationTokensRequired() Return whether delegation tokens are required for this service.
void	init(org.apache.flink.configuration.Configuration configuration) Called by DelegationTokenManager to initialize provider after construction.
Optional<Long>	obtainDelegationTokens(org.apache.hadoop.security.Credentials credentials) Obtain delegation tokens for this service.
protected void	obtainDelegationTokens(String renewer, Set<org.apache.hadoop.fs.FileSystem> fileSystemsToAccess, org.apache.hadoop.security.Credentials credentials)
String	serviceName() Name of the service to provide delegation tokens.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HadoopFSDelegationTokenProvider

public HadoopFSDelegationTokenProvider()

Method Detail

serviceName

public String serviceName()

Description copied from interface: DelegationTokenProvider

Name of the service to provide delegation tokens. This name should be unique.

Specified by:

serviceName in interface DelegationTokenProvider

init

public void init(org.apache.flink.configuration.Configuration configuration)
          throws Exception

Description copied from interface: DelegationTokenProvider

Called by DelegationTokenManager to initialize provider after construction.

Specified by:

init in interface DelegationTokenProvider

Parameters:

configuration - Configuration to initialize the provider.

Throws:

Exception

delegationTokensRequired

public boolean delegationTokensRequired()
                                 throws Exception

Description copied from interface: DelegationTokenProvider

Return whether delegation tokens are required for this service.

Specified by:

delegationTokensRequired in interface DelegationTokenProvider

Returns:

true if delegation tokens are required.

Throws:

Exception

obtainDelegationTokens

public Optional<Long> obtainDelegationTokens(org.apache.hadoop.security.Credentials credentials)
                                      throws Exception

Description copied from interface: DelegationTokenProvider

Obtain delegation tokens for this service.

Specified by:

obtainDelegationTokens in interface DelegationTokenProvider

Parameters:

credentials - Credentials to add tokens and security keys to.

Returns:

If the returned tokens are renewable and can be renewed, return the time of the next renewal, otherwise `Optional.empty()` should be returned.

Throws:

Exception

obtainDelegationTokens

protected void obtainDelegationTokens(@Nullable
                                      String renewer,
                                      Set<org.apache.hadoop.fs.FileSystem> fileSystemsToAccess,
                                      org.apache.hadoop.security.Credentials credentials)