View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.eclipse.aether.internal.impl;
20  
21  import javax.inject.Inject;
22  import javax.inject.Named;
23  import javax.inject.Singleton;
24  
25  import org.eclipse.aether.ConfigurationProperties;
26  import org.eclipse.aether.RepositorySystemSession;
27  import org.eclipse.aether.repository.LocalRepository;
28  import org.eclipse.aether.repository.LocalRepositoryManager;
29  import org.eclipse.aether.repository.NoLocalRepositoryManagerException;
30  import org.eclipse.aether.spi.localrepo.LocalRepositoryManagerFactory;
31  import org.eclipse.aether.util.ConfigUtils;
32  
33  import static java.util.Objects.requireNonNull;
34  
35  /**
36   * Creates enhanced local repository managers for repository types {@code "default"} or {@code "" (automatic)}. Enhanced
37   * local repository manager is built upon the classical Maven 2.0 local repository structure but additionally keeps
38   * track of from what repositories a cached artifact was resolved. Resolution of locally cached artifacts will be
39   * rejected in case the current resolution request does not match the known source repositories of an artifact, thereby
40   * emulating physically separated artifact caches per remote repository.
41   */
42  @Singleton
43  @Named(EnhancedLocalRepositoryManagerFactory.NAME)
44  public class EnhancedLocalRepositoryManagerFactory implements LocalRepositoryManagerFactory {
45      public static final String NAME = "enhanced";
46  
47      static final String CONFIG_PROPS_PREFIX = ConfigurationProperties.PREFIX_LRM + NAME + ".";
48  
49      /**
50       * Filename of the file in which to track the remote repositories.
51       *
52       * @configurationSource {@link RepositorySystemSession#getConfigProperties()}
53       * @configurationType {@link java.lang.String}
54       * @configurationDefaultValue {@link #DEFAULT_TRACKING_FILENAME}
55       */
56      public static final String CONFIG_PROP_TRACKING_FILENAME = CONFIG_PROPS_PREFIX + "trackingFilename";
57  
58      public static final String DEFAULT_TRACKING_FILENAME = "_remote.repositories";
59  
60      private float priority = 10.0f;
61  
62      private final LocalPathComposer localPathComposer;
63  
64      private final TrackingFileManager trackingFileManager;
65  
66      private final LocalPathPrefixComposerFactory localPathPrefixComposerFactory;
67  
68      @Inject
69      public EnhancedLocalRepositoryManagerFactory(
70              final LocalPathComposer localPathComposer,
71              final TrackingFileManager trackingFileManager,
72              final LocalPathPrefixComposerFactory localPathPrefixComposerFactory) {
73          this.localPathComposer = requireNonNull(localPathComposer);
74          this.trackingFileManager = requireNonNull(trackingFileManager);
75          this.localPathPrefixComposerFactory = requireNonNull(localPathPrefixComposerFactory);
76      }
77  
78      @Override
79      public LocalRepositoryManager newInstance(RepositorySystemSession session, LocalRepository repository)
80              throws NoLocalRepositoryManagerException {
81          requireNonNull(session, "session cannot be null");
82          requireNonNull(repository, "repository cannot be null");
83  
84          String trackingFilename = ConfigUtils.getString(session, "", CONFIG_PROP_TRACKING_FILENAME);
85          if (trackingFilename.isEmpty()
86                  || trackingFilename.contains("/")
87                  || trackingFilename.contains("\\")
88                  || trackingFilename.contains("..")) {
89              trackingFilename = DEFAULT_TRACKING_FILENAME;
90          }
91  
92          if ("".equals(repository.getContentType()) || "default".equals(repository.getContentType())) {
93              return new EnhancedLocalRepositoryManager(
94                      repository.getBasePath(),
95                      localPathComposer,
96                      trackingFilename,
97                      trackingFileManager,
98                      localPathPrefixComposerFactory.createComposer(session));
99          } else {
100             throw new NoLocalRepositoryManagerException(repository);
101         }
102     }
103 
104     @Override
105     public float getPriority() {
106         return priority;
107     }
108 
109     /**
110      * Sets the priority of this component.
111      *
112      * @param priority The priority.
113      * @return This component for chaining, never {@code null}.
114      */
115     public EnhancedLocalRepositoryManagerFactory setPriority(float priority) {
116         this.priority = priority;
117         return this;
118     }
119 }