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.Inject;
023import javax.inject.Named;
024
025import org.eclipse.aether.RepositorySystemSession;
026import org.eclipse.aether.repository.RemoteRepository;
027import org.eclipse.aether.spi.connector.transport.Transporter;
028import org.eclipse.aether.spi.connector.transport.TransporterFactory;
029import org.eclipse.aether.spi.locator.Service;
030import org.eclipse.aether.spi.locator.ServiceLocator;
031import org.eclipse.aether.spi.log.Logger;
032import org.eclipse.aether.spi.log.LoggerFactory;
033import org.eclipse.aether.spi.log.NullLoggerFactory;
034import org.eclipse.aether.transfer.NoTransporterException;
035
036/**
037 * A transporter factory for repositories using the {@code classpath:} protocol. As example, getting an item named
038 * {@code some/file.txt} from a repository with the URL {@code classpath:/base/dir} results in retrieving the resource
039 * {@code base/dir/some/file.txt} from the classpath. The classpath to load the resources from is given via a
040 * {@link ClassLoader} that can be configured via the configuration property {@link #CONFIG_PROP_CLASS_LOADER}.
041 * <p>
042 * <em>Note:</em> Such repositories are read-only and uploads to them are generally not supported.
043 */
044@Named( "classpath" )
045public final class ClasspathTransporterFactory
046    implements TransporterFactory, Service
047{
048
049    /**
050     * The key in the repository session's {@link RepositorySystemSession#getConfigProperties() configuration
051     * properties} used to store a {@link ClassLoader} from which resources should be retrieved. If unspecified, the
052     * {@link Thread#getContextClassLoader() context class loader} of the current thread will be used.
053     */
054    public static final String CONFIG_PROP_CLASS_LOADER = "aether.connector.classpath.loader";
055
056    private Logger logger = NullLoggerFactory.LOGGER;
057
058    private float priority;
059
060    /**
061     * Creates an (uninitialized) instance of this transporter factory. <em>Note:</em> In case of manual instantiation
062     * by clients, the new factory needs to be configured via its various mutators before first use or runtime errors
063     * will occur.
064     */
065    public ClasspathTransporterFactory()
066    {
067        // enables default constructor
068    }
069
070    @Inject
071    ClasspathTransporterFactory( LoggerFactory loggerFactory )
072    {
073        setLoggerFactory( loggerFactory );
074    }
075
076    public void initService( ServiceLocator locator )
077    {
078        setLoggerFactory( locator.getService( LoggerFactory.class ) );
079    }
080
081    /**
082     * Sets the logger factory to use for this component.
083     * 
084     * @param loggerFactory The logger factory to use, may be {@code null} to disable logging.
085     * @return This component for chaining, never {@code null}.
086     */
087    public ClasspathTransporterFactory setLoggerFactory( LoggerFactory loggerFactory )
088    {
089        this.logger = NullLoggerFactory.getSafeLogger( loggerFactory, ClasspathTransporter.class );
090        return this;
091    }
092
093    public float getPriority()
094    {
095        return priority;
096    }
097
098    /**
099     * Sets the priority of this component.
100     * 
101     * @param priority The priority.
102     * @return This component for chaining, never {@code null}.
103     */
104    public ClasspathTransporterFactory setPriority( float priority )
105    {
106        this.priority = priority;
107        return this;
108    }
109
110    public Transporter newInstance( RepositorySystemSession session, RemoteRepository repository )
111        throws NoTransporterException
112    {
113        return new ClasspathTransporter( session, repository, logger );
114    }
115
116}