1 package org.eclipse.aether.transport.wagon;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 import javax.inject.Inject;
23 import javax.inject.Named;
24
25 import org.eclipse.aether.RepositorySystemSession;
26 import org.eclipse.aether.repository.RemoteRepository;
27 import org.eclipse.aether.spi.connector.transport.Transporter;
28 import org.eclipse.aether.spi.connector.transport.TransporterFactory;
29 import org.eclipse.aether.spi.locator.Service;
30 import org.eclipse.aether.spi.locator.ServiceLocator;
31 import org.eclipse.aether.spi.log.Logger;
32 import org.eclipse.aether.spi.log.LoggerFactory;
33 import org.eclipse.aether.spi.log.NullLoggerFactory;
34 import org.eclipse.aether.transfer.NoTransporterException;
35
36 /**
37 * A transporter factory using <a href="http://maven.apache.org/wagon/" target="_blank">Apache Maven Wagon</a>. Note
38 * that this factory merely serves as an adapter to the Wagon API and by itself does not provide any transport services
39 * unless one or more wagon implementations are registered with the {@link WagonProvider}.
40 */
41 @Named( "wagon" )
42 public final class WagonTransporterFactory
43 implements TransporterFactory, Service
44 {
45
46 private Logger logger = NullLoggerFactory.LOGGER;
47
48 private WagonProvider wagonProvider;
49
50 private WagonConfigurator wagonConfigurator;
51
52 private float priority = -1.0f;
53
54 /**
55 * Creates an (uninitialized) instance of this transporter factory. <em>Note:</em> In case of manual instantiation
56 * by clients, the new factory needs to be configured via its various mutators before first use or runtime errors
57 * will occur.
58 */
59 public WagonTransporterFactory()
60 {
61 // enables default constructor
62 }
63
64 @Inject
65 WagonTransporterFactory( WagonProvider wagonProvider, WagonConfigurator wagonConfigurator,
66 LoggerFactory loggerFactory )
67 {
68 setWagonProvider( wagonProvider );
69 setWagonConfigurator( wagonConfigurator );
70 setLoggerFactory( loggerFactory );
71 }
72
73 public void initService( ServiceLocator locator )
74 {
75 setLoggerFactory( locator.getService( LoggerFactory.class ) );
76 setWagonProvider( locator.getService( WagonProvider.class ) );
77 setWagonConfigurator( locator.getService( WagonConfigurator.class ) );
78 }
79
80 /**
81 * Sets the logger factory to use for this component.
82 *
83 * @param loggerFactory The logger factory to use, may be {@code null} to disable logging.
84 * @return This component for chaining, never {@code null}.
85 */
86 public WagonTransporterFactory setLoggerFactory( LoggerFactory loggerFactory )
87 {
88 this.logger = NullLoggerFactory.getSafeLogger( loggerFactory, WagonTransporter.class );
89 return this;
90 }
91
92 /**
93 * Sets the wagon provider to use to acquire and release wagon instances.
94 *
95 * @param wagonProvider The wagon provider to use, may be {@code null}.
96 * @return This factory for chaining, never {@code null}.
97 */
98 public WagonTransporterFactory setWagonProvider( WagonProvider wagonProvider )
99 {
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 }