001package org.apache.maven.toolchain;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *  http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import org.apache.maven.execution.MavenSession;
023
024/**
025 * Component for use by the <code>maven-toolchains-plugin</code> only.
026 * It provides API: <ol>
027 * <li>to retrieve every toolchains available in user settings,</li>
028 * <li>to store chosen toolchain into build context for later use by toolchain-aware plugins.</li>
029 * </ol>
030 *
031 * @author mkleint
032 * @since 2.0.9
033 * @see ToolchainManager#getToolchainFromBuildContext(String, MavenSession)
034 */
035public interface ToolchainManagerPrivate
036{
037
038    /**
039     * Retrieves every toolchains of given type available in user settings.
040     * 
041     * @param type the type, must not be {@code null}
042     * @param context the Maven session, must not be {@code null}
043     * @since 3.0 (addition of the <code>MavenSession</code> parameter)
044     */
045    ToolchainPrivate[] getToolchainsForType( String type, MavenSession context )
046        throws MisconfiguredToolchainException;
047
048    /**
049     * Stores the toolchain into build context for later use by toolchain-aware plugins.
050     *
051     * @param toolchain the toolchain to store, must not be {@code null}
052     * @param context the Maven session, must not be {@code null}
053     * @since 2.0.9
054     * @see ToolchainManager#getToolchainFromBuildContext(String, MavenSession)
055     */
056    void storeToolchainToBuildContext( ToolchainPrivate toolchain, MavenSession context );
057
058}