Package org.apache.iceberg.rest.auth

Class OAuth2Util.AuthSession

java.lang.Object

org.apache.iceberg.rest.auth.OAuth2Util.AuthSession

All Implemented Interfaces:

AutoCloseable, AuthSession

Enclosing class:

OAuth2Util

public static class OAuth2Util.AuthSession
extends Object
implements AuthSession

Class to handle authorization headers and token refresh.

Field Summary

Fields inherited from interface org.apache.iceberg.rest.auth.AuthSession

EMPTY

Constructor Summary

Constructors

Constructor	Description
AuthSession(Map<String,String> headers, AuthConfig config)

Method Summary

Modifier and Type	Method	Description
HTTPRequest	authenticate(HTTPRequest request)	Authenticates the given request and returns a new request with the necessary authentication.
void	close()	Closes the session and releases any resources.
AuthConfig	config()
String	credential()
static OAuth2Util.AuthSession	empty()	A new OAuth2Util.AuthSession with empty headers.
Long	expiresAtMillis()
static OAuth2Util.AuthSession	fromAccessToken(RESTClient client, ScheduledExecutorService executor, String token, Long defaultExpiresAtMillis, OAuth2Util.AuthSession parent)
static OAuth2Util.AuthSession	fromCredential(RESTClient client, ScheduledExecutorService executor, String credential, OAuth2Util.AuthSession parent)
static OAuth2Util.AuthSession	fromTokenExchange(RESTClient client, ScheduledExecutorService executor, String token, String tokenType, OAuth2Util.AuthSession parent)
static OAuth2Util.AuthSession	fromTokenResponse(RESTClient client, ScheduledExecutorService executor, OAuthTokenResponse response, long startTimeMillis, OAuth2Util.AuthSession parent)
Map<String,String>	headers()
String	oauth2ServerUri()
Map<String,String>	optionalOAuthParams()
Pair<Integer,TimeUnit>	refresh(RESTClient client)	Attempt to refresh the session token using the token exchange flow.
String	scope()
void	stopRefreshing()
String	token()
String	tokenType()

Methods inherited from class java.lang.Object

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

Constructor Details

AuthSession

public AuthSession(Map<String,String> headers,
 AuthConfig config)

Method Details

authenticate

public HTTPRequest authenticate(HTTPRequest request)

Description copied from interface: AuthSession

Authenticates the given request and returns a new request with the necessary authentication.

Specified by:

authenticate in interface AuthSession

headers

public Map<String,String> headers()

token

public String token()

tokenType

public String tokenType()

expiresAtMillis

public Long expiresAtMillis()

scope

public String scope()

stopRefreshing

public void stopRefreshing()

close

public void close()

Description copied from interface: AuthSession

Closes the session and releases any resources. This method is called when the session is no longer needed. Note that since sessions may be cached, this method may not be called immediately after the session is no longer needed, but rather when the session is evicted from the cache, or the cache itself is closed.

Specified by:

close in interface AuthSession

Specified by:

close in interface AutoCloseable

credential

public String credential()

oauth2ServerUri

public String oauth2ServerUri()

optionalOAuthParams

public Map<String,String> optionalOAuthParams()

config

public AuthConfig config()

empty

public static OAuth2Util.AuthSession empty()

A new OAuth2Util.AuthSession with empty headers.

Returns:

A new OAuth2Util.AuthSession with empty headers.

refresh

public Pair<Integer,TimeUnit> refresh(RESTClient client)

Attempt to refresh the session token using the token exchange flow.

Parameters:

client - a RESTClient

Returns:

interval to wait before calling refresh again, or null if no refresh is needed

fromAccessToken

public static OAuth2Util.AuthSession fromAccessToken(RESTClient client,
 ScheduledExecutorService executor,
 String token,
 Long defaultExpiresAtMillis,
 OAuth2Util.AuthSession parent)

fromCredential

public static OAuth2Util.AuthSession fromCredential(RESTClient client,
 ScheduledExecutorService executor,
 String credential,
 OAuth2Util.AuthSession parent)

fromTokenResponse

public static OAuth2Util.AuthSession fromTokenResponse(RESTClient client,
 ScheduledExecutorService executor,
 OAuthTokenResponse response,
 long startTimeMillis,
 OAuth2Util.AuthSession parent)

fromTokenExchange

public static OAuth2Util.AuthSession fromTokenExchange(RESTClient client,
 ScheduledExecutorService executor,
 String token,
 String tokenType,
 OAuth2Util.AuthSession parent)