Skip to content

Commit

Permalink
Add base persistence APIs for Policy Mapping
Browse files Browse the repository at this point in the history
  • Loading branch information
HonahX committed Mar 3, 2025
1 parent 2e6aef1 commit 6a0ee78
Show file tree
Hide file tree
Showing 10 changed files with 801 additions and 217 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@
import org.apache.polaris.core.persistence.BaseMetaStoreManager;
import org.apache.polaris.core.persistence.PrincipalSecretsGenerator;
import org.apache.polaris.core.persistence.RetryOnConcurrencyException;
import org.apache.polaris.core.policy.PolarisPolicyMappingRecord;
import org.apache.polaris.core.persistence.transactional.AbstractTransactionalPersistence;
import org.apache.polaris.core.storage.PolarisStorageConfigurationInfo;
import org.apache.polaris.core.storage.PolarisStorageIntegration;
Expand All @@ -60,6 +61,7 @@
import org.apache.polaris.jpa.models.ModelEntityActive;
import org.apache.polaris.jpa.models.ModelEntityChangeTracking;
import org.apache.polaris.jpa.models.ModelGrantRecord;
import org.apache.polaris.jpa.models.ModelPolicyMappingRecord;
import org.apache.polaris.jpa.models.ModelPrincipalSecrets;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
Expand Down Expand Up @@ -529,6 +531,90 @@ public int lookupEntityGrantRecordsVersion(
.toList();
}

/** {@inheritDoc} */
@Override
public void writeToPolicyMappingRecords(
@Nonnull PolarisCallContext callCtx, @Nonnull PolarisPolicyMappingRecord record) {

this.store.writeToPolicyMappingRecords(localSession.get(), record);
}

/** {@inheritDoc} */
@Override
public void deleteFromPolicyMappingRecords(
@Nonnull PolarisCallContext callCtx, @Nonnull PolarisPolicyMappingRecord record) {
this.store.deleteFromPolicyMappingRecords(localSession.get(), record);
}

/** {@inheritDoc} */
@Override
public void deleteAllEntityPolicyMappingRecords(
@Nonnull PolarisCallContext callCtx,
@Nonnull PolarisEntityCore entity,
@Nonnull List<PolarisPolicyMappingRecord> mappingOnTarget,
@Nonnull List<PolarisPolicyMappingRecord> mappingOnPolicy) {
this.store.deleteAllEntityPolicyMappingRecords(localSession.get(), entity);
}

/** {@inheritDoc} */
@Nullable
@Override
public PolarisPolicyMappingRecord lookupPolicyMappingRecord(
@Nonnull PolarisCallContext callCtx,
long targetCatalogId,
long targetId,
int policyTypeCode,
long policyCatalogId,
long policyId) {
return ModelPolicyMappingRecord.toPolicyMappingRecord(
this.store.lookupPolicyMappingRecord(
localSession.get(),
targetCatalogId,
targetId,
policyTypeCode,
policyCatalogId,
policyId));
}

/** {@inheritDoc} */
@Nonnull
@Override
public List<PolarisPolicyMappingRecord> loadPoliciesOnTargetByType(
@Nonnull PolarisCallContext callCtx,
long targetCatalogId,
long targetId,
int policyTypeCode) {
return this.store
.loadPoliciesOnTargetByType(localSession.get(), targetCatalogId, targetId, policyTypeCode)
.stream()
.map(ModelPolicyMappingRecord::toPolicyMappingRecord)
.toList();
}

/** {@inheritDoc} */
@Nonnull
@Override
public List<PolarisPolicyMappingRecord> loadAllPoliciesOnTarget(
@Nonnull PolarisCallContext callCtx, long targetCatalogId, long targetId) {
return this.store
.loadAllPoliciesOnTarget(localSession.get(), targetCatalogId, targetId)
.stream()
.map(ModelPolicyMappingRecord::toPolicyMappingRecord)
.toList();
}

/** {@inheritDoc} */
@Nonnull
@Override
public List<PolarisPolicyMappingRecord> loadAllPoliciesOnPolicy(
@Nonnull PolarisCallContext callCtx, long policyCatalogId, long policyId) {
return this.store
.loadAllPoliciesOnPolicy(localSession.get(), policyCatalogId, policyId)
.stream()
.map(ModelPolicyMappingRecord::toPolicyMappingRecord)
.toList();
}

