solr/core/src/java/org/apache/solr/packagemanager/PackageRepository.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.solr.packagemanager;

import java.io.IOException;
import java.nio.file.Path;
import java.util.Map;

import org.apache.solr.common.SolrException;
import org.apache.solr.common.annotation.JsonProperty;

/**
 * Abstract class for a repository, holding {@link SolrPackage} items.
 */
public abstract class PackageRepository {

  @JsonProperty("name")
  public String name = null;

  @JsonProperty("url")
  public String repositoryURL = null;

  public abstract void refresh();

  /**
   * Returns a map of package name to {@link SolrPackage}s.
   */
  public abstract Map<String, SolrPackage> getPackages();

  public abstract SolrPackage getPackage(String packageName);

  public abstract boolean hasPackage(String packageName);

  /**
   * Provides a method to download an artifact from this repository.
   */
  public abstract Path download(String artifactName) throws SolrException, IOException; 

}