View Javadoc
1   package org.apache.maven.toolchain;
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 java.util.List;
23  import java.util.Map;
24  
25  import org.apache.maven.execution.MavenSession;
26  
27  
28  /**
29   * Public API for a toolchain-aware plugin to get expected toolchain instance.
30   *
31   * @author mkleint
32   * @author Robert Scholte
33   * @since 2.0.9
34   */
35  public interface ToolchainManager
36  {
37  
38      // NOTE: Some plugins like Surefire access this field directly!
39      @Deprecated
40      String ROLE = ToolchainManager.class.getName();
41  
42      /**
43       * Retrieve toolchain of specified type from build context. It is expected that
44       * <code>maven-toolchains-plugin</code> contains the configuration to select the appropriate
45       * toolchain and is executed at the beginning of the build.
46       *
47       * @param session the Maven session, must not be {@code null}
48       * @param type the type, must not be {@code null}
49       * @return the toolchain selected by <code>maven-toolchains-plugin</code>
50       */
51      Toolchain getToolchainFromBuildContext( String type, MavenSession context );
52      
53      /**
54       * Select all toolchains available in user settings matching the type and requirements,
55       * independently from <code>maven-toolchains-plugin</code>.
56       * 
57       * @param session the Maven session, must not be {@code null}
58       * @param type the type, must not be {@code null}
59       * @param requirements the requirements, may be {@code null}
60       * @return the matching toolchains, never {@code null}
61       * @since 3.3.0
62       */
63      List<Toolchain> getToolchains( MavenSession session, String type, Map<String, String> requirements );
64  }