View Javadoc
1   package org.eclipse.aether.impl;
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 org.eclipse.aether.RepositorySystemSession;
23  import org.eclipse.aether.repository.RemoteRepository;
24  import org.eclipse.aether.spi.connector.RepositoryConnector;
25  import org.eclipse.aether.transfer.NoRepositoryConnectorException;
26  
27  /**
28   * Retrieves a repository connector from the installed repository connector factories.
29   * 
30   * @noimplement This interface is not intended to be implemented by clients.
31   * @noextend This interface is not intended to be extended by clients.
32   * @provisional This type is provisional and can be changed, moved or removed without prior notice.
33   */
34  public interface RepositoryConnectorProvider
35  {
36  
37      /**
38       * Tries to create a repository connector for the specified remote repository.
39       * 
40       * @param session The repository system session from which to configure the connector, must not be {@code null}.
41       * @param repository The remote repository to create a connector for, must not be {@code null}.
42       * @return The connector for the given repository, never {@code null}.
43       * @throws NoRepositoryConnectorException If no available factory can create a connector for the specified remote
44       *             repository.
45       */
46      RepositoryConnector newRepositoryConnector( RepositorySystemSession session, RemoteRepository repository )
47          throws NoRepositoryConnectorException;
48  
49  }