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