org.apache.gravitino.client

Class OAuth2TokenProvider

java.lang.Object

org.apache.gravitino.client.OAuth2TokenProvider

Direct Known Subclasses:

DefaultOAuth2TokenProvider

public abstract class OAuth2TokenProvider
extends java.lang.Object

OAuth2TokenProvider will request the access token from the authorization server and then provide the access token for every request.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OAuth2TokenProvider.OAuth2TokenProviderBuilder<SELF extends org.apache.gravitino.client.OAuth2TokenProvider.Builder<SELF,T>,T extends OAuth2TokenProvider> Builder interface for creating instances of OAuth2TokenProvider.

Field Summary

Fields

Modifier and Type	Field and Description
protected HTTPClient	client The HTTP client used to request the access token from the authorization server.

Constructor Summary

Constructors

Constructor and Description
OAuth2TokenProvider()

Method Summary

Modifier and Type	Method and Description
void	close() Closes the OAuth2TokenProvider and releases any underlying resources.
protected abstract java.lang.String	getAccessToken() Get the access token from the authorization server.
byte[]	getTokenData() Acquire the data of token for authentication.
boolean	hasTokenData() Judge whether AuthDataProvider can provide token data.

Methods inherited from class java.lang.Object

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

Field Detail

client

protected HTTPClient client

The HTTP client used to request the access token from the authorization server.

Constructor Detail

OAuth2TokenProvider

public OAuth2TokenProvider()

Method Detail

hasTokenData

public boolean hasTokenData()

Judge whether AuthDataProvider can provide token data.

Returns:

true if the AuthDataProvider can provide token data otherwise false.

getTokenData

public byte[] getTokenData()

Acquire the data of token for authentication. The client will set the token data as HTTP header Authorization directly. So the return value should ensure token data contain the token header (eg: Bearer, Basic) if necessary.

Returns:

the token data is used for authentication.

close

public void close()
           throws java.io.IOException

Closes the OAuth2TokenProvider and releases any underlying resources.

Throws:

java.io.IOException

getAccessToken

protected abstract java.lang.String getAccessToken()

Get the access token from the authorization server.

Returns:

The access token.