io.cdap.cdap.internal.app.runtime.artifact.RemoteArtifactRepository Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of cdap-app-fabric Show documentation
There is a newer version: 6.10.1
/*
 * Copyright © 2021 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 io.cdap.cdap.internal.app.runtime.artifact;

import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Predicate;
import com.google.inject.Inject;
import io.cdap.cdap.api.artifact.ArtifactInfo;
import io.cdap.cdap.api.artifact.ArtifactRange;
import io.cdap.cdap.api.artifact.ArtifactSummary;
import io.cdap.cdap.api.artifact.CloseableClassLoader;
import io.cdap.cdap.api.plugin.PluginClass;
import io.cdap.cdap.api.plugin.PluginSelector;
import io.cdap.cdap.common.ArtifactNotFoundException;
import io.cdap.cdap.common.NotFoundException;
import io.cdap.cdap.common.conf.CConfiguration;
import io.cdap.cdap.common.id.Id;
import io.cdap.cdap.internal.app.runtime.ProgramRuntimeProviderLoader;
import io.cdap.cdap.internal.app.runtime.plugin.PluginNotExistsException;
import io.cdap.cdap.proto.artifact.ApplicationClassInfo;
import io.cdap.cdap.proto.artifact.ApplicationClassSummary;
import io.cdap.cdap.proto.artifact.ArtifactSortOrder;
import io.cdap.cdap.proto.id.ArtifactId;
import io.cdap.cdap.proto.id.NamespaceId;
import io.cdap.cdap.security.impersonation.EntityImpersonator;
import org.apache.twill.filesystem.Location;

import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.SortedMap;
import javax.annotation.Nullable;

/**
 * RemoteArtifactRepository provides a remote implementation of ArtifactRepository
 */
public class RemoteArtifactRepository implements ArtifactRepository {
  private final ArtifactRepositoryReader artifactRepositoryReader;
  private final ArtifactClassLoaderFactory artifactClassLoaderFactory;

  @VisibleForTesting
  @Inject
  public RemoteArtifactRepository(CConfiguration cConf, ArtifactRepositoryReader artifactRepositoryReader) {
    this.artifactRepositoryReader = artifactRepositoryReader;
    this.artifactClassLoaderFactory = new ArtifactClassLoaderFactory(cConf, new ProgramRuntimeProviderLoader(cConf));
  }

  @Override
  public CloseableClassLoader createArtifactClassLoader(ArtifactDescriptor artifactDescriptor,
                                                        EntityImpersonator entityImpersonator) throws IOException {
    Location location = getArtifactLocation(artifactDescriptor);
    return artifactClassLoaderFactory.createClassLoader(location, entityImpersonator);
  }

  @Override
  public void clear(NamespaceId namespace) throws Exception {
    throw new UnsupportedOperationException();
  }

  @Override
  public List getArtifactSummaries(NamespaceId namespace, boolean includeSystem) throws Exception {
    throw new UnsupportedOperationException();
  }

  @Override
  public List getArtifactSummaries(NamespaceId namespace, String name, int limit,
                                                    ArtifactSortOrder order) throws Exception {
    throw new UnsupportedOperationException();
  }

  @Override
  public List getArtifactSummaries(ArtifactRange range, int limit,
                                                    ArtifactSortOrder order) throws Exception {
    throw new UnsupportedOperationException();
  }

  @Override
  public List getApplicationClasses(NamespaceId namespace,
                                                             boolean includeSystem) throws IOException {
    throw new UnsupportedOperationException();
  }

  @Override
  public List getApplicationClasses(NamespaceId namespace, String className) throws IOException {
    throw new UnsupportedOperationException();
  }

  @Override
  public SortedMap>
  getPlugins(NamespaceId namespace,
             Id.Artifact artifactId) throws IOException, ArtifactNotFoundException {
    throw new UnsupportedOperationException();
  }

  @Override
  public SortedMap>
  getPlugins(NamespaceId namespace, Id.Artifact artifactId,
             String pluginType) throws IOException, ArtifactNotFoundException {
    throw new UnsupportedOperationException();
  }

  @Override
  public SortedMap
  getPlugins(NamespaceId namespace, Id.Artifact artifactId,
             String pluginType, String pluginName,
             Predicate pluginPredicate, int limit,
             ArtifactSortOrder order) throws IOException, PluginNotExistsException, ArtifactNotFoundException {
    throw new UnsupportedOperationException();
  }

  @Override
  public Map.Entry
  findPlugin(NamespaceId namespace, ArtifactRange artifactRange,
             String pluginType, String pluginName,
             PluginSelector selector) throws IOException, PluginNotExistsException, ArtifactNotFoundException {
    throw new UnsupportedOperationException();
  }

  @Override
  public ArtifactDetail addArtifact(Id.Artifact artifactId, File artifactFile) throws Exception {
    throw new UnsupportedOperationException();
  }

  @Override
  public ArtifactDetail addArtifact(Id.Artifact artifactId, File artifactFile,
                                    @Nullable Set parentArtifacts,
                                    @Nullable Set additionalPlugins) throws Exception {
    throw new UnsupportedOperationException();
  }

  @Override
  public ArtifactDetail addArtifact(Id.Artifact artifactId, File artifactFile,
                                    @Nullable Set parentArtifacts,
                                    @Nullable Set additionalPlugins,
                                    Map properties) throws Exception {
    throw new UnsupportedOperationException();
  }

  @Override
  public void writeArtifactProperties(Id.Artifact artifactId, Map properties) throws Exception {
    throw new UnsupportedOperationException();
  }

  @Override
  public void writeArtifactProperty(Id.Artifact artifactId, String key, String value) throws Exception {
    throw new UnsupportedOperationException();
  }

  @Override
  public void deleteArtifactProperty(Id.Artifact artifactId, String key) throws Exception {
    throw new UnsupportedOperationException();
  }

  @Override
  public void deleteArtifactProperties(Id.Artifact artifactId) throws Exception {
    throw new UnsupportedOperationException();
  }

  @Override
  public void addSystemArtifacts() throws Exception {
    throw new UnsupportedOperationException();
  }

  @Override
  public void deleteArtifact(Id.Artifact artifactId) throws Exception {
    throw new UnsupportedOperationException();
  }

  @Override
  public List getArtifactsInfo(NamespaceId namespace) throws Exception {
    throw new UnsupportedOperationException();
  }

  @Override
  public ArtifactDetail getArtifact(Id.Artifact artifactId) throws Exception {
    return artifactRepositoryReader.getArtifact(artifactId);
  }

  @Override
  public InputStream newInputStream(Id.Artifact artifactId) throws IOException, NotFoundException {
    return artifactRepositoryReader.newInputStream(artifactId);
  }

  @Override
  public List getArtifactDetails(ArtifactRange range, int limit,
                                                 ArtifactSortOrder order) throws Exception {
    return artifactRepositoryReader.getArtifactDetails(range, limit, order);
  }

  /**
   * Allow subclasses to modify artifact locations (e.g. {@link RemoteArtifactRepositoryWithLocalization}
   * to download and cache artifact locally, subsequently return a local location.
   */
  protected Location getArtifactLocation(ArtifactDescriptor descriptor) throws IOException {
    return descriptor.getLocation();
  }
}