org.apache.flink.fs.s3.common.token

Class AbstractS3DelegationTokenProvider

java.lang.Object

org.apache.flink.fs.s3.common.token.AbstractS3DelegationTokenProvider

All Implemented Interfaces:

DelegationTokenProvider

Direct Known Subclasses:

S3HadoopDelegationTokenProvider, S3PrestoDelegationTokenProvider

@Internal
public abstract class AbstractS3DelegationTokenProvider
extends Object
implements DelegationTokenProvider

Delegation token provider for S3 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
AbstractS3DelegationTokenProvider()

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.

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, serviceName

Constructor Detail

AbstractS3DelegationTokenProvider

public AbstractS3DelegationTokenProvider()

Method Detail

init

public void init(Configuration configuration)

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.

delegationTokensRequired

public boolean delegationTokensRequired()

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.

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