View Javadoc

1   /*
2    * Copyright 2013 smartics, Kronseder & Reiner GmbH
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package de.smartics.maven.plugin.jboss.modules.aether;
17  
18  import java.util.List;
19  
20  import org.sonatype.aether.RepositorySystem;
21  import org.sonatype.aether.RepositorySystemSession;
22  import org.sonatype.aether.graph.Dependency;
23  import org.sonatype.aether.graph.DependencyFilter;
24  import org.sonatype.aether.repository.RemoteRepository;
25  
26  /**
27   * Interface to provide resources to create instances of {@link MavenRepository}
28   * .
29   */
30  public interface RepositoryBuilder
31  {
32  
33    // ********************************* Fields *********************************
34  
35    // --- constants ------------------------------------------------------------
36  
37    // ****************************** Initializer *******************************
38  
39    // ****************************** Inner Classes *****************************
40  
41    // ********************************* Methods ********************************
42  
43    // --- get&set --------------------------------------------------------------
44  
45    /**
46     * Returns the system to run requests against.
47     *
48     * @return the system to run requests against.
49     */
50    RepositorySystem getRepositorySystem();
51  
52    /**
53     * Returns the filters for dependencies.
54     *
55     * @return the filters for dependencies.
56     */
57    List<DependencyFilter> getDependencyFilters();
58  
59    /**
60     * Returns the flag to set the system offline.
61     *
62     * @return the flag to set the system offline.
63     */
64    boolean isOffline();
65  
66    /**
67     * Returns the session to launch requests.
68     *
69     * @return the session to launch requests.
70     */
71    RepositorySystemSession getSession();
72  
73    /**
74     * Returns the remote repositories of artifacts.
75     *
76     * @return the remote repositories of artifacts.
77     */
78    List<RemoteRepository> getRemoteRepositories();
79  
80    /**
81     * The list of managed dependencies to allow to resolve the appropriate
82     * versions of artifacts.
83     *
84     * @return the list of managed dependencies.
85     */
86    List<Dependency> getManagedDependencies();
87  
88    /**
89     * Returns the generator of traversers used to prune dependency branches.
90     *
91     * @return the generator of traversers used to prune dependency branches.
92     */
93    DependencyTraverserGenerator getTraverserGenerator();
94  
95    // --- business -------------------------------------------------------------
96  
97    // --- object basics --------------------------------------------------------
98  
99  }