org.apache.flink.runtime.security.token.hadoop

Class HadoopFSDelegationTokenProvider

java.lang.Object

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

All Implemented Interfaces:

DelegationTokenProvider

@Internal
public class HadoopFSDelegationTokenProvider
extends Object
implements DelegationTokenProvider

Delegation token provider for Hadoop filesystems.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.core.security.token.DelegationTokenProvider

DelegationTokenProvider.ObtainedDelegationTokens

Field Summary

Fields inherited from interface org.apache.flink.core.security.token.DelegationTokenProvider

CONFIG_PREFIX

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(Configuration configuration) Called by DelegationTokenManager to initialize provider after construction.
DelegationTokenProvider.ObtainedDelegationTokens	obtainDelegationTokens() 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

Methods inherited from interface org.apache.flink.core.security.token.DelegationTokenProvider

serviceConfigPrefix

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(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 DelegationTokenProvider.ObtainedDelegationTokens obtainDelegationTokens()
                                                                        throws Exception

Description copied from interface: DelegationTokenProvider

Obtain delegation tokens for this service.

Specified by:

obtainDelegationTokens in interface DelegationTokenProvider

Returns:

the obtained delegation tokens.

Throws:

Exception

obtainDelegationTokens

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