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

Class ManagementApi

java.lang.Object

org.apache.polaris.service.it.env.RestApi

org.apache.polaris.service.it.env.ManagementApi

public class ManagementApi
extends RestApi

A simple, non-exhaustive set of helper methods for accessing the Polaris Management API.

See Also:

• PolarisClient.managementApi(ClientCredentials)

Constructor Summary

Constructors

Constructor	Description
ManagementApi(jakarta.ws.rs.client.Client client, PolarisApiEndpoints endpoints, String authToken, URI uri)

Method Summary

Modifier and Type	Method	Description
void	addGrant(String catalogName, String catalogRoleName, org.apache.polaris.core.admin.model.GrantResource grant)
void	assignPrincipalRole(String principalName, String roleName)
void	createCatalog(String principalRoleName, org.apache.polaris.core.admin.model.Catalog catalog)
void	createCatalog(org.apache.polaris.core.admin.model.Catalog catalog)
void	createCatalogRole(String catalogName, String catalogRoleName)
org.apache.polaris.core.admin.model.PrincipalWithCredentials	createPrincipal(String name)
org.apache.polaris.core.admin.model.PrincipalWithCredentials	createPrincipal(org.apache.polaris.core.admin.model.CreatePrincipalRequest request)
void	createPrincipalRole(String name)
void	createPrincipalRole(org.apache.polaris.core.admin.model.PrincipalRole role)
org.apache.polaris.core.admin.model.PrincipalWithCredentials	createPrincipalWithRole(String principalName, String roleName)
void	deleteCatalog(String catalogName)
void	deleteCatalogRole(String catalogName, String roleName)
void	deleteCatalogRole(String catalogName, org.apache.polaris.core.admin.model.CatalogRole role)
void	deletePrincipal(String principalName)
void	deletePrincipal(org.apache.polaris.core.admin.model.Principal principal)
void	deletePrincipalRole(org.apache.polaris.core.admin.model.PrincipalRole role)
void	dropCatalog(String catalogName)
org.apache.polaris.core.admin.model.Catalog	getCatalog(String name)
org.apache.polaris.core.admin.model.CatalogRole	getCatalogRole(String catalogName, String roleName)
void	grantCatalogRoleToPrincipalRole(String principalRoleName, String catalogName, org.apache.polaris.core.admin.model.CatalogRole catalogRole)
List<org.apache.polaris.core.admin.model.CatalogRole>	listCatalogRoles(String catalogName)
List<org.apache.polaris.core.admin.model.Catalog>	listCatalogs()
org.apache.polaris.core.admin.model.GrantResources	listGrants(String catalogName, String catalogRoleName)
List<org.apache.polaris.core.admin.model.PrincipalRole>	listPrincipalRoles()
List<org.apache.polaris.core.admin.model.Principal>	listPrincipals()
void	revokeGrant(String catalogName, String catalogRoleName, org.apache.polaris.core.admin.model.GrantResource grant)
void	updateCatalog(org.apache.polaris.core.admin.model.Catalog catalog, Map<String,String> catalogProps)

Methods inherited from class org.apache.polaris.service.it.env.RestApi

defaultHeaders, request, request, request, request

Methods inherited from class java.lang.Object

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

Constructor Details

ManagementApi

public ManagementApi(jakarta.ws.rs.client.Client client,
 PolarisApiEndpoints endpoints,
 String authToken,
 URI uri)

Method Details

createPrincipalWithRole

public org.apache.polaris.core.admin.model.PrincipalWithCredentials createPrincipalWithRole(String principalName,
 String roleName)

createPrincipal

public org.apache.polaris.core.admin.model.PrincipalWithCredentials createPrincipal(String name)

createPrincipal

public org.apache.polaris.core.admin.model.PrincipalWithCredentials createPrincipal(org.apache.polaris.core.admin.model.CreatePrincipalRequest request)

createPrincipalRole

public void createPrincipalRole(String name)

createPrincipalRole

public void createPrincipalRole(org.apache.polaris.core.admin.model.PrincipalRole role)

assignPrincipalRole

public void assignPrincipalRole(String principalName,
 String roleName)

createCatalogRole

public void createCatalogRole(String catalogName,
 String catalogRoleName)

addGrant

public void addGrant(String catalogName,
 String catalogRoleName,
 org.apache.polaris.core.admin.model.GrantResource grant)

revokeGrant

public void revokeGrant(String catalogName,
 String catalogRoleName,
 org.apache.polaris.core.admin.model.GrantResource grant)

grantCatalogRoleToPrincipalRole

public void grantCatalogRoleToPrincipalRole(String principalRoleName,
 String catalogName,
 org.apache.polaris.core.admin.model.CatalogRole catalogRole)

listGrants

public org.apache.polaris.core.admin.model.GrantResources listGrants(String catalogName,
 String catalogRoleName)

createCatalog

public void createCatalog(String principalRoleName,
 org.apache.polaris.core.admin.model.Catalog catalog)

createCatalog

public void createCatalog(org.apache.polaris.core.admin.model.Catalog catalog)

getCatalog

public org.apache.polaris.core.admin.model.Catalog getCatalog(String name)

updateCatalog

public void updateCatalog(org.apache.polaris.core.admin.model.Catalog catalog,
 Map<String,String> catalogProps)

deleteCatalog

public void deleteCatalog(String catalogName)

getCatalogRole

public org.apache.polaris.core.admin.model.CatalogRole getCatalogRole(String catalogName,
 String roleName)

listCatalogRoles

public List<org.apache.polaris.core.admin.model.CatalogRole> listCatalogRoles(String catalogName)

listPrincipals

public List<org.apache.polaris.core.admin.model.Principal> listPrincipals()

listPrincipalRoles

public List<org.apache.polaris.core.admin.model.PrincipalRole> listPrincipalRoles()

listCatalogs

public List<org.apache.polaris.core.admin.model.Catalog> listCatalogs()

deleteCatalogRole

public void deleteCatalogRole(String catalogName,
 org.apache.polaris.core.admin.model.CatalogRole role)

deleteCatalogRole

public void deleteCatalogRole(String catalogName,
 String roleName)

deletePrincipal

public void deletePrincipal(org.apache.polaris.core.admin.model.Principal principal)

deletePrincipal

public void deletePrincipal(String principalName)

deletePrincipalRole

public void deletePrincipalRole(org.apache.polaris.core.admin.model.PrincipalRole role)

dropCatalog

public void dropCatalog(String catalogName)