Skip to content

Commit

Permalink
Move more inner classes to top-level classes (#1106)
Browse files Browse the repository at this point in the history
Co-authored-by: Yufei Gu <yufei.apache.org>
  • Loading branch information
flyrain authored Mar 11, 2025
1 parent 10ee64d commit 818cd00
Show file tree
Hide file tree
Showing 26 changed files with 431 additions and 301 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -18,20 +18,15 @@
*/
package org.apache.polaris.core.auth;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonProperty;
import jakarta.annotation.Nonnull;
import jakarta.annotation.Nullable;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;
import org.apache.polaris.core.PolarisCallContext;
import org.apache.polaris.core.entity.PolarisBaseEntity;
import org.apache.polaris.core.entity.PolarisEntityCore;
import org.apache.polaris.core.entity.PolarisGrantRecord;
import org.apache.polaris.core.entity.PolarisPrivilege;
import org.apache.polaris.core.persistence.dao.entity.BaseResult;
import org.apache.polaris.core.persistence.dao.entity.LoadGrantsResult;
import org.apache.polaris.core.persistence.dao.entity.PrivilegeResult;

/** Manage grants for Polaris entities. */
public interface PolarisGrantManager {
Expand Down Expand Up @@ -170,136 +165,4 @@ default LoadGrantsResult loadGrantsToGrantee(
@Nonnull
LoadGrantsResult loadGrantsToGrantee(
PolarisCallContext callCtx, long granteeCatalogId, long granteeId);

/** Result of a grant/revoke privilege call */
class PrivilegeResult extends BaseResult {

// null if not success.
private final PolarisGrantRecord grantRecord;

/**
* Constructor for an error
*
* @param errorCode error code, cannot be SUCCESS
* @param extraInformation extra information
*/
public PrivilegeResult(
@Nonnull BaseResult.ReturnStatus errorCode, @Nullable String extraInformation) {
super(errorCode, extraInformation);
this.grantRecord = null;
}

/**
* Constructor for success
*
* @param grantRecord grant record being granted or revoked
*/
public PrivilegeResult(@Nonnull PolarisGrantRecord grantRecord) {
super(BaseResult.ReturnStatus.SUCCESS);
this.grantRecord = grantRecord;
}

@JsonCreator
private PrivilegeResult(
@JsonProperty("returnStatus") @Nonnull BaseResult.ReturnStatus returnStatus,
@JsonProperty("extraInformation") String extraInformation,
@JsonProperty("grantRecord") PolarisGrantRecord grantRecord) {
super(returnStatus, extraInformation);
this.grantRecord = grantRecord;
}

public PolarisGrantRecord getGrantRecord() {
return grantRecord;
}
}

/** Result of a load grants call */
class LoadGrantsResult extends BaseResult {
// true if success. If false, the caller should retry because of some concurrent change
private final int grantsVersion;

// null if not success. Else set of grants records on a securable or to a grantee
private final List<PolarisGrantRecord> grantRecords;

// null if not success. Else, for each grant record, list of securable or grantee entities
private final List<PolarisBaseEntity> entities;

/**
* Constructor for an error
*
* @param errorCode error code, cannot be SUCCESS
* @param extraInformation extra information
*/
public LoadGrantsResult(
@Nonnull BaseResult.ReturnStatus errorCode, @Nullable String extraInformation) {
super(errorCode, extraInformation);
this.grantsVersion = 0;
this.grantRecords = null;
this.entities = null;
}

/**
* Constructor for success
*
* @param grantsVersion version of the grants
* @param grantRecords set of grant records
*/
public LoadGrantsResult(
int grantsVersion,
@Nonnull List<PolarisGrantRecord> grantRecords,
List<PolarisBaseEntity> entities) {
super(BaseResult.ReturnStatus.SUCCESS);
this.grantsVersion = grantsVersion;
this.grantRecords = grantRecords;
this.entities = entities;
}

@JsonCreator
private LoadGrantsResult(
@JsonProperty("returnStatus") @Nonnull BaseResult.ReturnStatus returnStatus,
@JsonProperty("extraInformation") String extraInformation,
@JsonProperty("grantsVersion") int grantsVersion,
@JsonProperty("grantRecords") List<PolarisGrantRecord> grantRecords,
@JsonProperty("entities") List<PolarisBaseEntity> entities) {
super(returnStatus, extraInformation);
this.grantsVersion = grantsVersion;
this.grantRecords = grantRecords;
// old GS code might not serialize this argument
this.entities = entities;
}

public int getGrantsVersion() {
return grantsVersion;
}

public List<PolarisGrantRecord> getGrantRecords() {
return grantRecords;
}

public List<PolarisBaseEntity> getEntities() {
return entities;
}

@JsonIgnore
public Map<Long, PolarisBaseEntity> getEntitiesAsMap() {
return (this.getEntities() == null)
? null
: this.getEntities().stream()
.collect(Collectors.toMap(PolarisBaseEntity::getId, entity -> entity));
}

@Override
public String toString() {
return "LoadGrantsResult{"
+ "grantsVersion="
+ grantsVersion
+ ", grantRecords="
+ grantRecords
+ ", entities="
+ entities
+ ", returnStatus="
+ getReturnStatus()
+ '}';
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,9 @@
*/
package org.apache.polaris.core.auth;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import jakarta.annotation.Nonnull;
import jakarta.annotation.Nullable;
import org.apache.polaris.core.PolarisCallContext;
import org.apache.polaris.core.entity.PolarisPrincipalSecrets;
import org.apache.polaris.core.persistence.dao.entity.BaseResult;
import org.apache.polaris.core.persistence.dao.entity.PrincipalSecretsResult;

/** Manages secrets for Polaris principals. */
public interface PolarisSecretsManager {
Expand Down Expand Up @@ -58,46 +54,4 @@ PrincipalSecretsResult rotatePrincipalSecrets(
long principalId,
boolean reset,
@Nonnull String oldSecretHash);

/** the result of load/rotate principal secrets */
class PrincipalSecretsResult extends BaseResult {

// principal client identifier and associated secrets. Null if error
private final PolarisPrincipalSecrets principalSecrets;

/**
* Constructor for an error
*
* @param errorCode error code, cannot be SUCCESS
* @param extraInformation extra information
*/
public PrincipalSecretsResult(
@Nonnull BaseResult.ReturnStatus errorCode, @Nullable String extraInformation) {
super(errorCode, extraInformation);
this.principalSecrets = null;
}

/**
* Constructor for success
*
* @param principalSecrets and associated secret information
*/
public PrincipalSecretsResult(@Nonnull PolarisPrincipalSecrets principalSecrets) {
super(BaseResult.ReturnStatus.SUCCESS);
this.principalSecrets = principalSecrets;
}

@JsonCreator
private PrincipalSecretsResult(
@JsonProperty("returnStatus") @Nonnull BaseResult.ReturnStatus returnStatus,
@JsonProperty("extraInformation") @Nullable String extraInformation,
@JsonProperty("principalSecrets") @Nonnull PolarisPrincipalSecrets principalSecrets) {
super(returnStatus, extraInformation);
this.principalSecrets = principalSecrets;
}

public PolarisPrincipalSecrets getPrincipalSecrets() {
return principalSecrets;
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,12 @@
import org.apache.polaris.core.persistence.dao.entity.EntityResult;
import org.apache.polaris.core.persistence.dao.entity.EntityWithPath;
import org.apache.polaris.core.persistence.dao.entity.ListEntitiesResult;
import org.apache.polaris.core.persistence.dao.entity.LoadGrantsResult;
import org.apache.polaris.core.persistence.dao.entity.PrincipalSecretsResult;
import org.apache.polaris.core.persistence.dao.entity.PrivilegeResult;
import org.apache.polaris.core.persistence.dao.entity.ResolvedEntityResult;
import org.apache.polaris.core.persistence.dao.entity.ScopedCredentialsResult;
import org.apache.polaris.core.persistence.dao.entity.ValidateAccessResult;
import org.apache.polaris.core.storage.PolarisCredentialProperty;
import org.apache.polaris.core.storage.PolarisStorageActions;
import org.apache.polaris.core.storage.PolarisStorageConfigurationInfo;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
import org.apache.polaris.core.PolarisCallContext;
import org.apache.polaris.core.PolarisDefaultDiagServiceImpl;
import org.apache.polaris.core.PolarisDiagnostics;
import org.apache.polaris.core.auth.PolarisSecretsManager.PrincipalSecretsResult;
import org.apache.polaris.core.context.CallContext;
import org.apache.polaris.core.context.RealmContext;
import org.apache.polaris.core.entity.PolarisEntity;
Expand All @@ -38,6 +37,7 @@
import org.apache.polaris.core.persistence.cache.EntityCache;
import org.apache.polaris.core.persistence.dao.entity.BaseResult;
import org.apache.polaris.core.persistence.dao.entity.EntityResult;
import org.apache.polaris.core.persistence.dao.entity.PrincipalSecretsResult;
import org.apache.polaris.core.persistence.transactional.PolarisMetaStoreManagerImpl;
import org.apache.polaris.core.persistence.transactional.TransactionalPersistence;
import org.apache.polaris.core.storage.cache.StorageCredentialCache;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@

import java.util.Map;
import java.util.function.Supplier;
import org.apache.polaris.core.auth.PolarisSecretsManager.PrincipalSecretsResult;
import org.apache.polaris.core.context.RealmContext;
import org.apache.polaris.core.persistence.bootstrap.RootCredentialsSet;
import org.apache.polaris.core.persistence.cache.EntityCache;
import org.apache.polaris.core.persistence.dao.entity.BaseResult;
import org.apache.polaris.core.persistence.dao.entity.PrincipalSecretsResult;
import org.apache.polaris.core.persistence.transactional.TransactionalPersistence;
import org.apache.polaris.core.storage.cache.StorageCredentialCache;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,12 @@
import org.apache.polaris.core.persistence.dao.entity.EntityWithPath;
import org.apache.polaris.core.persistence.dao.entity.GenerateEntityIdResult;
import org.apache.polaris.core.persistence.dao.entity.ListEntitiesResult;
import org.apache.polaris.core.persistence.dao.entity.LoadGrantsResult;
import org.apache.polaris.core.persistence.dao.entity.PrincipalSecretsResult;
import org.apache.polaris.core.persistence.dao.entity.PrivilegeResult;
import org.apache.polaris.core.persistence.dao.entity.ResolvedEntityResult;
import org.apache.polaris.core.persistence.dao.entity.ScopedCredentialsResult;
import org.apache.polaris.core.persistence.dao.entity.ValidateAccessResult;
import org.apache.polaris.core.storage.PolarisStorageActions;

/**
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,119 @@
/*
* 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.core.persistence.dao.entity;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonProperty;
import jakarta.annotation.Nonnull;
import jakarta.annotation.Nullable;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;
import org.apache.polaris.core.entity.PolarisBaseEntity;
import org.apache.polaris.core.entity.PolarisGrantRecord;

/** Result of a load grants call */
public class LoadGrantsResult extends BaseResult {
// true if success. If false, the caller should retry because of some concurrent change
private final int grantsVersion;

// null if not success. Else set of grants records on a securable or to a grantee
private final List<PolarisGrantRecord> grantRecords;

// null if not success. Else, for each grant record, list of securable or grantee entities
private final List<PolarisBaseEntity> entities;

/**
* Constructor for an error
*
* @param errorCode error code, cannot be SUCCESS
* @param extraInformation extra information
*/
public LoadGrantsResult(@Nonnull ReturnStatus errorCode, @Nullable String extraInformation) {
super(errorCode, extraInformation);
this.grantsVersion = 0;
this.grantRecords = null;
this.entities = null;
}

/**
* Constructor for success
*
* @param grantsVersion version of the grants
* @param grantRecords set of grant records
*/
public LoadGrantsResult(
int grantsVersion,
@Nonnull List<PolarisGrantRecord> grantRecords,
List<PolarisBaseEntity> entities) {
super(ReturnStatus.SUCCESS);
this.grantsVersion = grantsVersion;
this.grantRecords = grantRecords;
this.entities = entities;
}

@JsonCreator
private LoadGrantsResult(
@JsonProperty("returnStatus") @Nonnull ReturnStatus returnStatus,
@JsonProperty("extraInformation") String extraInformation,
@JsonProperty("grantsVersion") int grantsVersion,
@JsonProperty("grantRecords") List<PolarisGrantRecord> grantRecords,
@JsonProperty("entities") List<PolarisBaseEntity> entities) {
super(returnStatus, extraInformation);
this.grantsVersion = grantsVersion;
this.grantRecords = grantRecords;
// old GS code might not serialize this argument
this.entities = entities;
}

public int getGrantsVersion() {
return grantsVersion;
}

public List<PolarisGrantRecord> getGrantRecords() {
return grantRecords;
}

public List<PolarisBaseEntity> getEntities() {
return entities;
}

@JsonIgnore
public Map<Long, PolarisBaseEntity> getEntitiesAsMap() {
return (this.getEntities() == null)
? null
: this.getEntities().stream()
.collect(Collectors.toMap(PolarisBaseEntity::getId, entity -> entity));
}

@Override
public String toString() {
return "LoadGrantsResult{"
+ "grantsVersion="
+ grantsVersion
+ ", grantRecords="
+ grantRecords
+ ", entities="
+ entities
+ ", returnStatus="
+ getReturnStatus()
+ '}';
}
}
Loading

0 comments on commit 818cd00

Please sign in to comment.