PluginWhitelist.java

/*
 * Copyright 2013 Google Inc. All Rights Reserved.
 *
 * 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.jenkins.plugins.dsl.restrict;

import java.util.List;

import org.kohsuke.stapler.DataBoundConstructor;

import static com.google.common.base.Preconditions.checkNotNull;

import hudson.Extension;
import hudson.PluginWrapper;
import hudson.model.Descriptor;

/** Simple whitelist */
public class PluginWhitelist extends AbstractPluginRestriction {
  @DataBoundConstructor
  public PluginWhitelist(List<String> whitelist) {
    this.plugins = checkNotNull(whitelist);
  }

  public List<String> getWhitelist() {
    return plugins;
  }
  private final List<String> plugins;

  /** {@inheritDoc} */
  @Override
  protected boolean isPluginAllowed(PluginWrapper plugin) {
    return getWhitelist().contains(plugin.getShortName());
  }

  /** Boilerplate extension code */
  @Extension
  public static class DescriptorImpl extends Descriptor<AbstractRestriction> {
    /** {@inheritDoc} */
    @Override
    public String getDisplayName() {
      return Messages.PluginWhitelist_DisplayName();
    }
  }
}