/*
    * 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.supplier;
  
  import java.util.function.Supplier;
  
  import org.eclipse.aether.RepositorySystem;
  import org.eclipse.aether.RepositorySystemSession.CloseableSession;
  import org.eclipse.aether.RepositorySystemSession.SessionBuilder;
  import org.eclipse.aether.artifact.ArtifactTypeRegistry;
  import org.eclipse.aether.artifact.DefaultArtifactType;
  import org.eclipse.aether.collection.DependencyGraphTransformer;
  import org.eclipse.aether.collection.DependencyManager;
  import org.eclipse.aether.collection.DependencySelector;
  import org.eclipse.aether.collection.DependencyTraverser;
  import org.eclipse.aether.resolution.ArtifactDescriptorPolicy;
  import org.eclipse.aether.util.artifact.DefaultArtifactTypeRegistry;
  import org.eclipse.aether.util.graph.manager.ClassicDependencyManager;
  import org.eclipse.aether.util.graph.selector.AndDependencySelector;
  import org.eclipse.aether.util.graph.selector.ExclusionDependencySelector;
  import org.eclipse.aether.util.graph.selector.OptionalDependencySelector;
  import org.eclipse.aether.util.graph.selector.ScopeDependencySelector;
  import org.eclipse.aether.util.graph.transformer.ChainedDependencyGraphTransformer;
  import org.eclipse.aether.util.graph.transformer.ConflictResolver;
  import org.eclipse.aether.util.graph.transformer.JavaDependencyContextRefiner;
  import org.eclipse.aether.util.graph.transformer.JavaScopeDeriver;
  import org.eclipse.aether.util.graph.transformer.JavaScopeSelector;
  import org.eclipse.aether.util.graph.transformer.NearestVersionSelector;
  import org.eclipse.aether.util.graph.transformer.SimpleOptionalitySelector;
  import org.eclipse.aether.util.graph.traverser.FatArtifactTraverser;
  import org.eclipse.aether.util.repository.SimpleArtifactDescriptorPolicy;
  
  import static java.util.Objects.requireNonNull;
  
  /**
   * A simple {@link Supplier} of {@link SessionBuilder} instances, that on each call supplies newly
   * constructed instance. To create session out of builder, use {@link SessionBuilder#build()}. For proper closing
   * of sessions, use {@link CloseableSession#close()} method on built instance(s).
   * <p>
   * Extend this class and override methods to customize, if needed.
   *
   * @since TBD
   */
  public class SessionBuilderSupplier implements Supplier<SessionBuilder> {
      protected final RepositorySystem repositorySystem;
  
      public SessionBuilderSupplier(RepositorySystem repositorySystem) {
          this.repositorySystem = requireNonNull(repositorySystem);
      }
  
      protected void configureSessionBuilder(SessionBuilder session) {
          session.setDependencyTraverser(getDependencyTraverser());
          session.setDependencyManager(getDependencyManager());
          session.setDependencySelector(getDependencySelector());
          session.setDependencyGraphTransformer(getDependencyGraphTransformer());
          session.setArtifactTypeRegistry(getArtifactTypeRegistry());
          session.setArtifactDescriptorPolicy(getArtifactDescriptorPolicy());
      }
  
      protected DependencyTraverser getDependencyTraverser() {
          return new FatArtifactTraverser();
      }
  
      protected DependencyManager getDependencyManager() {
          return new ClassicDependencyManager();
      }
  
      protected DependencySelector getDependencySelector() {
          return new AndDependencySelector(
                  new ScopeDependencySelector("test", "provided"),
                  new OptionalDependencySelector(),
                  new ExclusionDependencySelector());
      }
  
      protected DependencyGraphTransformer getDependencyGraphTransformer() {
          return new ChainedDependencyGraphTransformer(
                  new ConflictResolver(
                          new NearestVersionSelector(), new JavaScopeSelector(),
                          new SimpleOptionalitySelector(), new JavaScopeDeriver()),
                  new JavaDependencyContextRefiner());
      }
  
      protected ArtifactTypeRegistry getArtifactTypeRegistry() {
         DefaultArtifactTypeRegistry stereotypes = new DefaultArtifactTypeRegistry();
         stereotypes.add(new DefaultArtifactType("pom"));
         stereotypes.add(new DefaultArtifactType("maven-plugin", "jar", "", "java"));
         stereotypes.add(new DefaultArtifactType("jar", "jar", "", "java"));
         stereotypes.add(new DefaultArtifactType("ejb", "jar", "", "java"));
         stereotypes.add(new DefaultArtifactType("ejb-client", "jar", "client", "java"));
         stereotypes.add(new DefaultArtifactType("test-jar", "jar", "tests", "java"));
         stereotypes.add(new DefaultArtifactType("javadoc", "jar", "javadoc", "java"));
         stereotypes.add(new DefaultArtifactType("java-source", "jar", "sources", "java", false, false));
         stereotypes.add(new DefaultArtifactType("war", "war", "", "java", false, true));
         stereotypes.add(new DefaultArtifactType("ear", "ear", "", "java", false, true));
         stereotypes.add(new DefaultArtifactType("rar", "rar", "", "java", false, true));
         stereotypes.add(new DefaultArtifactType("par", "par", "", "java", false, true));
         return stereotypes;
     }
 
     protected ArtifactDescriptorPolicy getArtifactDescriptorPolicy() {
         return new SimpleArtifactDescriptorPolicy(true, true);
     }
 
     /**
      * Creates a new Maven-like repository system session by initializing the session with values typical for
      * Maven-based resolution. In more detail, this method configures settings relevant for the processing of dependency
      * graphs, most other settings remain at their generic default value. Use the various setters to further configure
      * the session with authentication, mirror, proxy and other information required for your environment. At least,
      * local repository manager needs to be configured to make session be able to create session instance.
      *
      * @return SessionBuilder configured with minimally required things for "Maven-based resolution". At least LRM must
      * be set on builder to make it able to create session instances.
      */
     @Override
     public SessionBuilder get() {
         SessionBuilder builder = repositorySystem.createSessionBuilder();
         configureSessionBuilder(builder);
         return builder;
     }
 }