View Javadoc
1   package org.eclipse.aether.transport.file;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   * 
12   *  http://www.apache.org/licenses/LICENSE-2.0
13   * 
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import javax.inject.Named;
23  
24  import org.eclipse.aether.RepositorySystemSession;
25  import org.eclipse.aether.repository.RemoteRepository;
26  import org.eclipse.aether.spi.connector.transport.Transporter;
27  import org.eclipse.aether.spi.connector.transport.TransporterFactory;
28  import org.eclipse.aether.transfer.NoTransporterException;
29  
30  /**
31   * A transporter factory for repositories using the {@code file:} protocol.
32   */
33  @Named( "file" )
34  public final class FileTransporterFactory
35      implements TransporterFactory
36  {
37  
38      private float priority;
39  
40      /**
41       * Creates an (uninitialized) instance of this transporter factory. <em>Note:</em> In case of manual instantiation
42       * by clients, the new factory needs to be configured via its various mutators before first use or runtime errors
43       * will occur.
44       */
45      public FileTransporterFactory()
46      {
47          // enables default constructor
48      }
49  
50      public float getPriority()
51      {
52          return priority;
53      }
54  
55      /**
56       * Sets the priority of this component.
57       * 
58       * @param priority The priority.
59       * @return This component for chaining, never {@code null}.
60       */
61      public FileTransporterFactory setPriority( float priority )
62      {
63          this.priority = priority;
64          return this;
65      }
66  
67      public Transporter newInstance( RepositorySystemSession session, RemoteRepository repository )
68          throws NoTransporterException
69      {
70          return new FileTransporter( repository );
71      }
72  
73  }