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.RepositorySystemSession;
26  import org.eclipse.aether.repository.LocalRepository;
27  import org.eclipse.aether.repository.LocalRepositoryManager;
28  import org.eclipse.aether.repository.NoLocalRepositoryManagerException;
29  import org.eclipse.aether.spi.localrepo.LocalRepositoryManagerFactory;
30  import org.eclipse.aether.spi.locator.Service;
31  import org.eclipse.aether.spi.locator.ServiceLocator;
32  import org.eclipse.aether.util.ConfigUtils;
33  
34  import static java.util.Objects.requireNonNull;
35  
36  /**
37   * Creates enhanced local repository managers for repository types {@code "default"} or {@code "" (automatic)}. Enhanced
38   * local repository manager is built upon the classical Maven 2.0 local repository structure but additionally keeps
39   * track of from what repositories a cached artifact was resolved. Resolution of locally cached artifacts will be
40   * rejected in case the current resolution request does not match the known source repositories of an artifact, thereby
41   * emulating physically separated artifact caches per remote repository.
42   */
43  @Singleton
44  @Named(EnhancedLocalRepositoryManagerFactory.NAME)
45  public class EnhancedLocalRepositoryManagerFactory implements LocalRepositoryManagerFactory, Service {
46      public static final String NAME = "enhanced";
47      private static final String CONFIG_PROP_TRACKING_FILENAME = "aether.enhancedLocalRepository.trackingFilename";
48  
49      private static final String DEFAULT_TRACKING_FILENAME = "_remote.repositories";
50  
51      private float priority = 10.0f;
52  
53      private LocalPathComposer localPathComposer;
54  
55      private TrackingFileManager trackingFileManager;
56  
57      private LocalPathPrefixComposerFactory localPathPrefixComposerFactory;
58  
59      @Deprecated
60      public EnhancedLocalRepositoryManagerFactory() {
61          // no arg ctor for ServiceLocator
62      }
63  
64      @Inject
65      public EnhancedLocalRepositoryManagerFactory(
66              final LocalPathComposer localPathComposer,
67              final TrackingFileManager trackingFileManager,
68              final LocalPathPrefixComposerFactory localPathPrefixComposerFactory) {
69          this.localPathComposer = requireNonNull(localPathComposer);
70          this.trackingFileManager = requireNonNull(trackingFileManager);
71          this.localPathPrefixComposerFactory = requireNonNull(localPathPrefixComposerFactory);
72      }
73  
74      @Override
75      public void initService(final ServiceLocator locator) {
76          this.localPathComposer = requireNonNull(locator.getService(LocalPathComposer.class));
77          this.trackingFileManager = requireNonNull(locator.getService(TrackingFileManager.class));
78          this.localPathPrefixComposerFactory = new DefaultLocalPathPrefixComposerFactory();
79      }
80  
81      @Override
82      public LocalRepositoryManager newInstance(RepositorySystemSession session, LocalRepository repository)
83              throws NoLocalRepositoryManagerException {
84          requireNonNull(session, "session cannot be null");
85          requireNonNull(repository, "repository cannot be null");
86  
87          String trackingFilename = ConfigUtils.getString(session, "", CONFIG_PROP_TRACKING_FILENAME);
88          if (trackingFilename.isEmpty()
89                  || trackingFilename.contains("/")
90                  || trackingFilename.contains("\\")
91                  || trackingFilename.contains("..")) {
92              trackingFilename = DEFAULT_TRACKING_FILENAME;
93          }
94  
95          if ("".equals(repository.getContentType()) || "default".equals(repository.getContentType())) {
96              return new EnhancedLocalRepositoryManager(
97                      repository.getBasedir(),
98                      localPathComposer,
99                      trackingFilename,
100                     trackingFileManager,
101                     localPathPrefixComposerFactory.createComposer(session));
102         } else {
103             throw new NoLocalRepositoryManagerException(repository);
104         }
105     }
106 
107     @Override
108     public float getPriority() {
109         return priority;
110     }
111 
112     /**
113      * Sets the priority of this component.
114      *
115      * @param priority The priority.
116      * @return This component for chaining, never {@code null}.
117      */
118     public EnhancedLocalRepositoryManagerFactory setPriority(float priority) {
119         this.priority = priority;
120         return this;
121     }
122 }