1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.maven.execution;
20
21 import org.apache.maven.settings.Settings;
22 import org.apache.maven.toolchain.model.PersistedToolchains;
23
24 /**
25 * Assists in populating an execution request for invocation of Maven.
26 *
27 */
28 public interface MavenExecutionRequestPopulator {
29 /**
30 * Copies the values from the given toolchains into the specified execution request. This method will replace any
31 * existing values in the execution request that are controlled by the toolchains. Hence, it is expected that this
32 * method is called on a new/empty execution request before the caller mutates it to fit its needs.
33 *
34 * @param request The execution request to populate, must not be {@code null}.
35 * @param toolchains The toolchains to copy into the execution request, may be {@code null}.
36 * @return The populated execution request, never {@code null}.
37 * @throws MavenExecutionRequestPopulationException If the execution request could not be populated.
38 * @since 3.3.0
39 */
40 MavenExecutionRequest populateFromToolchains(MavenExecutionRequest request, PersistedToolchains toolchains)
41 throws MavenExecutionRequestPopulationException;
42
43 /**
44 * Injects default values like plugin groups or repositories into the specified execution request.
45 *
46 * @param request The execution request to populate, must not be {@code null}.
47 * @return The populated execution request, never {@code null}.
48 * @throws MavenExecutionRequestPopulationException If the execution request could not be populated.
49 */
50 MavenExecutionRequest populateDefaults(MavenExecutionRequest request)
51 throws MavenExecutionRequestPopulationException;
52
53 /*if_not[MAVEN4]*/
54
55 /**
56 * Copies the values from the given settings into the specified execution request. This method will replace any
57 * existing values in the execution request that are controlled by the settings. Hence, it is expected that this
58 * method is called on a new/empty execution request before the caller mutates it to fit its needs.
59 *
60 * @param request The execution request to populate, must not be {@code null}.
61 * @param settings The settings to copy into the execution request, may be {@code null}.
62 * @return The populated execution request, never {@code null}.
63 * @throws MavenExecutionRequestPopulationException If the execution request could not be populated.
64 */
65 @Deprecated
66 MavenExecutionRequest populateFromSettings(MavenExecutionRequest request, Settings settings)
67 throws MavenExecutionRequestPopulationException;
68
69 /*end[MAVEN4]*/
70
71 }