com.github.nfalco79.jenkins.plugins.parametricrun.branch.NewBranchPermissionHelper Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of branch-properties Show documentation

Allow to define new parameters as environment variables not defined in the Jenkinsfile.

The newest version!

/*
 * Copyright 2018 Falco Nikolas
 * 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.github.nfalco79.jenkins.plugins.parametricrun.branch;

import com.github.nfalco79.jenkins.plugins.parametricrun.Messages;
import com.github.nfalco79.jenkins.plugins.parametricrun.ParameterActionPermissionHelper;

import edu.umd.cs.findbugs.annotations.NonNull;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import hudson.init.InitMilestone;
import hudson.init.Initializer;
import hudson.model.Job;
import hudson.security.Permission;
import hudson.security.PermissionScope;
import jenkins.model.Jenkins;

public final class NewBranchPermissionHelper {

    /**
     * Permission to trigger release builds.
     */
    public static final Permission BRANCH_PERMISSION = new Permission(ParameterActionPermissionHelper.PERMISSIONS, "NewBranch", Messages._ParameterBuildPermissionHelper_description(), Jenkins.ADMINISTER, PermissionScope.ITEM);

    public static boolean hasReleasePermission(@NonNull Job job) {
        return job.hasPermission(BRANCH_PERMISSION);
    }

    public static void checkReleasePermission(@NonNull Job job) {
        job.checkPermission(BRANCH_PERMISSION);
    }

    /**
     * Earlier initialisation of permission before job configuration are read so the permission can be found in the parent group
     */
    @SuppressFBWarnings(value = "RV_RETURN_VALUE_IGNORED_NO_SIDE_EFFECT", justification = "Needs to trigger initialisation")
    @Initializer(before = InitMilestone.JOB_LOADED)
    public static void init() {
        BRANCH_PERMISSION.getId();
    }

    private NewBranchPermissionHelper() {
    }

}