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.toolchain;
20
21 import org.apache.maven.execution.MavenSession;
22
23 /**
24 * Component for use by the <code>maven-toolchains-plugin</code> only.
25 * It provides API: <ol>
26 * <li>to retrieve every toolchains available in user settings,</li>
27 * <li>to store chosen toolchain into build context for later use by toolchain-aware plugins.</li>
28 * </ol>
29 *
30 * @author mkleint
31 * @since 2.0.9
32 * @see ToolchainManager#getToolchainFromBuildContext(String, MavenSession)
33 */
34 public interface ToolchainManagerPrivate {
35
36 /**
37 * Retrieves every toolchains of given type available in user settings.
38 *
39 * @param type the type, must not be {@code null}
40 * @param context the Maven session, must not be {@code null}
41 * @since 3.0 (addition of the <code>MavenSession</code> parameter)
42 */
43 ToolchainPrivate[] getToolchainsForType(String type, MavenSession context) throws MisconfiguredToolchainException;
44
45 /**
46 * Stores the toolchain into build context for later use by toolchain-aware plugins.
47 *
48 * @param toolchain the toolchain to store, must not be {@code null}
49 * @param context the Maven session, must not be {@code null}
50 * @since 2.0.9
51 * @see ToolchainManager#getToolchainFromBuildContext(String, MavenSession)
52 */
53 void storeToolchainToBuildContext(ToolchainPrivate toolchain, MavenSession context);
54 }