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.api.services;
20
21 import java.util.List;
22 import java.util.Map;
23 import java.util.Optional;
24 import org.apache.maven.api.Service;
25 import org.apache.maven.api.Session;
26 import org.apache.maven.api.Toolchain;
27 import org.apache.maven.api.annotations.Experimental;
28 import org.apache.maven.api.annotations.Nonnull;
29
30 /**
31 * Service to manage {@link Toolchain}s.
32 *
33 * @since 4.0
34 */
35 @Experimental
36 public interface ToolchainManager extends Service {
37
38 /**
39 *
40 * @param session
41 * @param type
42 * @param requirements
43 * @return the selected {@link Toolchain}s
44 * @throws ToolchainManagerException if an exception occurs
45 */
46 @Nonnull
47 List<Toolchain> getToolchains(@Nonnull Session session, String type, Map<String, String> requirements);
48
49 /**
50 *
51 * @param session
52 * @param type
53 * @return the selected {@link Toolchain}
54 * @throws ToolchainManagerException if an exception occurs
55 */
56 @Nonnull
57 Optional<Toolchain> getToolchainFromBuildContext(@Nonnull Session session, String type)
58 throws ToolchainManagerException;
59
60 /**
61 *
62 * @param session
63 * @param type
64 * @return the selected {@link Toolchain}s
65 * @throws ToolchainManagerException if an exception occurs
66 */
67 @Nonnull
68 List<Toolchain> getToolchainsForType(@Nonnull Session session, String type) throws ToolchainManagerException;
69
70 /**
71 *
72 * @param session
73 * @param toolchain
74 * @throws ToolchainManagerException if an exception occurs
75 */
76 void storeToolchainToBuildContext(@Nonnull Session session, Toolchain toolchain) throws ToolchainManagerException;
77 }