Package org.apache.polaris.service.it.env

Class PolarisClient

java.lang.Object

org.apache.polaris.service.it.env.PolarisClient

All Implemented Interfaces:

AutoCloseable

public final class PolarisClient
extends Object
implements AutoCloseable

This is a holder for the heavy-weight HTTP client for accessing Polaris APIs, and optionally, platform APIs (such as metrics or health endpoints).

This class provides methods for constructing light-weight API wrappers for Iceberg REST APis, Polaris Management APIs, and platform APIs that reuse the same shared HTTP client.

Method Summary

Modifier and Type	Method	Description
static com.fasterxml.jackson.databind.ObjectMapper	buildObjectMapper()	Utility method that creates an ObjectMapper sufficient for (de-)serializing client-side payloads for Iceberg REST and Polaris Management APIs.
CatalogApi	catalogApi(String authToken)
CatalogApi	catalogApiPlain()
void	cleanUp(String authToken)
void	close()
GenericTableApi	genericTableApi(String authToken)
ManagementApi	managementApi(String authToken)
String	newEntityName(String hint)	This method should be used by test code to make top-level entity names.
String	obtainToken(URI issuerUrl, String endpointPath, Map<String,String> requestBody)	Requests an access token from the authorization server denoted by the issuer URL and token endpoint path.
String	obtainToken(org.apache.polaris.core.admin.model.PrincipalWithCredentials credentials)	Requests an access token from the Polaris server for the given principal.
String	obtainToken(ClientCredentials credentials)	Requests an access token from the Polaris server for the given credentials.
String	obtainToken(ClientPrincipal principal)	Requests an access token from the Polaris server for the given principal.
boolean	ownedName(String name)
PlatformMetricsApi	platformMetricsApi()
static PolarisClient	polarisClient(PolarisApiEndpoints endpoints)	Builds a PolarisClient for the given PolarisApiEndpoints.
static PolarisClient	polarisClient(PolarisApiEndpoints endpoints, PlatformApiEndpoints platformEndpoints)	Builds a PolarisClient for the given PolarisApiEndpoints and PlatformApiEndpoints.
PolicyApi	policyApi(String authToken)

Methods inherited from class java.lang.Object

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

Method Details

polarisClient

public static PolarisClient polarisClient(PolarisApiEndpoints endpoints)

Builds a PolarisClient for the given PolarisApiEndpoints. The returned client cannot access platform endpoints; use polarisClient(PolarisApiEndpoints, PlatformApiEndpoints) if platform endpoints are required by the test.

polarisClient

public static PolarisClient polarisClient(PolarisApiEndpoints endpoints,
 PlatformApiEndpoints platformEndpoints)

Builds a PolarisClient for the given PolarisApiEndpoints and PlatformApiEndpoints. The returned client can access both Polaris APIs and platform endpoints (e.g. metrics or health endpoints).

buildObjectMapper

public static com.fasterxml.jackson.databind.ObjectMapper buildObjectMapper()

Utility method that creates an ObjectMapper sufficient for (de-)serializing client-side payloads for Iceberg REST and Polaris Management APIs.

It is recommended for PolarisServerManager implementations to use this ObjectMapper if the make custom clients.

newEntityName

public String newEntityName(String hint)

This method should be used by test code to make top-level entity names. The purpose of this method is two-fold:

Identify top-level entities for later clean-up by cleanUp(String).

Allow PolarisServerManagers to customize top-level entities per environment.

managementApi

public ManagementApi managementApi(String authToken)

catalogApi

public CatalogApi catalogApi(String authToken)

catalogApiPlain

public CatalogApi catalogApiPlain()

genericTableApi

public GenericTableApi genericTableApi(String authToken)

policyApi

public PolicyApi policyApi(String authToken)

platformMetricsApi

public PlatformMetricsApi platformMetricsApi()

obtainToken

public String obtainToken(org.apache.polaris.core.admin.model.PrincipalWithCredentials credentials)

Requests an access token from the Polaris server for the given principal.

obtainToken

public String obtainToken(ClientPrincipal principal)

Requests an access token from the Polaris server for the given principal.

obtainToken

public String obtainToken(ClientCredentials credentials)

Requests an access token from the Polaris server for the given credentials.

obtainToken

public String obtainToken(URI issuerUrl,
 String endpointPath,
 Map<String,String> requestBody)

Requests an access token from the authorization server denoted by the issuer URL and token endpoint path.

ownedName

public boolean ownedName(String name)

cleanUp

public void cleanUp(String authToken)

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception