View Javadoc
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.model.management;
20  
21  import javax.inject.Named;
22  import javax.inject.Singleton;
23  
24  import java.util.ArrayList;
25  import java.util.Collections;
26  import java.util.LinkedHashMap;
27  import java.util.List;
28  import java.util.Map;
29  
30  import org.apache.maven.model.Build;
31  import org.apache.maven.model.Model;
32  import org.apache.maven.model.Plugin;
33  import org.apache.maven.model.PluginContainer;
34  import org.apache.maven.model.PluginExecution;
35  import org.apache.maven.model.PluginManagement;
36  import org.apache.maven.model.building.ModelBuildingRequest;
37  import org.apache.maven.model.building.ModelProblemCollector;
38  import org.apache.maven.model.merge.MavenModelMerger;
39  
40  /**
41   * Handles injection of plugin management into the model.
42   *
43   * @deprecated use {@code org.apache.maven.api.services.ModelBuilder} instead
44   */
45  @SuppressWarnings({"checkstyle:methodname"})
46  @Named
47  @Singleton
48  @Deprecated(since = "4.0.0")
49  public class DefaultPluginManagementInjector implements PluginManagementInjector {
50  
51      private ManagementModelMerger merger = new ManagementModelMerger();
52  
53      @Override
54      public void injectManagement(Model model, ModelBuildingRequest request, ModelProblemCollector problems) {
55          merger.mergeManagedBuildPlugins(model);
56      }
57  
58      /**
59       * ManagementModelMerger
60       */
61      protected static class ManagementModelMerger extends MavenModelMerger {
62  
63          public void mergeManagedBuildPlugins(Model model) {
64              Build build = model.getBuild();
65              if (build != null) {
66                  PluginManagement pluginManagement = build.getPluginManagement();
67                  if (pluginManagement != null) {
68                      mergePluginContainerPlugins(build, pluginManagement);
69                  }
70              }
71          }
72  
73          private void mergePluginContainerPlugins(PluginContainer target, PluginContainer source) {
74              List<Plugin> src = source.getPlugins();
75              if (!src.isEmpty()) {
76                  List<Plugin> tgt = target.getPlugins();
77  
78                  Map<Object, Plugin> managedPlugins = new LinkedHashMap<>(src.size() * 2);
79  
80                  Map<Object, Object> context = Collections.emptyMap();
81  
82                  for (Plugin element : src) {
83                      Object key = getPluginKey(element);
84                      managedPlugins.put(key, element);
85                  }
86  
87                  for (Plugin element : tgt) {
88                      Object key = getPluginKey(element);
89                      Plugin managedPlugin = managedPlugins.get(key);
90                      if (managedPlugin != null) {
91                          mergePlugin(element, managedPlugin, false, context);
92                      }
93                  }
94              }
95          }
96  
97          @Override
98          protected void mergePlugin_Executions(
99                  Plugin target, Plugin source, boolean sourceDominant, Map<Object, Object> context) {
100             List<PluginExecution> src = source.getExecutions();
101             if (!src.isEmpty()) {
102                 List<PluginExecution> tgt = target.getExecutions();
103 
104                 Map<Object, PluginExecution> merged = new LinkedHashMap<>((src.size() + tgt.size()) * 2);
105 
106                 for (PluginExecution element : src) {
107                     Object key = getPluginExecutionKey(element);
108                     merged.put(key, element.clone());
109                 }
110 
111                 for (PluginExecution element : tgt) {
112                     Object key = getPluginExecutionKey(element);
113                     PluginExecution existing = merged.get(key);
114                     if (existing != null) {
115                         mergePluginExecution(element, existing, sourceDominant, context);
116                     }
117                     merged.put(key, element);
118                 }
119 
120                 target.setExecutions(new ArrayList<>(merged.values()));
121             }
122         }
123     }
124 }