1 package org.apache.maven.project;
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.sonatype.aether.RepositorySystemSession;
23 import org.sonatype.aether.graph.DependencyFilter;
24
25 /**
26 * A request to resolve the dependencies of a project.
27 *
28 * @author Benjamin Bentmann
29 */
30 public interface DependencyResolutionRequest
31 {
32
33 /**
34 * Gets the project to resolve dependencies for.
35 *
36 * @return The project to resolve dependencies for or {@code null} if not set.
37 */
38 MavenProject getMavenProject();
39
40 /**
41 * Sets the project to resolve dependencies for.
42 *
43 * @param project The project to resolve dependencies for, may be {@code null}.
44 * @return This request for chaining, never {@code null}.
45 */
46 DependencyResolutionRequest setMavenProject( MavenProject project );
47
48 /**
49 * Gets the filter used to exclude some dependencies from resolution.
50 *
51 * @return The filter to exclude dependencies from resolution or {@code null} to resolve all dependencies.
52 */
53 DependencyFilter getResolutionFilter();
54
55 /**
56 * Sets the filter used to exclude some dependencies from resolution. Note that this filter only controls the
57 * resolution/download of dependency artifacts, not the inclusion of dependency nodes in the resolved dependeny
58 * graph.
59 *
60 * @param filter The filter to exclude dependencies from resolution, may be {@code null} to resolve all
61 * dependencies.
62 * @return This request for chaining, never {@code null}.
63 */
64 DependencyResolutionRequest setResolutionFilter( DependencyFilter filter );
65
66 /**
67 * Gets the session to use for repository access.
68 *
69 * @return The repository session or {@code null} if not set.
70 */
71 RepositorySystemSession getRepositorySession();
72
73 /**
74 * Sets the session to use for repository access.
75 *
76 * @param repositorySession The repository session to use.
77 * @return This request for chaining, never {@code null}.
78 */
79 DependencyResolutionRequest setRepositorySession( RepositorySystemSession repositorySession );
80
81 }