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("enhanced")
45  public class EnhancedLocalRepositoryManagerFactory implements LocalRepositoryManagerFactory, Service {
46      private static final String CONFIG_PROP_TRACKING_FILENAME = "aether.enhancedLocalRepository.trackingFilename";
47  
48      private static final String DEFAULT_TRACKING_FILENAME = "_remote.repositories";
49  
50      private float priority = 10.0f;
51  
52      private LocalPathComposer localPathComposer;
53  
54      private TrackingFileManager trackingFileManager;
55  
56      private LocalPathPrefixComposerFactory localPathPrefixComposerFactory;
57  
58      @Deprecated
59      public EnhancedLocalRepositoryManagerFactory() {
60          // no arg ctor for ServiceLocator
61      }
62  
63      @Inject
64      public EnhancedLocalRepositoryManagerFactory(
65              final LocalPathComposer localPathComposer,
66              final TrackingFileManager trackingFileManager,
67              final LocalPathPrefixComposerFactory localPathPrefixComposerFactory) {
68          this.localPathComposer = requireNonNull(localPathComposer);
69          this.trackingFileManager = requireNonNull(trackingFileManager);
70          this.localPathPrefixComposerFactory = requireNonNull(localPathPrefixComposerFactory);
71      }
72  
73      @Override
74      public void initService(final ServiceLocator locator) {
75          this.localPathComposer = requireNonNull(locator.getService(LocalPathComposer.class));
76          this.trackingFileManager = requireNonNull(locator.getService(TrackingFileManager.class));
77          this.localPathPrefixComposerFactory = new DefaultLocalPathPrefixComposerFactory();
78      }
79  
80      @Override
81      public LocalRepositoryManager newInstance(RepositorySystemSession session, LocalRepository repository)
82              throws NoLocalRepositoryManagerException {
83          requireNonNull(session, "session cannot be null");
84          requireNonNull(repository, "repository cannot be null");
85  
86          String trackingFilename = ConfigUtils.getString(session, "", CONFIG_PROP_TRACKING_FILENAME);
87          if (trackingFilename.isEmpty()
88                  || trackingFilename.contains("/")
89                  || trackingFilename.contains("\\")
90                  || trackingFilename.contains("..")) {
91              trackingFilename = DEFAULT_TRACKING_FILENAME;
92          }
93  
94          if ("".equals(repository.getContentType()) || "default".equals(repository.getContentType())) {
95              return new EnhancedLocalRepositoryManager(
96                      repository.getBasedir(),
97                      localPathComposer,
98                      trackingFilename,
99                      trackingFileManager,
100                     localPathPrefixComposerFactory.createComposer(session));
101         } else {
102             throw new NoLocalRepositoryManagerException(repository);
103         }
104     }
105 
106     @Override
107     public float getPriority() {
108         return priority;
109     }
110 
111     /**
112      * Sets the priority of this component.
113      *
114      * @param priority The priority.
115      * @return This component for chaining, never {@code null}.
116      */
117     public EnhancedLocalRepositoryManagerFactory setPriority(float priority) {
118         this.priority = priority;
119         return this;
120     }
121 }