Package org.apache.iceberg.rest.auth

Class OAuth2Util

java.lang.Object

org.apache.iceberg.rest.auth.OAuth2Util

public class OAuth2Util
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OAuth2Util.AuthSession	Class to handle authorization headers and token refresh.

Method Summary

Modifier and Type	Method	Description
static Map<String,String>	authHeaders(String token)
static Map<String,String>	basicAuthHeaders(String credential)
static Map<String,String>	buildOptionalParam(Map<String,String> properties)
static Map<String,String>	buildOptionalParam(Map<String,String> properties, String defaultScope)
static OAuthTokenResponse	exchangeToken(RESTClient client, Map<String,String> headers, String subjectToken, String subjectTokenType, String actorToken, String actorTokenType, String scope)	Deprecated. since 1.10.0, will be removed in 1.11.0; use exchangeToken(RESTClient, Map, String, String, String, String, String, String, Map) instead.
static OAuthTokenResponse	exchangeToken(RESTClient client, Map<String,String> headers, String subjectToken, String subjectTokenType, String actorToken, String actorTokenType, String scope, String oauth2ServerUri)	Deprecated. since 1.10.0, will be removed in 1.11.0; use exchangeToken(RESTClient, Map, String, String, String, String, String, String, Map) instead.
static OAuthTokenResponse	exchangeToken(RESTClient client, Map<String,String> headers, String subjectToken, String subjectTokenType, String actorToken, String actorTokenType, String scope, String oauth2ServerUri, Map<String,String> optionalParams)
static OAuthTokenResponse	fetchToken(RESTClient client, Map<String,String> headers, String credential, String scope)	Deprecated. since 1.10.0, will be removed in 1.11.0; use fetchToken(RESTClient, Map, String, String, String, Map) instead.
static OAuthTokenResponse	fetchToken(RESTClient client, Map<String,String> headers, String credential, String scope, String oauth2ServerUri)	Deprecated. since 1.10.0, will be removed in 1.11.0; use fetchToken(RESTClient, Map, String, String, String, Map) instead.
static OAuthTokenResponse	fetchToken(RESTClient client, Map<String,String> headers, String credential, String scope, String oauth2ServerUri, Map<String,String> optionalParams)
static boolean	isValidScopeToken(String scopeToken)
static List<String>	parseScope(String scope)
static OAuthTokenResponse	tokenResponseFromJson(com.fasterxml.jackson.databind.JsonNode json)
static OAuthTokenResponse	tokenResponseFromJson(String json)
static String	tokenResponseToJson(OAuthTokenResponse response)
static void	tokenResponseToJson(OAuthTokenResponse response, com.fasterxml.jackson.core.JsonGenerator gen)
static String	toScope(Iterable<String> scopes)

Methods inherited from class java.lang.Object

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

Method Details

authHeaders

public static Map<String,String> authHeaders(String token)

basicAuthHeaders

public static Map<String,String> basicAuthHeaders(String credential)

isValidScopeToken

public static boolean isValidScopeToken(String scopeToken)

parseScope

public static List<String> parseScope(String scope)

toScope

public static String toScope(Iterable<String> scopes)

buildOptionalParam

public static Map<String,String> buildOptionalParam(Map<String,String> properties)

buildOptionalParam

public static Map<String,String> buildOptionalParam(Map<String,String> properties,
 String defaultScope)

exchangeToken

public static OAuthTokenResponse exchangeToken(RESTClient client,
 Map<String,String> headers,
 String subjectToken,
 String subjectTokenType,
 String actorToken,
 String actorTokenType,
 String scope,
 String oauth2ServerUri,
 Map<String,String> optionalParams)

exchangeToken

@Deprecated
public static OAuthTokenResponse exchangeToken(RESTClient client,
 Map<String,String> headers,
 String subjectToken,
 String subjectTokenType,
 String actorToken,
 String actorTokenType,
 String scope)

Deprecated.

since 1.10.0, will be removed in 1.11.0; use exchangeToken(RESTClient, Map, String, String, String, String, String, String, Map) instead.

exchangeToken

@Deprecated
public static OAuthTokenResponse exchangeToken(RESTClient client,
 Map<String,String> headers,
 String subjectToken,
 String subjectTokenType,
 String actorToken,
 String actorTokenType,
 String scope,
 String oauth2ServerUri)

Deprecated.

since 1.10.0, will be removed in 1.11.0; use exchangeToken(RESTClient, Map, String, String, String, String, String, String, Map) instead.

fetchToken

public static OAuthTokenResponse fetchToken(RESTClient client,
 Map<String,String> headers,
 String credential,
 String scope,
 String oauth2ServerUri,
 Map<String,String> optionalParams)

fetchToken

@Deprecated
public static OAuthTokenResponse fetchToken(RESTClient client,
 Map<String,String> headers,
 String credential,
 String scope)

Deprecated.

since 1.10.0, will be removed in 1.11.0; use fetchToken(RESTClient, Map, String, String, String, Map) instead.

fetchToken

@Deprecated
public static OAuthTokenResponse fetchToken(RESTClient client,
 Map<String,String> headers,
 String credential,
 String scope,
 String oauth2ServerUri)

Deprecated.

since 1.10.0, will be removed in 1.11.0; use fetchToken(RESTClient, Map, String, String, String, Map) instead.

tokenResponseToJson

public static String tokenResponseToJson(OAuthTokenResponse response)

tokenResponseToJson

public static void tokenResponseToJson(OAuthTokenResponse response,
 com.fasterxml.jackson.core.JsonGenerator gen)
                                throws IOException

Throws:

IOException

tokenResponseFromJson

public static OAuthTokenResponse tokenResponseFromJson(String json)

tokenResponseFromJson

public static OAuthTokenResponse tokenResponseFromJson(com.fasterxml.jackson.databind.JsonNode json)