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.Map;
22
23 import org.apache.maven.api.annotations.Consumer;
24 import org.apache.maven.api.annotations.Experimental;
25 import org.apache.maven.api.di.Named;
26
27 /**
28 * Component able to contribute to Maven session user properties. This SPI component is invoked
29 * very early, while there is no session created yet.
30 *
31 * @since 4.0.0
32 */
33 @Experimental
34 @Consumer
35 @Named
36 public interface PropertyContributor extends SpiService {
37 /**
38 * Invoked just before session is created with a mutable map that carries collected user properties so far.
39 *
40 * @param userProperties The mutable user properties, never {@code null}.
41 */
42 void contribute(Map<String, String> userProperties);
43 }