/*
 * 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.extension.auth.opa.model;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.databind.PropertyNamingStrategies;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.annotation.JsonNaming;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import java.util.List;
import org.apache.polaris.immutables.PolarisImmutable;

/**
 * Represents the resource(s) being accessed in an authorization request.
 *
 * <p>Contains primary target entities and optional secondary entities.
 */
@PolarisImmutable
@JsonSerialize(as = ImmutableResource.class)
@JsonDeserialize(as = ImmutableResource.class)
@JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)
public interface Resource {
  /** The primary target entities being accessed. */
  @JsonInclude(JsonInclude.Include.NON_EMPTY)
  List<ResourceEntity> targets();

  /** Secondary entities involved in the operation (e.g., source table in RENAME). */
  @JsonInclude(JsonInclude.Include.NON_EMPTY)
  List<ResourceEntity> secondaries();
}