/** {@inheritDoc} */
@Override
public @Nullable PolarisPrincipalSecrets loadPrincipalSecrets(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,12 @@
import org.apache.polaris.core.entity.PolarisEntityType;
import org.apache.polaris.core.entity.PolarisGrantRecord;
import org.apache.polaris.core.entity.PolarisPrincipalSecrets;
import org.apache.polaris.core.policy.PolarisPolicyMappingRecord;
import org.apache.polaris.jpa.models.ModelEntity;
import org.apache.polaris.jpa.models.ModelEntityActive;
import org.apache.polaris.jpa.models.ModelEntityChangeTracking;
import org.apache.polaris.jpa.models.ModelGrantRecord;
import org.apache.polaris.jpa.models.ModelPolicyMappingRecord;
import org.apache.polaris.jpa.models.ModelPrincipalSecrets;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
Expand Down Expand Up @@ -411,6 +413,121 @@ void deletePrincipalSecrets(EntityManager session, String clientId) {
session.remove(modelPrincipalSecrets);
}

void writeToPolicyMappingRecords(
EntityManager session, PolarisPolicyMappingRecord mappingRecord) {
diagnosticServices.check(session != null, "session_is_null");
checkInitialized();

session.persist(ModelPolicyMappingRecord.fromPolicyMappingRecord(mappingRecord));
}

void deleteFromPolicyMappingRecords(
EntityManager session, PolarisPolicyMappingRecord mappingRecord) {
diagnosticServices.check(session != null, "session_is_null");
checkInitialized();

ModelPolicyMappingRecord lookupPolicyMappingRecord =
lookupPolicyMappingRecord(
session,
mappingRecord.getTargetCatalogId(),
mappingRecord.getTargetId(),
mappingRecord.getPolicyTypeCode(),
mappingRecord.getPolicyCatalogId(),
mappingRecord.getPolicyId());

diagnosticServices.check(lookupPolicyMappingRecord != null, "policy_mapping_record_not_found");
session.remove(lookupPolicyMappingRecord);
}

void deleteAllEntityPolicyMappingRecords(EntityManager session, PolarisEntityCore entity) {
diagnosticServices.check(session != null, "session_is_null");
checkInitialized();

loadAllPoliciesOnPolicy(session, entity.getCatalogId(), entity.getId())
.forEach(session::remove);
loadAllPoliciesOnTarget(session, entity.getCatalogId(), entity.getId())
.forEach(session::remove);
}

ModelPolicyMappingRecord lookupPolicyMappingRecord(
EntityManager session,
long targetCatalogId,
long targetId,
long policyTypeCode,
long policyCatalogId,
long policyId) {
diagnosticServices.check(session != null, "session_is_null");
checkInitialized();

return session
.createQuery(
"SELECT m from ModelPolicyMappingRecord m "
+ "where m.targetCatalogId=:targetCatalogId "
+ "and m.targetId=:targetId "
+ "and m.policyTypeCode=:policyTypeCode "
+ "and m.policyCatalogId=:policyCatalogId "
+ "and m.policyId=:policyId",
ModelPolicyMappingRecord.class)
.setParameter("targetCatalogId", targetCatalogId)
.setParameter("targetId", targetId)
.setParameter("policyTypeCode", policyTypeCode)
.setParameter("policyCatalogId", policyCatalogId)
.setParameter("policyId", policyId)
.getResultStream()
.findFirst()
.orElse(null);
}

List<ModelPolicyMappingRecord> loadPoliciesOnTargetByType(
EntityManager session, long targetCatalogId, long targetId, int policyTypeCode) {
diagnosticServices.check(session != null, "session_is_null");
checkInitialized();

return session
.createQuery(
"SELECT m from ModelPolicyMappingRecord m "
+ "where m.targetCatalogId=:targetCatalogId "
+ "and m.targetId=:targetId "
+ "and m.policyTypeCode=:policyTypeCode",
ModelPolicyMappingRecord.class)
.setParameter("targetCatalogId", targetCatalogId)
.setParameter("targetId", targetId)
.setParameter("policyTypeCode", policyTypeCode)
.getResultList();
}

List<ModelPolicyMappingRecord> loadAllPoliciesOnTarget(
EntityManager session, long targetCatalogId, long targetId) {
diagnosticServices.check(session != null, "session_is_null");
checkInitialized();

return session
.createQuery(
"SELECT m from ModelPolicyMappingRecord m "
+ " where m.targetCatalogId=:targetCatalogId "
+ "and m.targetId=:targetId",
ModelPolicyMappingRecord.class)
.setParameter("targetCatalogId", targetCatalogId)
.setParameter("targetId", targetId)
.getResultList();
}

List<ModelPolicyMappingRecord> loadAllPoliciesOnPolicy(
EntityManager session, long policyCatalogId, long policyId) {
diagnosticServices.check(session != null, "session_is_null");
checkInitialized();

return session
.createQuery(
"SELECT m from ModelPolicyMappingRecord m "
+ "where m.policyCatalogId=:policyCatalogId "
+ "and m.policyId=:policyId",
ModelPolicyMappingRecord.class)
.setParameter("policyCatalogId", policyCatalogId)
.setParameter("policyId", policyId)
.getResultList();
}

private void checkInitialized() {
diagnosticServices.check(this.initialized.get(), "store_not_initialized");
}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,153 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.polaris.jpa.models;

import jakarta.persistence.Entity;
import jakarta.persistence.Id;
import jakarta.persistence.Index;
import jakarta.persistence.Table;
import jakarta.persistence.Version;
import org.apache.polaris.core.policy.PolarisPolicyMappingRecord;

@Entity
@Table(
name = "POLICY_MAPPING_RECORDS",
indexes = {
@Index(
name = "POLICY_MAPPING_RECORDS_BY_POLICY_INDEX",
columnList = "policyCatalogId,policyId,targetCatalogId,targetId")
})
public class ModelPolicyMappingRecord {
// id of the catalog where target entity resides
@Id private long targetCatalogId;

// id of the target entity
@Id private long targetId;

// id associated to the policy type
@Id private int policyTypeCode;

// id of the catalog where the policy entity resides
@Id private long policyCatalogId;

// id of the policy
@Id private long policyId;

// additional parameters of the mapping
private String parameters;

// Used for Optimistic Locking to handle concurrent reads and updates
@Version private long version;

public long getTargetCatalogId() {
return targetCatalogId;
}

public long getTargetId() {
return targetId;
}

public int getPolicyTypeCode() {
return policyTypeCode;
}

public long getPolicyCatalogId() {
return policyCatalogId;
}

public long getPolicyId() {
return policyId;
}

public String getParameters() {
return parameters;
}

public static ModelPolicyMappingRecord.Builder builder() {
return new ModelPolicyMappingRecord.Builder();
}

public static final class Builder {
private final ModelPolicyMappingRecord policyMappingRecord;

private Builder() {
policyMappingRecord = new ModelPolicyMappingRecord();
}

public Builder targetCatalogId(long targetCatalogId) {
policyMappingRecord.targetCatalogId = targetCatalogId;
return this;
}

public Builder targetId(long targetId) {
policyMappingRecord.targetId = targetId;
return this;
}

public Builder policyTypeCode(int policyTypeCode) {
policyMappingRecord.policyTypeCode = policyTypeCode;
return this;
}

public Builder policyCatalogId(long policyCatalogId) {
policyMappingRecord.policyCatalogId = policyCatalogId;
return this;
}

public Builder policyId(long policyId) {
policyMappingRecord.policyId = policyId;
return this;
}

public Builder parameters(String parameters) {
policyMappingRecord.parameters = parameters;
return this;
}

public ModelPolicyMappingRecord build() {
return policyMappingRecord;
}
}

public static ModelPolicyMappingRecord fromPolicyMappingRecord(
PolarisPolicyMappingRecord record) {
if (record == null) return null;

return ModelPolicyMappingRecord.builder()
.targetCatalogId(record.getTargetCatalogId())
.targetId(record.getTargetId())
.policyTypeCode(record.getPolicyTypeCode())
.policyCatalogId(record.getPolicyCatalogId())
.policyId(record.getPolicyId())
.parameters(record.getParameters())
.build();
}

public static PolarisPolicyMappingRecord toPolicyMappingRecord(ModelPolicyMappingRecord model) {
if (model == null) return null;

return new PolarisPolicyMappingRecord(
model.getTargetCatalogId(),
model.getTargetId(),
model.getPolicyCatalogId(),
model.getPolicyId(),
model.getPolicyTypeCode(),
model.getParameters());
}
}
Loading

0 comments on commit 6a0ee78

Please sign in to comment.