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