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.spi;
20
21 import java.util.HashMap;
22 import java.util.Map;
23
24 import org.apache.maven.api.ProtoSession;
25 import org.apache.maven.api.annotations.Consumer;
26 import org.apache.maven.api.annotations.Experimental;
27 import org.apache.maven.api.di.Named;
28
29 /**
30 * Component able to contribute to Maven session user properties. This SPI component is invoked
31 * very early, while there is no session created yet.
32 *
33 * @since 4.0.0
34 */
35 @Experimental
36 @Consumer
37 @Named
38 public interface PropertyContributor extends SpiService {
39 /**
40 * Invoked just before session is created with a mutable map that carries collected user properties so far.
41 *
42 * @param userProperties The mutable user properties, never {@code null}.
43 * @see #contribute(ProtoSession)
44 */
45 default void contribute(Map<String, String> userProperties) {}
46
47 /**
48 * Invoked just before session is created with proto session instance. The proto session contains user and
49 * system properties collected so far, along with other information. This method should return altered
50 * (contributions applied) user properties, not only the "new" or "added" properties!
51 *
52 * @param protoSession The proto session, never {@code null}.
53 * @return The user properties with contributions.
54 */
55 default Map<String, String> contribute(ProtoSession protoSession) {
56 HashMap<String, String> userProperties = new HashMap<>(protoSession.getUserProperties());
57 contribute(userProperties);
58 return userProperties;
59 }
60 }