com.google.gerrit.server.permissions.ProjectPermission Maven / Gradle / Ivy
// Copyright (C) 2017 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 com.google.gerrit.common.data.Permission;
import java.util.Locale;
import java.util.Optional;
public enum ProjectPermission {
/**
* Can access at least one reference or change within the repository.
*
* Checking this permission instead of {@link #READ} may require filtering to hide specific
* references or changes, which can be expensive.
*/
ACCESS,
/**
* Can read all references in the repository.
*
*
This is a stronger form of {@link #ACCESS} where no filtering is required.
*/
READ(Permission.READ),
/**
* Can read all non-config references in the repository.
*
*
This is the same as {@code READ} but does not check if they user can see refs/meta/config.
* Therefore, callers should check {@code READ} before excluding config refs in a short-circuit.
*/
READ_NO_CONFIG,
/**
* Can create at least one reference in the project.
*
*
This project level permission only validates the user may create some type of reference
* within the project. The exact reference name must be checked at creation:
*
*
permissionBackend
* .user(user)
* .project(proj)
* .ref(ref)
* .check(RefPermission.CREATE);
*
*/
CREATE_REF,
/**
* Can create at least one change in the project.
*
* This project level permission only validates the user may create a change for some branch
* within the project. The exact reference name must be checked at creation:
*
*
permissionBackend
* .user(user)
* .project(proj)
* .ref(ref)
* .check(RefPermission.CREATE_CHANGE);
*
*/
CREATE_CHANGE,
/** Can run receive pack. */
RUN_RECEIVE_PACK,
/** Can run upload pack. */
RUN_UPLOAD_PACK;
private final String name;
ProjectPermission() {
name = null;
}
ProjectPermission(String name) {
this.name = name;
}
/** @return name used in {@code project.config} permissions. */
public Optional permissionName() {
return Optional.ofNullable(name);
}
public String describeForException() {
return toString().toLowerCase(Locale.US).replace('_', ' ');
}
}