001package org.eclipse.aether.transport.wagon; 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 org.eclipse.aether.RepositorySystemSession; 026import org.eclipse.aether.repository.RemoteRepository; 027import org.eclipse.aether.spi.connector.transport.Transporter; 028import org.eclipse.aether.spi.connector.transport.TransporterFactory; 029import org.eclipse.aether.spi.locator.Service; 030import org.eclipse.aether.spi.locator.ServiceLocator; 031import org.eclipse.aether.spi.log.Logger; 032import org.eclipse.aether.spi.log.LoggerFactory; 033import org.eclipse.aether.spi.log.NullLoggerFactory; 034import org.eclipse.aether.transfer.NoTransporterException; 035 036/** 037 * A transporter factory using <a href="http://maven.apache.org/wagon/" target="_blank">Apache Maven Wagon</a>. Note 038 * that this factory merely serves as an adapter to the Wagon API and by itself does not provide any transport services 039 * unless one or more wagon implementations are registered with the {@link WagonProvider}. 040 */ 041@Named( "wagon" ) 042public final class WagonTransporterFactory 043 implements TransporterFactory, Service 044{ 045 046 private Logger logger = NullLoggerFactory.LOGGER; 047 048 private WagonProvider wagonProvider; 049 050 private WagonConfigurator wagonConfigurator; 051 052 private float priority = -1.0f; 053 054 /** 055 * Creates an (uninitialized) instance of this transporter factory. <em>Note:</em> In case of manual instantiation 056 * by clients, the new factory needs to be configured via its various mutators before first use or runtime errors 057 * will occur. 058 */ 059 public WagonTransporterFactory() 060 { 061 // enables default constructor 062 } 063 064 @Inject 065 WagonTransporterFactory( WagonProvider wagonProvider, WagonConfigurator wagonConfigurator, 066 LoggerFactory loggerFactory ) 067 { 068 setWagonProvider( wagonProvider ); 069 setWagonConfigurator( wagonConfigurator ); 070 setLoggerFactory( loggerFactory ); 071 } 072 073 public void initService( ServiceLocator locator ) 074 { 075 setLoggerFactory( locator.getService( LoggerFactory.class ) ); 076 setWagonProvider( locator.getService( WagonProvider.class ) ); 077 setWagonConfigurator( locator.getService( WagonConfigurator.class ) ); 078 } 079 080 /** 081 * Sets the logger factory to use for this component. 082 * 083 * @param loggerFactory The logger factory to use, may be {@code null} to disable logging. 084 * @return This component for chaining, never {@code null}. 085 */ 086 public WagonTransporterFactory setLoggerFactory( LoggerFactory loggerFactory ) 087 { 088 this.logger = NullLoggerFactory.getSafeLogger( loggerFactory, WagonTransporter.class ); 089 return this; 090 } 091 092 /** 093 * Sets the wagon provider to use to acquire and release wagon instances. 094 * 095 * @param wagonProvider The wagon provider to use, may be {@code null}. 096 * @return This factory for chaining, never {@code null}. 097 */ 098 public WagonTransporterFactory setWagonProvider( WagonProvider wagonProvider ) 099 { 100 this.wagonProvider = wagonProvider; 101 return this; 102 } 103 104 /** 105 * Sets the wagon configurator to use to apply provider-specific configuration to wagon instances. 106 * 107 * @param wagonConfigurator The wagon configurator to use, may be {@code null}. 108 * @return This factory for chaining, never {@code null}. 109 */ 110 public WagonTransporterFactory setWagonConfigurator( WagonConfigurator wagonConfigurator ) 111 { 112 this.wagonConfigurator = wagonConfigurator; 113 return this; 114 } 115 116 public float getPriority() 117 { 118 return priority; 119 } 120 121 /** 122 * Sets the priority of this component. 123 * 124 * @param priority The priority. 125 * @return This component for chaining, never {@code null}. 126 */ 127 public WagonTransporterFactory setPriority( float priority ) 128 { 129 this.priority = priority; 130 return this; 131 } 132 133 public Transporter newInstance( RepositorySystemSession session, RemoteRepository repository ) 134 throws NoTransporterException 135 { 136 return new WagonTransporter( wagonProvider, wagonConfigurator, repository, session, logger ); 137 } 138 139}