ArtifactSelector.java

/*
 * Copyright © 2015 Cask Data, Inc.
 *
 * 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 co.cask.cdap.etl.common;

import co.cask.cdap.api.artifact.ArtifactId;
import co.cask.cdap.api.artifact.ArtifactScope;
import co.cask.cdap.api.artifact.ArtifactVersion;
import co.cask.cdap.api.plugin.PluginClass;
import co.cask.cdap.api.plugin.PluginSelector;
import com.google.common.base.Preconditions;

import java.util.Map;
import java.util.SortedMap;
import javax.annotation.Nullable;

/**
 * Selects which plugin to use based on optional artifact scope, name, and version fields.
 * Will select the first artifact that matches all non-null fields.
 *
 * @deprecated use the ArtifactSelector from cdap-etl-proto instead
 */
@Deprecated
public class ArtifactSelector extends PluginSelector {
  private final ArtifactScope scope;
  private final String name;
  private final ArtifactVersion version;
  private final String pluginType;
  private final String pluginName;
  private final String errMsg;

  public ArtifactSelector(String pluginType,
                          String pluginName,
                          @Nullable ArtifactScope scope,
                          @Nullable String name,
                          @Nullable ArtifactVersion version) {
    Preconditions.checkArgument(scope != null || name != null || version != null,
                                "Must specify an artifact scope, name, or version.");
    this.scope = scope;
    this.name = name;
    this.version = version;
    this.pluginType = pluginType;
    this.pluginName = pluginName;
    StringBuilder msg = new StringBuilder("Could not find an artifact that matches");
    if (scope != null) {
      msg.append(" scope ");
      msg.append(scope.name());
    }
    if (name != null) {
      msg.append(" name ");
      msg.append(name);
    }
    if (version != null) {
      msg.append(" version ");
      msg.append(version.getVersion());
    }
    msg.append(" for plugin of type ");
    msg.append(pluginType);
    msg.append(" and name ");
    msg.append(pluginName);
    errMsg = msg.toString();
  }

  @Override
  public Map.Entry<ArtifactId, PluginClass> select(SortedMap<ArtifactId, PluginClass> plugins) {
    if (plugins.isEmpty()) {
      throw new IllegalArgumentException(String.format("No plugins of type %s and name %s were found.",
                                                       pluginType, pluginName));
    }
    for (Map.Entry<ArtifactId, PluginClass> entry : plugins.entrySet()) {
      ArtifactId artifactId = entry.getKey();
      if ((scope == null || artifactId.getScope().equals(scope)) &&
        (name == null || artifactId.getName().equals(name)) &&
        (version == null || artifactId.getVersion().equals(version))) {
        return entry;
      }
    }

    throw new IllegalArgumentException(errMsg);
  }
}