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 javax.inject.Inject; 023import javax.inject.Named; 024 025import static java.util.Objects.requireNonNull; 026 027import org.eclipse.aether.RepositorySystemSession; 028import org.eclipse.aether.repository.RemoteRepository; 029import org.eclipse.aether.spi.connector.RepositoryConnector; 030import org.eclipse.aether.spi.connector.RepositoryConnectorFactory; 031import org.eclipse.aether.spi.connector.checksum.ChecksumPolicyProvider; 032import org.eclipse.aether.spi.connector.layout.RepositoryLayoutProvider; 033import org.eclipse.aether.spi.connector.transport.TransporterProvider; 034import org.eclipse.aether.spi.io.FileProcessor; 035import org.eclipse.aether.spi.locator.Service; 036import org.eclipse.aether.spi.locator.ServiceLocator; 037import org.eclipse.aether.spi.log.Logger; 038import org.eclipse.aether.spi.log.LoggerFactory; 039import org.eclipse.aether.spi.log.NullLoggerFactory; 040import org.eclipse.aether.transfer.NoRepositoryConnectorException; 041 042/** 043 * A repository connector factory that employs pluggable 044 * {@link org.eclipse.aether.spi.connector.transport.TransporterFactory transporters} and 045 * {@link org.eclipse.aether.spi.connector.layout.RepositoryLayoutFactory repository layouts} for the transfers. 046 */ 047@Named( "basic" ) 048public final class BasicRepositoryConnectorFactory 049 implements RepositoryConnectorFactory, Service 050{ 051 052 private Logger logger = NullLoggerFactory.LOGGER; 053 054 private TransporterProvider transporterProvider; 055 056 private RepositoryLayoutProvider layoutProvider; 057 058 private ChecksumPolicyProvider checksumPolicyProvider; 059 060 private FileProcessor fileProcessor; 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, RepositoryLayoutProvider layoutProvider, 076 ChecksumPolicyProvider checksumPolicyProvider, FileProcessor fileProcessor, 077 LoggerFactory loggerFactory ) 078 { 079 setTransporterProvider( transporterProvider ); 080 setRepositoryLayoutProvider( layoutProvider ); 081 setChecksumPolicyProvider( checksumPolicyProvider ); 082 setFileProcessor( fileProcessor ); 083 setLoggerFactory( loggerFactory ); 084 } 085 086 public void initService( ServiceLocator locator ) 087 { 088 setLoggerFactory( locator.getService( LoggerFactory.class ) ); 089 setTransporterProvider( locator.getService( TransporterProvider.class ) ); 090 setRepositoryLayoutProvider( locator.getService( RepositoryLayoutProvider.class ) ); 091 setChecksumPolicyProvider( locator.getService( ChecksumPolicyProvider.class ) ); 092 setFileProcessor( locator.getService( FileProcessor.class ) ); 093 } 094 095 /** 096 * Sets the logger factory to use for this component. 097 * 098 * @param loggerFactory The logger factory to use, may be {@code null} to disable logging. 099 * @return This component for chaining, never {@code null}. 100 */ 101 public BasicRepositoryConnectorFactory setLoggerFactory( LoggerFactory loggerFactory ) 102 { 103 this.logger = NullLoggerFactory.getSafeLogger( loggerFactory, BasicRepositoryConnector.class ); 104 return this; 105 } 106 107 /** 108 * Sets the transporter provider to use for this component. 109 * 110 * @param transporterProvider The transporter provider to use, must not be {@code null}. 111 * @return This component for chaining, never {@code null}. 112 */ 113 public BasicRepositoryConnectorFactory setTransporterProvider( TransporterProvider transporterProvider ) 114 { 115 this.transporterProvider = requireNonNull( transporterProvider, "transporter provider cannot be null" ); 116 return this; 117 } 118 119 /** 120 * Sets the repository layout provider to use for this component. 121 * 122 * @param layoutProvider The repository layout provider to use, must not be {@code null}. 123 * @return This component for chaining, never {@code null}. 124 */ 125 public BasicRepositoryConnectorFactory setRepositoryLayoutProvider( RepositoryLayoutProvider layoutProvider ) 126 { 127 this.layoutProvider = requireNonNull( layoutProvider, "repository layout provider cannot be null" ); 128 return this; 129 } 130 131 /** 132 * Sets the checksum policy provider to use for this component. 133 * 134 * @param checksumPolicyProvider The checksum policy provider to use, must not be {@code null}. 135 * @return This component for chaining, never {@code null}. 136 */ 137 public BasicRepositoryConnectorFactory setChecksumPolicyProvider( ChecksumPolicyProvider checksumPolicyProvider ) 138 { 139 this.checksumPolicyProvider = requireNonNull( checksumPolicyProvider, "checksum policy provider cannot be null" ); 140 return this; 141 } 142 143 /** 144 * Sets the file processor to use for this component. 145 * 146 * @param fileProcessor The file processor to use, must not be {@code null}. 147 * @return This component for chaining, never {@code null}. 148 */ 149 public BasicRepositoryConnectorFactory setFileProcessor( FileProcessor fileProcessor ) 150 { 151 this.fileProcessor = requireNonNull( fileProcessor, "file processor cannot be null" ); 152 return this; 153 } 154 155 public float getPriority() 156 { 157 return priority; 158 } 159 160 /** 161 * Sets the priority of this component. 162 * 163 * @param priority The priority. 164 * @return This component for chaining, never {@code null}. 165 */ 166 public BasicRepositoryConnectorFactory setPriority( float priority ) 167 { 168 this.priority = priority; 169 return this; 170 } 171 172 public RepositoryConnector newInstance( RepositorySystemSession session, RemoteRepository repository ) 173 throws NoRepositoryConnectorException 174 { 175 return new BasicRepositoryConnector( session, repository, transporterProvider, layoutProvider, 176 checksumPolicyProvider, fileProcessor, logger ); 177 } 178 179}