/*
 * 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.Nullable;
import java.util.Optional;
import org.apache.polaris.immutables.PolarisImmutable;
import org.immutables.value.Value;

/** Authorization decision returned by authorizer implementations. */
@PolarisImmutable
public interface AuthorizationDecision {
  AuthorizationDecision ALLOW = ImmutableAuthorizationDecision.of(true, Optional.empty());

  static AuthorizationDecision allow() {
    return ALLOW;
  }

  static AuthorizationDecision deny(@Nullable String message) {
    return ImmutableAuthorizationDecision.of(false, Optional.ofNullable(message));
  }

  @Value.Parameter(order = 1)
  boolean isAllowed();

  @Value.Parameter(order = 2)
  Optional<String> getMessage();
}
