java/com/google/gerrit/server/permissions/PermissionDeniedException.java

// Copyright (C) 2018 The Android Open Source Project
//
// Licensed 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 com.google.gerrit.server.permissions;

import static java.util.Objects.requireNonNull;

import com.google.gerrit.extensions.api.access.GerritPermission;
import com.google.gerrit.extensions.restapi.AuthException;
import java.util.Optional;

/**
 * This signals that some permission check failed. The message is short so it can print on a
 * single-line in the Git output.
 */
public class PermissionDeniedException extends AuthException {
  private static final long serialVersionUID = 1L;

  public static final String MESSAGE_PREFIX = "not permitted: ";

  private final GerritPermission permission;
  private final Optional<String> resource;

  public PermissionDeniedException(GerritPermission permission) {
    super(MESSAGE_PREFIX + requireNonNull(permission).describeForException());
    this.permission = permission;
    this.resource = Optional.empty();
  }

  public PermissionDeniedException(GerritPermission permission, String resource) {
    super(
        MESSAGE_PREFIX
            + requireNonNull(permission).describeForException()
            + " on "
            + requireNonNull(resource));
    this.permission = permission;
    this.resource = Optional.of(resource);
  }

  public String describePermission() {
    return permission.describeForException();
  }

  public Optional<String> getResource() {
    return resource;
  }
}