001/* 002 * Licensed to the Apache Software Foundation (ASF) under one 003 * or more contributor license agreements. See the NOTICE file 004 * distributed with this work for additional information 005 * regarding copyright ownership. The ASF licenses this file 006 * to you under the Apache License, Version 2.0 (the 007 * "License"); you may not use this file except in compliance 008 * with the License. You may obtain a copy of the License at 009 * 010 * http://www.apache.org/licenses/LICENSE-2.0 011 * 012 * Unless required by applicable law or agreed to in writing, 013 * software distributed under the License is distributed on an 014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 015 * KIND, either express or implied. See the License for the 016 * specific language governing permissions and limitations 017 * under the License. 018 */ 019package org.eclipse.aether.internal.impl; 020 021import javax.inject.Inject; 022import javax.inject.Named; 023import javax.inject.Singleton; 024 025import org.eclipse.aether.RepositorySystemSession; 026import org.eclipse.aether.repository.LocalRepository; 027import org.eclipse.aether.repository.LocalRepositoryManager; 028import org.eclipse.aether.repository.NoLocalRepositoryManagerException; 029import org.eclipse.aether.spi.localrepo.LocalRepositoryManagerFactory; 030import org.eclipse.aether.spi.locator.Service; 031import org.eclipse.aether.spi.locator.ServiceLocator; 032import org.eclipse.aether.util.ConfigUtils; 033 034import static java.util.Objects.requireNonNull; 035 036/** 037 * Creates enhanced local repository managers for repository types {@code "default"} or {@code "" (automatic)}. Enhanced 038 * local repository manager is built upon the classical Maven 2.0 local repository structure but additionally keeps 039 * track of from what repositories a cached artifact was resolved. Resolution of locally cached artifacts will be 040 * rejected in case the current resolution request does not match the known source repositories of an artifact, thereby 041 * emulating physically separated artifact caches per remote repository. 042 */ 043@Singleton 044@Named("enhanced") 045public class EnhancedLocalRepositoryManagerFactory implements LocalRepositoryManagerFactory, Service { 046 private static final String CONFIG_PROP_TRACKING_FILENAME = "aether.enhancedLocalRepository.trackingFilename"; 047 048 private static final String DEFAULT_TRACKING_FILENAME = "_remote.repositories"; 049 050 private float priority = 10.0f; 051 052 private LocalPathComposer localPathComposer; 053 054 private TrackingFileManager trackingFileManager; 055 056 private LocalPathPrefixComposerFactory localPathPrefixComposerFactory; 057 058 @Deprecated 059 public EnhancedLocalRepositoryManagerFactory() { 060 // no arg ctor for ServiceLocator 061 } 062 063 @Inject 064 public EnhancedLocalRepositoryManagerFactory( 065 final LocalPathComposer localPathComposer, 066 final TrackingFileManager trackingFileManager, 067 final LocalPathPrefixComposerFactory localPathPrefixComposerFactory) { 068 this.localPathComposer = requireNonNull(localPathComposer); 069 this.trackingFileManager = requireNonNull(trackingFileManager); 070 this.localPathPrefixComposerFactory = requireNonNull(localPathPrefixComposerFactory); 071 } 072 073 @Override 074 public void initService(final ServiceLocator locator) { 075 this.localPathComposer = requireNonNull(locator.getService(LocalPathComposer.class)); 076 this.trackingFileManager = requireNonNull(locator.getService(TrackingFileManager.class)); 077 this.localPathPrefixComposerFactory = new DefaultLocalPathPrefixComposerFactory(); 078 } 079 080 @Override 081 public LocalRepositoryManager newInstance(RepositorySystemSession session, LocalRepository repository) 082 throws NoLocalRepositoryManagerException { 083 requireNonNull(session, "session cannot be null"); 084 requireNonNull(repository, "repository cannot be null"); 085 086 String trackingFilename = ConfigUtils.getString(session, "", CONFIG_PROP_TRACKING_FILENAME); 087 if (trackingFilename.isEmpty() 088 || trackingFilename.contains("/") 089 || trackingFilename.contains("\\") 090 || trackingFilename.contains("..")) { 091 trackingFilename = DEFAULT_TRACKING_FILENAME; 092 } 093 094 if ("".equals(repository.getContentType()) || "default".equals(repository.getContentType())) { 095 return new EnhancedLocalRepositoryManager( 096 repository.getBasedir(), 097 localPathComposer, 098 trackingFilename, 099 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}