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.transport.classpath;
020
021import javax.inject.Named;
022
023import org.eclipse.aether.RepositorySystemSession;
024import org.eclipse.aether.repository.RemoteRepository;
025import org.eclipse.aether.spi.connector.transport.Transporter;
026import org.eclipse.aether.spi.connector.transport.TransporterFactory;
027import org.eclipse.aether.transfer.NoTransporterException;
028
029import static java.util.Objects.requireNonNull;
030
031/**
032 * A transporter factory for repositories using the {@code classpath:} protocol. As example, getting an item named
033 * {@code some/file.txt} from a repository with the URL {@code classpath:/base/dir} results in retrieving the resource
034 * {@code base/dir/some/file.txt} from the classpath. The classpath to load the resources from is given via a
035 * {@link ClassLoader} that can be configured via the configuration property {@link #CONFIG_PROP_CLASS_LOADER}.
036 * <p>
037 * <em>Note:</em> Such repositories are read-only and uploads to them are generally not supported.
038 */
039@Named(ClasspathTransporterFactory.NAME)
040public final class ClasspathTransporterFactory implements TransporterFactory {
041    public static final String NAME = "classpath";
042
043    /**
044     * The key in the repository session's {@link RepositorySystemSession#getConfigProperties() configuration
045     * properties} used to store a {@link ClassLoader} from which resources should be retrieved. If unspecified, the
046     * {@link Thread#getContextClassLoader() context class loader} of the current thread will be used.
047     */
048    public static final String CONFIG_PROP_CLASS_LOADER = "aether.connector.classpath.loader";
049
050    private float priority;
051
052    /**
053     * Creates an (uninitialized) instance of this transporter factory. <em>Note:</em> In case of manual instantiation
054     * by clients, the new factory needs to be configured via its various mutators before first use or runtime errors
055     * will occur.
056     */
057    public ClasspathTransporterFactory() {
058        // enables default constructor
059    }
060
061    public float getPriority() {
062        return priority;
063    }
064
065    /**
066     * Sets the priority of this component.
067     *
068     * @param priority The priority.
069     * @return This component for chaining, never {@code null}.
070     */
071    public ClasspathTransporterFactory setPriority(float priority) {
072        this.priority = priority;
073        return this;
074    }
075
076    public Transporter newInstance(RepositorySystemSession session, RemoteRepository repository)
077            throws NoTransporterException {
078        requireNonNull(session, "session cannot be null");
079        requireNonNull(repository, "repository cannot be null");
080
081        return new ClasspathTransporter(session, repository);
082    }
083}