sungwy commented on code in PR #3760: URL: https://github.com/apache/polaris/pull/3760#discussion_r2819927001
########## polaris-core/src/main/java/org/apache/polaris/core/auth/AuthorizationRequest.java: ########## @@ -0,0 +1,98 @@ +/* + * 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.auth; + +import jakarta.annotation.Nonnull; +import jakarta.annotation.Nullable; +import java.util.List; +import org.apache.polaris.core.entity.PolarisEntityType; +import org.apache.polaris.immutables.PolarisImmutable; + +/** + * Authorization request inputs for pre-authorization and core authorization. + * + * <p>This wrapper keeps authorization inputs together and conveys the intent to be authorized via + * {@link PolarisSecurable} targets and secondaries. + */ +@PolarisImmutable +public interface AuthorizationRequest { + static AuthorizationRequest of( + @Nonnull PolarisPrincipal principal, + @Nonnull PolarisAuthorizableOperation operation, + @Nullable List<PolarisSecurable> targets, + @Nullable List<PolarisSecurable> secondaries) { + return ImmutableAuthorizationRequest.builder() + .principal(principal) + .operation(operation) + .targets(targets) + .secondaries(secondaries) + .build(); + } + + /** Returns the principal requesting authorization. */ + @Nonnull + PolarisPrincipal getPrincipal(); + + /** Returns the operation being authorized. */ + @Nonnull + PolarisAuthorizableOperation getOperation(); + + /** Returns the primary target securables, if any. */ + @Nullable + List<PolarisSecurable> getTargets(); + + /** Returns the secondary securables, if any. */ + @Nullable + List<PolarisSecurable> getSecondaries(); Review Comment: I found this very confusing as well... I agree this is a good place for the Java doc to explain the difference between the two. Let me add it -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
