View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.eclipse.aether.connector.basic;
20  
21  import javax.inject.Inject;
22  import javax.inject.Named;
23  
24  import java.util.Collections;
25  import java.util.Map;
26  
27  import org.eclipse.aether.RepositorySystemSession;
28  import org.eclipse.aether.repository.RemoteRepository;
29  import org.eclipse.aether.spi.checksums.ProvidedChecksumsSource;
30  import org.eclipse.aether.spi.connector.RepositoryConnector;
31  import org.eclipse.aether.spi.connector.RepositoryConnectorFactory;
32  import org.eclipse.aether.spi.connector.checksum.ChecksumPolicyProvider;
33  import org.eclipse.aether.spi.connector.layout.RepositoryLayoutProvider;
34  import org.eclipse.aether.spi.connector.transport.TransporterProvider;
35  import org.eclipse.aether.spi.io.FileProcessor;
36  import org.eclipse.aether.spi.locator.Service;
37  import org.eclipse.aether.spi.locator.ServiceLocator;
38  import org.eclipse.aether.transfer.NoRepositoryConnectorException;
39  
40  import static java.util.Objects.requireNonNull;
41  
42  /**
43   * A repository connector factory that employs pluggable
44   * {@link org.eclipse.aether.spi.connector.transport.TransporterFactory transporters} and
45   * {@link org.eclipse.aether.spi.connector.layout.RepositoryLayoutFactory repository layouts} for the transfers.
46   */
47  @Named(BasicRepositoryConnectorFactory.NAME)
48  public final class BasicRepositoryConnectorFactory implements RepositoryConnectorFactory, Service {
49      public static final String NAME = "basic";
50      private TransporterProvider transporterProvider;
51  
52      private RepositoryLayoutProvider layoutProvider;
53  
54      private ChecksumPolicyProvider checksumPolicyProvider;
55  
56      private FileProcessor fileProcessor;
57  
58      private Map<String, ProvidedChecksumsSource> providedChecksumsSources;
59  
60      private float priority;
61  
62      /**
63       * Creates an (uninitialized) instance of this connector factory. <em>Note:</em> In case of manual instantiation by
64       * clients, the new factory needs to be configured via its various mutators before first use or runtime errors will
65       * occur.
66       */
67      @Deprecated
68      public BasicRepositoryConnectorFactory() {
69          // enables default constructor
70      }
71  
72      @Inject
73      public BasicRepositoryConnectorFactory(
74              TransporterProvider transporterProvider,
75              RepositoryLayoutProvider layoutProvider,
76              ChecksumPolicyProvider checksumPolicyProvider,
77              FileProcessor fileProcessor,
78              Map<String, ProvidedChecksumsSource> providedChecksumsSources) {
79          setTransporterProvider(transporterProvider);
80          setRepositoryLayoutProvider(layoutProvider);
81          setChecksumPolicyProvider(checksumPolicyProvider);
82          setFileProcessor(fileProcessor);
83          setProvidedChecksumSources(providedChecksumsSources);
84      }
85  
86      public void initService(ServiceLocator locator) {
87          setTransporterProvider(locator.getService(TransporterProvider.class));
88          setRepositoryLayoutProvider(locator.getService(RepositoryLayoutProvider.class));
89          setChecksumPolicyProvider(locator.getService(ChecksumPolicyProvider.class));
90          setFileProcessor(locator.getService(FileProcessor.class));
91          setProvidedChecksumSources(Collections.emptyMap());
92      }
93  
94      /**
95       * Sets the transporter provider to use for this component.
96       *
97       * @param transporterProvider The transporter provider to use, must not be {@code null}.
98       * @return This component for chaining, never {@code null}.
99       */
100     public BasicRepositoryConnectorFactory setTransporterProvider(TransporterProvider transporterProvider) {
101         this.transporterProvider = requireNonNull(transporterProvider, "transporter provider cannot be null");
102         return this;
103     }
104 
105     /**
106      * Sets the repository layout provider to use for this component.
107      *
108      * @param layoutProvider The repository layout provider to use, must not be {@code null}.
109      * @return This component for chaining, never {@code null}.
110      */
111     public BasicRepositoryConnectorFactory setRepositoryLayoutProvider(RepositoryLayoutProvider layoutProvider) {
112         this.layoutProvider = requireNonNull(layoutProvider, "repository layout provider cannot be null");
113         return this;
114     }
115 
116     /**
117      * Sets the checksum policy provider to use for this component.
118      *
119      * @param checksumPolicyProvider The checksum policy provider to use, must not be {@code null}.
120      * @return This component for chaining, never {@code null}.
121      */
122     public BasicRepositoryConnectorFactory setChecksumPolicyProvider(ChecksumPolicyProvider checksumPolicyProvider) {
123         this.checksumPolicyProvider = requireNonNull(checksumPolicyProvider, "checksum policy provider cannot be null");
124         return this;
125     }
126 
127     /**
128      * Sets the file processor to use for this component.
129      *
130      * @param fileProcessor The file processor to use, must not be {@code null}.
131      * @return This component for chaining, never {@code null}.
132      */
133     public BasicRepositoryConnectorFactory setFileProcessor(FileProcessor fileProcessor) {
134         this.fileProcessor = requireNonNull(fileProcessor, "file processor cannot be null");
135         return this;
136     }
137 
138     /**
139      * Sets the provided checksum sources to use for this component.
140      *
141      * @param providedChecksumsSources The provided checksum sources to use, must not be {@code null}.
142      * @return This component for chaining, never {@code null}.
143      * @since 1.8.0
144      */
145     public BasicRepositoryConnectorFactory setProvidedChecksumSources(
146             Map<String, ProvidedChecksumsSource> providedChecksumsSources) {
147         this.providedChecksumsSources =
148                 requireNonNull(providedChecksumsSources, "provided checksum sources cannot be null");
149         return this;
150     }
151 
152     public float getPriority() {
153         return priority;
154     }
155 
156     /**
157      * Sets the priority of this component.
158      *
159      * @param priority The priority.
160      * @return This component for chaining, never {@code null}.
161      */
162     public BasicRepositoryConnectorFactory setPriority(float priority) {
163         this.priority = priority;
164         return this;
165     }
166 
167     public RepositoryConnector newInstance(RepositorySystemSession session, RemoteRepository repository)
168             throws NoRepositoryConnectorException {
169         requireNonNull(session, "session cannot be null");
170         requireNonNull(repository, "repository cannot be null");
171 
172         return new BasicRepositoryConnector(
173                 session,
174                 repository,
175                 transporterProvider,
176                 layoutProvider,
177                 checksumPolicyProvider,
178                 fileProcessor,
179                 providedChecksumsSources);
180     }
181 }