001package org.eclipse.aether.transport.classpath;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 * 
012 *  http://www.apache.org/licenses/LICENSE-2.0
013 * 
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import javax.inject.Named;
023
024import org.eclipse.aether.RepositorySystemSession;
025import org.eclipse.aether.repository.RemoteRepository;
026import org.eclipse.aether.spi.connector.transport.Transporter;
027import org.eclipse.aether.spi.connector.transport.TransporterFactory;
028import org.eclipse.aether.transfer.NoTransporterException;
029
030/**
031 * A transporter factory for repositories using the {@code classpath:} protocol. As example, getting an item named
032 * {@code some/file.txt} from a repository with the URL {@code classpath:/base/dir} results in retrieving the resource
033 * {@code base/dir/some/file.txt} from the classpath. The classpath to load the resources from is given via a
034 * {@link ClassLoader} that can be configured via the configuration property {@link #CONFIG_PROP_CLASS_LOADER}.
035 * <p>
036 * <em>Note:</em> Such repositories are read-only and uploads to them are generally not supported.
037 */
038@Named( "classpath" )
039public final class ClasspathTransporterFactory
040    implements TransporterFactory
041{
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    {
059        // enables default constructor
060    }
061
062
063    public float getPriority()
064    {
065        return priority;
066    }
067
068    /**
069     * Sets the priority of this component.
070     * 
071     * @param priority The priority.
072     * @return This component for chaining, never {@code null}.
073     */
074    public ClasspathTransporterFactory setPriority( float priority )
075    {
076        this.priority = priority;
077        return this;
078    }
079
080    public Transporter newInstance( RepositorySystemSession session, RemoteRepository repository )
081        throws NoTransporterException
082    {
083        return new ClasspathTransporter( session, repository );
084    }
085
086}