org.apache.gravitino.client

Class GravitinoClientBase.Builder<T>

java.lang.Object

org.apache.gravitino.client.GravitinoClientBase.Builder<T>

Direct Known Subclasses:

GravitinoAdminClient.AdminClientBuilder, GravitinoClient.ClientBuilder

Enclosing class:

GravitinoClientBase

public abstract static class GravitinoClientBase.Builder<T>
extends java.lang.Object

Builder class for constructing a GravitinoClient.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.gravitino.client.AuthDataProvider	authDataProvider The authentication provider.
protected boolean	checkVersion The check version flag.
protected java.util.Map<java.lang.String,java.lang.String>	headers The request base header for the Gravitino API.
protected java.lang.String	uri The base URI for the Gravitino API.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Builder(java.lang.String uri) The constructor for the Builder class.

Method Summary

Modifier and Type	Method and Description
abstract T	build() Builds a new instance.
GravitinoClientBase.Builder<T>	withCustomTokenAuth(CustomTokenProvider dataProvider) Sets CustomTokenProvider for the Gravitino.
GravitinoClientBase.Builder<T>	withHeaders(java.util.Map<java.lang.String,java.lang.String> headers) Set base header for Gravitino Client.
GravitinoClientBase.Builder<T>	withKerberosAuth(KerberosTokenProvider dataProvider) Sets KerberosTokenProvider for the Gravitino.
GravitinoClientBase.Builder<T>	withOAuth(OAuth2TokenProvider dataProvider) Sets OAuth2TokenProvider for Gravitino.
GravitinoClientBase.Builder<T>	withSimpleAuth() Sets the simple mode authentication for Gravitino
GravitinoClientBase.Builder<T>	withSimpleAuth(java.lang.String userName) Sets the simple mode authentication for Gravitino with a specific username
GravitinoClientBase.Builder<T>	withVersionCheckDisabled() Optional, set a flag to verify the client is supported to connector the server

Methods inherited from class java.lang.Object

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

Field Detail

uri

protected java.lang.String uri

The base URI for the Gravitino API.

authDataProvider

protected org.apache.gravitino.client.AuthDataProvider authDataProvider

The authentication provider.

checkVersion

protected boolean checkVersion

The check version flag.

headers

protected java.util.Map<java.lang.String,java.lang.String> headers

The request base header for the Gravitino API.

Constructor Detail

Builder

protected Builder(java.lang.String uri)

The constructor for the Builder class.

Parameters:

uri - The base URI for the Gravitino API.

Method Detail

withSimpleAuth

public GravitinoClientBase.Builder<T> withSimpleAuth()

Sets the simple mode authentication for Gravitino

Returns:

This Builder instance for method chaining.

withSimpleAuth

public GravitinoClientBase.Builder<T> withSimpleAuth(java.lang.String userName)

Sets the simple mode authentication for Gravitino with a specific username

Parameters:

userName - The username of the user.

Returns:

This Builder instance for method chaining.

withVersionCheckDisabled

public GravitinoClientBase.Builder<T> withVersionCheckDisabled()

Optional, set a flag to verify the client is supported to connector the server

Returns:

This Builder instance for method chaining.

withOAuth

public GravitinoClientBase.Builder<T> withOAuth(OAuth2TokenProvider dataProvider)

Sets OAuth2TokenProvider for Gravitino.

Parameters:

dataProvider - The OAuth2TokenProvider used as the provider of authentication data for Gravitino Client.

Returns:

This Builder instance for method chaining.

withKerberosAuth

public GravitinoClientBase.Builder<T> withKerberosAuth(KerberosTokenProvider dataProvider)

Sets KerberosTokenProvider for the Gravitino.

Parameters:

dataProvider - The KerberosTokenProvider used as the provider of authentication data for Gravitino Client.

Returns:

This Builder instance for method chaining.

withCustomTokenAuth

public GravitinoClientBase.Builder<T> withCustomTokenAuth(CustomTokenProvider dataProvider)

Sets CustomTokenProvider for the Gravitino.

Parameters:

dataProvider - The CustomTokenProvider used as the provider of authentication data for Gravitino Client.

Returns:

This Builder instance for method chaining.

withHeaders

public GravitinoClientBase.Builder<T> withHeaders(java.util.Map<java.lang.String,java.lang.String> headers)

Set base header for Gravitino Client.

Parameters:

headers - the base header.

Returns:

This Builder instance for method chaining.

build

public abstract T build()

Builds a new instance. Subclasses should overwrite this method.

Returns:

A new instance of Gravitino Client.

Throws:

java.lang.IllegalArgumentException - If the base URI is null or empty.

java.lang.UnsupportedOperationException - If subclass has not implemented.