001package org.eclipse.aether.connector.basic; 002 003/* 004 * Licensed to the Apache Software Foundation (ASF) under one 005 * or more contributor license agreements. See the NOTICE file 006 * distributed with this work for additional information 007 * regarding copyright ownership. The ASF licenses this file 008 * to you under the Apache License, Version 2.0 (the 009 * "License"); you may not use this file except in compliance 010 * with the License. You may obtain a copy of the License at 011 * 012 * http://www.apache.org/licenses/LICENSE-2.0 013 * 014 * Unless required by applicable law or agreed to in writing, 015 * software distributed under the License is distributed on an 016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 017 * KIND, either express or implied. See the License for the 018 * specific language governing permissions and limitations 019 * under the License. 020 */ 021 022import java.util.Collections; 023import java.util.Map; 024 025import javax.inject.Inject; 026import javax.inject.Named; 027 028import static java.util.Objects.requireNonNull; 029 030import org.eclipse.aether.RepositorySystemSession; 031import org.eclipse.aether.repository.RemoteRepository; 032import org.eclipse.aether.spi.connector.RepositoryConnector; 033import org.eclipse.aether.spi.connector.RepositoryConnectorFactory; 034import org.eclipse.aether.spi.connector.checksum.ChecksumPolicyProvider; 035import org.eclipse.aether.spi.connector.checksum.ProvidedChecksumsSource; 036import org.eclipse.aether.spi.connector.layout.RepositoryLayoutProvider; 037import org.eclipse.aether.spi.connector.transport.TransporterProvider; 038import org.eclipse.aether.spi.io.FileProcessor; 039import org.eclipse.aether.spi.locator.Service; 040import org.eclipse.aether.spi.locator.ServiceLocator; 041import org.eclipse.aether.transfer.NoRepositoryConnectorException; 042 043/** 044 * A repository connector factory that employs pluggable 045 * {@link org.eclipse.aether.spi.connector.transport.TransporterFactory transporters} and 046 * {@link org.eclipse.aether.spi.connector.layout.RepositoryLayoutFactory repository layouts} for the transfers. 047 */ 048@Named( "basic" ) 049public final class BasicRepositoryConnectorFactory 050 implements RepositoryConnectorFactory, Service 051{ 052 private TransporterProvider transporterProvider; 053 054 private RepositoryLayoutProvider layoutProvider; 055 056 private ChecksumPolicyProvider checksumPolicyProvider; 057 058 private FileProcessor fileProcessor; 059 060 private Map<String, ProvidedChecksumsSource> providedChecksumsSources; 061 062 private float priority; 063 064 /** 065 * Creates an (uninitialized) instance of this connector factory. <em>Note:</em> In case of manual instantiation by 066 * clients, the new factory needs to be configured via its various mutators before first use or runtime errors will 067 * occur. 068 */ 069 public BasicRepositoryConnectorFactory() 070 { 071 // enables default constructor 072 } 073 074 @Inject 075 BasicRepositoryConnectorFactory( TransporterProvider transporterProvider, 076 RepositoryLayoutProvider layoutProvider, 077 ChecksumPolicyProvider checksumPolicyProvider, 078 FileProcessor fileProcessor, 079 Map<String, ProvidedChecksumsSource> providedChecksumsSources ) 080 { 081 setTransporterProvider( transporterProvider ); 082 setRepositoryLayoutProvider( layoutProvider ); 083 setChecksumPolicyProvider( checksumPolicyProvider ); 084 setFileProcessor( fileProcessor ); 085 setProvidedChecksumSources( providedChecksumsSources ); 086 } 087 088 public void initService( ServiceLocator locator ) 089 { 090 setTransporterProvider( locator.getService( TransporterProvider.class ) ); 091 setRepositoryLayoutProvider( locator.getService( RepositoryLayoutProvider.class ) ); 092 setChecksumPolicyProvider( locator.getService( ChecksumPolicyProvider.class ) ); 093 setFileProcessor( locator.getService( FileProcessor.class ) ); 094 setProvidedChecksumSources( Collections.emptyMap() ); 095 } 096 097 /** 098 * Sets the transporter provider to use for this component. 099 * 100 * @param transporterProvider The transporter provider to use, must not be {@code null}. 101 * @return This component for chaining, never {@code null}. 102 */ 103 public BasicRepositoryConnectorFactory setTransporterProvider( TransporterProvider transporterProvider ) 104 { 105 this.transporterProvider = requireNonNull( transporterProvider, "transporter provider cannot be null" ); 106 return this; 107 } 108 109 /** 110 * Sets the repository layout provider to use for this component. 111 * 112 * @param layoutProvider The repository layout provider to use, must not be {@code null}. 113 * @return This component for chaining, never {@code null}. 114 */ 115 public BasicRepositoryConnectorFactory setRepositoryLayoutProvider( RepositoryLayoutProvider layoutProvider ) 116 { 117 this.layoutProvider = requireNonNull( layoutProvider, "repository layout provider cannot be null" ); 118 return this; 119 } 120 121 /** 122 * Sets the checksum policy provider to use for this component. 123 * 124 * @param checksumPolicyProvider The checksum policy provider to use, must not be {@code null}. 125 * @return This component for chaining, never {@code null}. 126 */ 127 public BasicRepositoryConnectorFactory setChecksumPolicyProvider( ChecksumPolicyProvider checksumPolicyProvider ) 128 { 129 this.checksumPolicyProvider = requireNonNull( 130 checksumPolicyProvider, "checksum policy provider cannot be null" ); 131 return this; 132 } 133 134 /** 135 * Sets the file processor to use for this component. 136 * 137 * @param fileProcessor The file processor to use, must not be {@code null}. 138 * @return This component for chaining, never {@code null}. 139 */ 140 public BasicRepositoryConnectorFactory setFileProcessor( FileProcessor fileProcessor ) 141 { 142 this.fileProcessor = requireNonNull( fileProcessor, "file processor cannot be null" ); 143 return this; 144 } 145 146 /** 147 * Sets the provided checksum sources to use for this component. 148 * 149 * @param providedChecksumsSources The provided checksum sources to use, must not be {@code null}. 150 * @return This component for chaining, never {@code null}. 151 * @since 1.8.0 152 */ 153 public BasicRepositoryConnectorFactory setProvidedChecksumSources( 154 Map<String, ProvidedChecksumsSource> providedChecksumsSources ) 155 { 156 this.providedChecksumsSources = requireNonNull( 157 providedChecksumsSources, "provided checksum sources cannot be null" 158 ); 159 return this; 160 } 161 162 public float getPriority() 163 { 164 return priority; 165 } 166 167 /** 168 * Sets the priority of this component. 169 * 170 * @param priority The priority. 171 * @return This component for chaining, never {@code null}. 172 */ 173 public BasicRepositoryConnectorFactory setPriority( float priority ) 174 { 175 this.priority = priority; 176 return this; 177 } 178 179 public RepositoryConnector newInstance( RepositorySystemSession session, RemoteRepository repository ) 180 throws NoRepositoryConnectorException 181 { 182 requireNonNull( session, "session cannot be null" ); 183 requireNonNull( repository, "repository cannot be null" ); 184 185 return new BasicRepositoryConnector( session, repository, transporterProvider, layoutProvider, 186 checksumPolicyProvider, fileProcessor, providedChecksumsSources ); 187 } 188 189}