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