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 java.util.Objects;
25
26 import org.eclipse.aether.RepositorySystemSession;
27 import org.eclipse.aether.repository.RemoteRepository;
28 import org.eclipse.aether.spi.connector.transport.Transporter;
29 import org.eclipse.aether.spi.connector.transport.TransporterFactory;
30 import org.eclipse.aether.transfer.NoTransporterException;
31
32 /**
33 * A transporter factory for repositories using the {@code file:} protocol.
34 */
35 @Named( "file" )
36 public final class FileTransporterFactory
37 implements TransporterFactory
38 {
39
40 private float priority;
41
42 /**
43 * Creates an (uninitialized) instance of this transporter factory. <em>Note:</em> In case of manual instantiation
44 * by clients, the new factory needs to be configured via its various mutators before first use or runtime errors
45 * will occur.
46 */
47 public FileTransporterFactory()
48 {
49 // enables default constructor
50 }
51
52 public float getPriority()
53 {
54 return priority;
55 }
56
57 /**
58 * Sets the priority of this component.
59 *
60 * @param priority The priority.
61 * @return This component for chaining, never {@code null}.
62 */
63 public FileTransporterFactory setPriority( float priority )
64 {
65 this.priority = priority;
66 return this;
67 }
68
69 public Transporter newInstance( RepositorySystemSession session, RemoteRepository repository )
70 throws NoTransporterException
71 {
72 Objects.requireNonNull( "session", "session cannot be null" );
73 Objects.requireNonNull( "repository", "repository cannot be null" );
74
75 return new FileTransporter( repository );
76 }
77
78 }