org.apache.gravitino.client

Class CustomTokenProvider

java.lang.Object

org.apache.gravitino.client.CustomTokenProvider

public abstract class CustomTokenProvider
extends java.lang.Object

CustomTokenProvider will provide a custom access token for every request.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	CustomTokenProvider.Builder<SELF extends CustomTokenProvider.Builder<SELF,T>,T extends CustomTokenProvider> Builder interface for configuring and creating instances of CustomTokenProvider.
static class	CustomTokenProvider.CustomTokenProviderBuilder<SELF extends CustomTokenProvider.Builder<SELF,T>,T extends CustomTokenProvider> Builder class for configuring and creating instances of CustomTokenProvider.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	schemeName The name of authentication scheme.

Constructor Summary

Constructors

Constructor and Description
CustomTokenProvider()

Method Summary

Modifier and Type	Method and Description
void	close()
protected abstract java.lang.String	getCustomTokenInfo() Gets the custom token information.
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

schemeName

protected java.lang.String schemeName

The name of authentication scheme.

Constructor Detail

CustomTokenProvider

public CustomTokenProvider()

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

Throws:

java.io.IOException

getCustomTokenInfo

protected abstract java.lang.String getCustomTokenInfo()

Gets the custom token information.

Returns:

The custom token information.