org.eclipse.aether.internal.impl.Utils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of maven-resolver-impl Show documentation
An implementation of the repository system.
The newest version!
/*
 * 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.eclipse.aether.internal.impl;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Map;

import org.eclipse.aether.RepositorySystemSession;
import org.eclipse.aether.artifact.Artifact;
import org.eclipse.aether.deployment.DeployRequest;
import org.eclipse.aether.impl.MetadataGenerator;
import org.eclipse.aether.impl.MetadataGeneratorFactory;
import org.eclipse.aether.impl.OfflineController;
import org.eclipse.aether.installation.InstallRequest;
import org.eclipse.aether.metadata.Metadata;
import org.eclipse.aether.repository.RemoteRepository;
import org.eclipse.aether.resolution.ResolutionErrorPolicy;
import org.eclipse.aether.resolution.ResolutionErrorPolicyRequest;
import org.eclipse.aether.spi.artifact.decorator.ArtifactDecorator;
import org.eclipse.aether.spi.artifact.decorator.ArtifactDecoratorFactory;
import org.eclipse.aether.spi.artifact.generator.ArtifactGenerator;
import org.eclipse.aether.spi.artifact.generator.ArtifactGeneratorFactory;
import org.eclipse.aether.transfer.RepositoryOfflineException;

/**
 * Internal utility methods.
 */
public final class Utils {
    private Utils() {}

    private static PrioritizedComponents sortArtifactDecoratorFactories(
            RepositorySystemSession session, Map factories) {
        return PrioritizedComponents.reuseOrCreate(
                session, ArtifactDecoratorFactory.class, factories, ArtifactDecoratorFactory::getPriority);
    }

    public static List getArtifactDecorators(
            RepositorySystemSession session, Map artifactDecoratorFactories) {
        PrioritizedComponents factories =
                sortArtifactDecoratorFactories(session, artifactDecoratorFactories);
        List decorators = new ArrayList<>();
        for (PrioritizedComponent factory : factories.getEnabled()) {
            ArtifactDecorator decorator = factory.getComponent().newInstance(session);
            if (decorator != null) {
                decorators.add(decorator);
            }
        }
        return decorators;
    }

    private static PrioritizedComponents sortArtifactGeneratorFactories(
            RepositorySystemSession session, Map factories) {
        return PrioritizedComponents.reuseOrCreate(
                session, ArtifactGeneratorFactory.class, factories, ArtifactGeneratorFactory::getPriority);
    }

    private static List doGetArtifactGenerators(
            RepositorySystemSession session, Map artifactFactories, Object request) {
        PrioritizedComponents factories =
                sortArtifactGeneratorFactories(session, artifactFactories);
        List generators = new ArrayList<>();
        for (PrioritizedComponent factory : factories.getEnabled()) {
            ArtifactGenerator generator;
            if (request instanceof InstallRequest) {
                generator = factory.getComponent().newInstance(session, (InstallRequest) request);
            } else if (request instanceof DeployRequest) {
                generator = factory.getComponent().newInstance(session, (DeployRequest) request);
            } else {
                throw new IllegalArgumentException("Unknown request");
            }
            if (generator != null) {
                generators.add(generator);
            }
        }
        return generators;
    }

    public static List getArtifactGenerators(
            RepositorySystemSession session,
            Map artifactFactories,
            InstallRequest request) {
        return doGetArtifactGenerators(session, artifactFactories, request);
    }

    public static List getArtifactGenerators(
            RepositorySystemSession session,
            Map artifactFactories,
            DeployRequest request) {
        return doGetArtifactGenerators(session, artifactFactories, request);
    }

    private static PrioritizedComponents sortMetadataGeneratorFactories(
            RepositorySystemSession session, Map factories) {
        return PrioritizedComponents.reuseOrCreate(
                session, MetadataGeneratorFactory.class, factories, MetadataGeneratorFactory::getPriority);
    }

    private static List doGetMetadataGenerators(
            RepositorySystemSession session, Map metadataFactories, Object request) {
        PrioritizedComponents factories =
                sortMetadataGeneratorFactories(session, metadataFactories);
        List generators = new ArrayList<>();
        for (PrioritizedComponent factory : factories.getEnabled()) {
            MetadataGenerator generator;
            if (request instanceof InstallRequest) {
                generator = factory.getComponent().newInstance(session, (InstallRequest) request);
            } else if (request instanceof DeployRequest) {
                generator = factory.getComponent().newInstance(session, (DeployRequest) request);
            } else {
                throw new IllegalArgumentException("Unknown request");
            }
            if (generator != null) {
                generators.add(generator);
            }
        }
        return generators;
    }

    public static List getMetadataGenerators(
            RepositorySystemSession session,
            Map metadataFactories,
            InstallRequest request) {
        return doGetMetadataGenerators(session, metadataFactories, request);
    }

    public static List getMetadataGenerators(
            RepositorySystemSession session,
            Map metadataFactories,
            DeployRequest request) {
        return doGetMetadataGenerators(session, metadataFactories, request);
    }

    public static List prepareMetadata(
            List generators, List artifacts) {
        List metadatas = new ArrayList<>();

        for (MetadataGenerator generator : generators) {
            metadatas.addAll(generator.prepare(artifacts));
        }

        return metadatas;
    }

    public static List finishMetadata(
            List generators, List artifacts) {
        List metadatas = new ArrayList<>();

        for (MetadataGenerator generator : generators) {
            metadatas.addAll(generator.finish(artifacts));
        }

        return metadatas;
    }

    public static  List combine(Collection first, Collection second) {
        List result = new ArrayList<>(first.size() + second.size());
        result.addAll(first);
        result.addAll(second);
        return result;
    }

    public static int getPolicy(RepositorySystemSession session, Artifact artifact, RemoteRepository repository) {
        ResolutionErrorPolicy rep = session.getResolutionErrorPolicy();
        if (rep == null) {
            return ResolutionErrorPolicy.CACHE_DISABLED;
        }
        return rep.getArtifactPolicy(session, new ResolutionErrorPolicyRequest<>(artifact, repository));
    }

    public static int getPolicy(RepositorySystemSession session, Metadata metadata, RemoteRepository repository) {
        ResolutionErrorPolicy rep = session.getResolutionErrorPolicy();
        if (rep == null) {
            return ResolutionErrorPolicy.CACHE_DISABLED;
        }
        return rep.getMetadataPolicy(session, new ResolutionErrorPolicyRequest<>(metadata, repository));
    }

    public static void appendClassLoader(StringBuilder buffer, Object component) {
        ClassLoader loader = component.getClass().getClassLoader();
        if (loader != null && !loader.equals(Utils.class.getClassLoader())) {
            buffer.append(" from ").append(loader);
        }
    }

    public static void checkOffline(
            RepositorySystemSession session, OfflineController offlineController, RemoteRepository repository)
            throws RepositoryOfflineException {
        if (session.isOffline()) {
            offlineController.checkOffline(session, repository);
        }
    }
}