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.transfer.NoRepositoryConnectorException;
038
039/**
040 * A repository connector factory that employs pluggable
041 * {@link org.eclipse.aether.spi.connector.transport.TransporterFactory transporters} and
042 * {@link org.eclipse.aether.spi.connector.layout.RepositoryLayoutFactory repository layouts} for the transfers.
043 */
044@Named( "basic" )
045public final class BasicRepositoryConnectorFactory
046    implements RepositoryConnectorFactory, Service
047{
048    private TransporterProvider transporterProvider;
049
050    private RepositoryLayoutProvider layoutProvider;
051
052    private ChecksumPolicyProvider checksumPolicyProvider;
053
054    private FileProcessor fileProcessor;
055
056    private float priority;
057
058    /**
059     * Creates an (uninitialized) instance of this connector factory. <em>Note:</em> In case of manual instantiation by
060     * clients, the new factory needs to be configured via its various mutators before first use or runtime errors will
061     * occur.
062     */
063    public BasicRepositoryConnectorFactory()
064    {
065        // enables default constructor
066    }
067
068    @Inject
069    BasicRepositoryConnectorFactory( TransporterProvider transporterProvider, RepositoryLayoutProvider layoutProvider,
070                                     ChecksumPolicyProvider checksumPolicyProvider, FileProcessor fileProcessor )
071    {
072        setTransporterProvider( transporterProvider );
073        setRepositoryLayoutProvider( layoutProvider );
074        setChecksumPolicyProvider( checksumPolicyProvider );
075        setFileProcessor( fileProcessor );
076    }
077
078    public void initService( ServiceLocator locator )
079    {
080        setTransporterProvider( locator.getService( TransporterProvider.class ) );
081        setRepositoryLayoutProvider( locator.getService( RepositoryLayoutProvider.class ) );
082        setChecksumPolicyProvider( locator.getService( ChecksumPolicyProvider.class ) );
083        setFileProcessor( locator.getService( FileProcessor.class ) );
084    }
085
086    /**
087     * Sets the transporter provider to use for this component.
088     *
089     * @param transporterProvider The transporter provider to use, must not be {@code null}.
090     * @return This component for chaining, never {@code null}.
091     */
092    public BasicRepositoryConnectorFactory setTransporterProvider( TransporterProvider transporterProvider )
093    {
094        this.transporterProvider = requireNonNull( transporterProvider, "transporter provider cannot be null" );
095        return this;
096    }
097
098    /**
099     * Sets the repository layout provider to use for this component.
100     *
101     * @param layoutProvider The repository layout provider to use, must not be {@code null}.
102     * @return This component for chaining, never {@code null}.
103     */
104    public BasicRepositoryConnectorFactory setRepositoryLayoutProvider( RepositoryLayoutProvider layoutProvider )
105    {
106        this.layoutProvider =  requireNonNull( layoutProvider, "repository layout provider cannot be null" );
107        return this;
108    }
109
110    /**
111     * Sets the checksum policy provider to use for this component.
112     *
113     * @param checksumPolicyProvider The checksum policy provider to use, must not be {@code null}.
114     * @return This component for chaining, never {@code null}.
115     */
116    public BasicRepositoryConnectorFactory setChecksumPolicyProvider( ChecksumPolicyProvider checksumPolicyProvider )
117    {
118        this.checksumPolicyProvider = requireNonNull(
119                checksumPolicyProvider, "checksum policy provider cannot be null" );
120        return this;
121    }
122
123    /**
124     * Sets the file processor to use for this component.
125     *
126     * @param fileProcessor The file processor to use, must not be {@code null}.
127     * @return This component for chaining, never {@code null}.
128     */
129    public BasicRepositoryConnectorFactory setFileProcessor( FileProcessor fileProcessor )
130    {
131        this.fileProcessor = requireNonNull( fileProcessor, "file processor cannot be null" );
132        return this;
133    }
134
135    public float getPriority()
136    {
137        return priority;
138    }
139
140    /**
141     * Sets the priority of this component.
142     *
143     * @param priority The priority.
144     * @return This component for chaining, never {@code null}.
145     */
146    public BasicRepositoryConnectorFactory setPriority( float priority )
147    {
148        this.priority = priority;
149        return this;
150    }
151
152    public RepositoryConnector newInstance( RepositorySystemSession session, RemoteRepository repository )
153        throws NoRepositoryConnectorException
154    {
155        requireNonNull( "session", "session cannot be null" );
156        requireNonNull( "repository", "repository cannot be null" );
157
158        return new BasicRepositoryConnector( session, repository, transporterProvider, layoutProvider,
159                                             checksumPolicyProvider, fileProcessor );
160    }
161
162}