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 java.util.Objects;
24
25 import org.eclipse.aether.RepositorySystemSession;
26 import org.eclipse.aether.repository.RemoteRepository;
27 import org.eclipse.aether.spi.connector.transport.Transporter;
28 import org.eclipse.aether.spi.connector.transport.TransporterFactory;
29 import org.eclipse.aether.transfer.NoTransporterException;
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("classpath")
40 public final class ClasspathTransporterFactory implements TransporterFactory {
41
42 /**
43 * The key in the repository session's {@link RepositorySystemSession#getConfigProperties() configuration
44 * properties} used to store a {@link ClassLoader} from which resources should be retrieved. If unspecified, the
45 * {@link Thread#getContextClassLoader() context class loader} of the current thread will be used.
46 */
47 public static final String CONFIG_PROP_CLASS_LOADER = "aether.connector.classpath.loader";
48
49 private float priority;
50
51 /**
52 * Creates an (uninitialized) instance of this transporter factory. <em>Note:</em> In case of manual instantiation
53 * by clients, the new factory needs to be configured via its various mutators before first use or runtime errors
54 * will occur.
55 */
56 public ClasspathTransporterFactory() {
57 // enables default constructor
58 }
59
60 public float getPriority() {
61 return priority;
62 }
63
64 /**
65 * Sets the priority of this component.
66 *
67 * @param priority The priority.
68 * @return This component for chaining, never {@code null}.
69 */
70 public ClasspathTransporterFactory setPriority(float priority) {
71 this.priority = priority;
72 return this;
73 }
74
75 public Transporter newInstance(RepositorySystemSession session, RemoteRepository repository)
76 throws NoTransporterException {
77 Objects.requireNonNull(session, "session cannot be null");
78 Objects.requireNonNull(repository, "repository cannot be null");
79
80 return new ClasspathTransporter(session, repository);
81 }
82 }