Package org.eclipse.aether.transport.file

Class FileTransporterFactory

java.lang.Object
org.eclipse.aether.transport.file.FileTransporterFactory
All Implemented Interfaces:
TransporterFactory
@Named("file") public final class FileTransporterFactory extends Object implements TransporterFactory
A transporter factory for repositories using the file: protocol.

  • Constructor Details

    • FileTransporterFactory

      public FileTransporterFactory()
      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 Details

    • getPriority

      public float getPriority()
      Description copied from interface: TransporterFactory
      The priority of this factory. When multiple factories can handle a given repository, factories with higher priority are preferred over those with lower priority.
      Specified by:
      getPriority in interface TransporterFactory
      Returns:
      The priority of this factory.

    • setPriority

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

    • newInstance

      public Transporter newInstance(RepositorySystemSession session, RemoteRepository repository) throws NoTransporterException
      Description copied from interface: TransporterFactory
      Tries to create a transporter for the specified remote repository. Typically, a factory will inspect RemoteRepository.getProtocol() to determine whether it can handle a repository.
      Specified by:
      newInstance in interface TransporterFactory
      Parameters:
      session - The repository system session from which to configure the transporter, must not be null. In particular, a transporter should obey the timeouts configured for the session.
      repository - The remote repository to create a transporter for, must not be null.
      Returns:
      The transporter for the given repository, never null.
      Throws:
      NoTransporterException - If the factory cannot create a transporter for the specified remote repository.