View Javadoc

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