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.transport.classpath; 20 21 import javax.inject.Named; 22 23 import org.eclipse.aether.RepositorySystemSession; 24 import org.eclipse.aether.repository.RemoteRepository; 25 import org.eclipse.aether.spi.connector.transport.Transporter; 26 import org.eclipse.aether.spi.connector.transport.TransporterFactory; 27 import org.eclipse.aether.transfer.NoTransporterException; 28 29 import static java.util.Objects.requireNonNull; 30 31 /** 32 * A transporter factory for repositories using the {@code classpath:} protocol. As example, getting an item named 33 * {@code some/file.txt} from a repository with the URL {@code classpath:/base/dir} results in retrieving the resource 34 * {@code base/dir/some/file.txt} from the classpath. The classpath to load the resources from is given via a 35 * {@link ClassLoader} that can be configured via the configuration property {@link #CONFIG_PROP_CLASS_LOADER}. 36 * <p> 37 * <em>Note:</em> Such repositories are read-only and uploads to them are generally not supported. 38 */ 39 @Named(ClasspathTransporterFactory.NAME) 40 public final class ClasspathTransporterFactory implements TransporterFactory { 41 public static final String NAME = "classpath"; 42 43 /** 44 * The key in the repository session's {@link RepositorySystemSession#getConfigProperties() configuration 45 * properties} used to store a {@link ClassLoader} from which resources should be retrieved. If unspecified, the 46 * {@link Thread#getContextClassLoader() context class loader} of the current thread will be used. 47 */ 48 public static final String CONFIG_PROP_CLASS_LOADER = "aether.connector.classpath.loader"; 49 50 private float priority; 51 52 /** 53 * Creates an (uninitialized) instance of this transporter factory. <em>Note:</em> In case of manual instantiation 54 * by clients, the new factory needs to be configured via its various mutators before first use or runtime errors 55 * will occur. 56 */ 57 public ClasspathTransporterFactory() { 58 // enables default constructor 59 } 60 61 public float getPriority() { 62 return priority; 63 } 64 65 /** 66 * Sets the priority of this component. 67 * 68 * @param priority The priority. 69 * @return This component for chaining, never {@code null}. 70 */ 71 public ClasspathTransporterFactory setPriority(float priority) { 72 this.priority = priority; 73 return this; 74 } 75 76 public Transporter newInstance(RepositorySystemSession session, RemoteRepository repository) 77 throws NoTransporterException { 78 requireNonNull(session, "session cannot be null"); 79 requireNonNull(repository, "repository cannot be null"); 80 81 return new ClasspathTransporter(session, repository); 82 } 83 }