1 package org.apache.maven.execution;
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.apache.maven.settings.Settings;
23 import org.apache.maven.toolchain.model.PersistedToolchains;
24
25 /**
26 * Assists in populating an execution request for invocation of Maven.
27 *
28 * @author Benjamin Bentmann
29 */
30 public interface MavenExecutionRequestPopulator
31 {
32
33 /**
34 * Copies the values from the given settings into the specified execution request. This method will replace any
35 * existing values in the execution request that are controlled by the settings. Hence, it is expected that this
36 * method is called on a new/empty execution request before the caller mutates it to fit its needs.
37 *
38 * @param request The execution request to populate, must not be {@code null}.
39 * @param settings The settings to copy into the execution request, may be {@code null}.
40 * @return The populated execution request, never {@code null}.
41 * @throws MavenExecutionRequestPopulationException If the execution request could not be populated.
42 */
43 @Deprecated
44 MavenExecutionRequest populateFromSettings( MavenExecutionRequest request, Settings settings )
45 throws MavenExecutionRequestPopulationException;
46
47 /**
48 * Copies the values from the given toolchains into the specified execution request. This method will replace any
49 * existing values in the execution request that are controlled by the toolchains. Hence, it is expected that this
50 * method is called on a new/empty execution request before the caller mutates it to fit its needs.
51 *
52 * @param request The execution request to populate, must not be {@code null}.
53 * @param toolchains The toolchains to copy into the execution request, may be {@code null}.
54 * @return The populated execution request, never {@code null}.
55 * @throws MavenExecutionRequestPopulationException If the execution request could not be populated.
56 * @since 3.3.0
57 */
58 MavenExecutionRequest populateFromToolchains( MavenExecutionRequest request, PersistedToolchains toolchains )
59 throws MavenExecutionRequestPopulationException;
60
61 /**
62 * Injects default values like plugin groups or repositories into the specified execution request.
63 *
64 * @param request The execution request to populate, must not be {@code null}.
65 * @return The populated execution request, never {@code null}.
66 * @throws MavenExecutionRequestPopulationException If the execution request could not be populated.
67 */
68 MavenExecutionRequest populateDefaults( MavenExecutionRequest request )
69 throws MavenExecutionRequestPopulationException;
70
71 }