Package org.eclipse.aether.transport.classpath

Class ClasspathTransporterFactory

  • All Implemented Interfaces:
    org.eclipse.aether.spi.connector.transport.TransporterFactory
    @Named("classpath")
public final class ClasspathTransporterFactory
extends java.lang.Object
implements org.eclipse.aether.spi.connector.transport.TransporterFactory
    A transporter factory for repositories using the classpath: protocol. As example, getting an item named some/file.txt from a repository with the URL classpath:/base/dir results in retrieving the resource base/dir/some/file.txt from the classpath. The classpath to load the resources from is given via a ClassLoader that can be configured via the configuration property CONFIG_PROP_CLASS_LOADER.

    Note: Such repositories are read-only and uploads to them are generally not supported.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String CONFIG_PROP_CLASS_LOADER
      The key in the repository session's configuration properties used to store a ClassLoader from which resources should be retrieved.
      static java.lang.String NAME  

    • Constructor Summary

      Constructors 
      Constructor Description
      ClasspathTransporterFactory()
      Creates an (uninitialized) instance of this transporter factory.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      float getPriority()  
      org.eclipse.aether.spi.connector.transport.Transporter newInstance​(org.eclipse.aether.RepositorySystemSession session, org.eclipse.aether.repository.RemoteRepository repository)  
      ClasspathTransporterFactory setPriority​(float priority)
      Sets the priority of this component.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • CONFIG_PROP_CLASS_LOADER

        public static final java.lang.String CONFIG_PROP_CLASS_LOADER
        The key in the repository session's configuration properties used to store a ClassLoader from which resources should be retrieved. If unspecified, the context class loader of the current thread will be used.
        See Also:
        Constant Field Values

    • Constructor Detail

      • ClasspathTransporterFactory

        public ClasspathTransporterFactory()
        Creates an (uninitialized) instance of this transporter factory. Note: In case of manual instantiation by clients, the new factory needs to be configured via its various mutators before first use or runtime errors will occur.

    • Method Detail

      • getPriority

        public float getPriority()
        Specified by:
        getPriority in interface org.eclipse.aether.spi.connector.transport.TransporterFactory

      • setPriority

        public ClasspathTransporterFactory setPriority​(float priority)
        Sets the priority of this component.
        Parameters:
        priority - The priority.
        Returns:
        This component for chaining, never null.

      • newInstance

        public org.eclipse.aether.spi.connector.transport.Transporter newInstance​(org.eclipse.aether.RepositorySystemSession session,
                                                                          org.eclipse.aether.repository.RemoteRepository repository)
                                                                   throws org.eclipse.aether.transfer.NoTransporterException
        Specified by:
        newInstance in interface org.eclipse.aether.spi.connector.transport.TransporterFactory
        Throws:
        org.eclipse.aether.transfer.NoTransporterException