org.apache.paimon.rest.auth

Class DLFAuthProvider

java.lang.Object

org.apache.paimon.rest.auth.DLFAuthProvider

All Implemented Interfaces:

AuthProvider

public class DLFAuthProvider
extends Object
implements AuthProvider

Auth provider for Ali CLoud DLF.

Field Summary

Fields

Modifier and Type	Field and Description
static java.time.format.DateTimeFormatter	AUTH_DATE_FORMATTER
static java.time.format.DateTimeFormatter	AUTH_DATE_TIME_FORMATTER
static String	DLF_AUTH_VERSION_HEADER_KEY
static String	DLF_AUTHORIZATION_HEADER_KEY
static String	DLF_CONTENT_MD5_HEADER_KEY
static String	DLF_CONTENT_SHA56_HEADER_KEY
static String	DLF_CONTENT_SHA56_VALUE
static String	DLF_CONTENT_TYPE_KEY
static String	DLF_DATE_HEADER_KEY
static String	DLF_HOST_HEADER_KEY
static String	DLF_SECURITY_TOKEN_HEADER_KEY
static double	EXPIRED_FACTOR
protected static okhttp3.MediaType	MEDIA_TYPE
protected DLFToken	token
static java.time.format.DateTimeFormatter	TOKEN_DATE_FORMATTER

Constructor Summary

Constructors

Constructor and Description
DLFAuthProvider(String tokenFilePath, DLFToken token, boolean keepRefreshed, Long expiresAtMillis, Long tokenRefreshInMills, String region)

Method Summary

Modifier and Type	Method and Description
static DLFAuthProvider	buildAKToken(String accessKeyId, String accessKeySecret, String securityToken, String region)
static DLFAuthProvider	buildRefreshToken(String tokenFilePath, Long tokenRefreshInMills, String region)
Optional<Long>	expiresAtMillis()
static Map<String,String>	generateSignHeaders(String host, String data, String dateTime, String securityToken)
Map<String,String>	header(Map<String,String> baseHeader, RESTAuthParameter restAuthParameter)
boolean	keepRefreshed()
protected static DLFToken	readToken(String tokenFilePath, int retryTimes)
boolean	refresh()
Optional<Long>	tokenRefreshInMills()
boolean	willSoonExpire()

Methods inherited from class java.lang.Object

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

Field Detail

DLF_HOST_HEADER_KEY

public static final String DLF_HOST_HEADER_KEY

See Also:

Constant Field Values

DLF_AUTHORIZATION_HEADER_KEY

public static final String DLF_AUTHORIZATION_HEADER_KEY

See Also:

Constant Field Values

DLF_CONTENT_MD5_HEADER_KEY

public static final String DLF_CONTENT_MD5_HEADER_KEY

See Also:

Constant Field Values

DLF_CONTENT_TYPE_KEY

public static final String DLF_CONTENT_TYPE_KEY

See Also:

Constant Field Values

DLF_DATE_HEADER_KEY

public static final String DLF_DATE_HEADER_KEY

See Also:

Constant Field Values

DLF_SECURITY_TOKEN_HEADER_KEY

public static final String DLF_SECURITY_TOKEN_HEADER_KEY

See Also:

Constant Field Values

DLF_AUTH_VERSION_HEADER_KEY

public static final String DLF_AUTH_VERSION_HEADER_KEY

See Also:

Constant Field Values

DLF_CONTENT_SHA56_HEADER_KEY

public static final String DLF_CONTENT_SHA56_HEADER_KEY

See Also:

Constant Field Values

DLF_CONTENT_SHA56_VALUE

public static final String DLF_CONTENT_SHA56_VALUE

See Also:

Constant Field Values

EXPIRED_FACTOR

public static final double EXPIRED_FACTOR

See Also:

Constant Field Values

TOKEN_DATE_FORMATTER

public static final java.time.format.DateTimeFormatter TOKEN_DATE_FORMATTER

AUTH_DATE_TIME_FORMATTER

public static final java.time.format.DateTimeFormatter AUTH_DATE_TIME_FORMATTER

AUTH_DATE_FORMATTER

public static final java.time.format.DateTimeFormatter AUTH_DATE_FORMATTER

MEDIA_TYPE

protected static final okhttp3.MediaType MEDIA_TYPE

token

protected DLFToken token

Constructor Detail

DLFAuthProvider

public DLFAuthProvider(String tokenFilePath,
                       DLFToken token,
                       boolean keepRefreshed,
                       Long expiresAtMillis,
                       Long tokenRefreshInMills,
                       String region)

Method Detail

buildRefreshToken

public static DLFAuthProvider buildRefreshToken(String tokenFilePath,
                                                Long tokenRefreshInMills,
                                                String region)

buildAKToken

public static DLFAuthProvider buildAKToken(String accessKeyId,
                                           String accessKeySecret,
                                           String securityToken,
                                           String region)

header

public Map<String,String> header(Map<String,String> baseHeader,
                                 RESTAuthParameter restAuthParameter)

Specified by:

header in interface AuthProvider

generateSignHeaders

public static Map<String,String> generateSignHeaders(String host,
                                                     String data,
                                                     String dateTime,
                                                     String securityToken)
                                              throws Exception

Throws:

Exception

refresh

public boolean refresh()

Specified by:

refresh in interface AuthProvider

keepRefreshed

public boolean keepRefreshed()

Specified by:

keepRefreshed in interface AuthProvider

willSoonExpire

public boolean willSoonExpire()

Specified by:

willSoonExpire in interface AuthProvider

expiresAtMillis

public Optional<Long> expiresAtMillis()

Specified by:

expiresAtMillis in interface AuthProvider

tokenRefreshInMills

public Optional<Long> tokenRefreshInMills()

Specified by:

tokenRefreshInMills in interface AuthProvider

readToken

protected static DLFToken readToken(String tokenFilePath,
                                    int retryTimes)