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.model.profile;
20
21 import java.io.File;
22 import java.util.List;
23 import java.util.Map;
24
25 /**
26 * Describes the environmental context used to determine the activation status of profiles.
27 *
28 * @deprecated use {@code org.apache.maven.api.services.ModelBuilder} instead
29 */
30 @Deprecated(since = "4.0.0")
31 public interface ProfileActivationContext {
32 /**
33 * Key of the property containing the project's packaging.
34 * Available in {@link #getUserProperties()}.
35 * @since 3.9
36 */
37 String PROPERTY_NAME_PACKAGING = "packaging";
38
39 /**
40 * Gets the identifiers of those profiles that should be activated by explicit demand.
41 *
42 * @return The identifiers of those profiles to activate, never {@code null}.
43 */
44 List<String> getActiveProfileIds();
45
46 /**
47 * Gets the identifiers of those profiles that should be deactivated by explicit demand.
48 *
49 * @return The identifiers of those profiles to deactivate, never {@code null}.
50 */
51 List<String> getInactiveProfileIds();
52
53 /**
54 * Gets the system properties to use for interpolation and profile activation. The system properties are collected
55 * from the runtime environment like {@link System#getProperties()} and environment variables.
56 *
57 * @return The execution properties, never {@code null}.
58 */
59 Map<String, String> getSystemProperties();
60
61 /**
62 * Gets the user properties to use for interpolation and profile activation. The user properties have been
63 * configured directly by the user on his discretion, e.g. via the {@code -Dkey=value} parameter on the command
64 * line.
65 * <p>
66 * <b>In repository-resolved (external) model builds</b> (dependency POMs, parent POMs, imported BOMs), this
67 * map is intentionally empty. Consumer {@code -D} flags are not propagated to dependency profile activation:
68 * the consumer did not set those flags for the dependency, and doing so would make dependency resolution
69 * non-deterministic and open to accidental (or malicious) profile injection.
70 *
71 * @return The user properties, never {@code null}.
72 */
73 Map<String, String> getUserProperties();
74
75 /**
76 * Gets the base directory of the current project (if any).
77 *
78 * @return The base directory of the current project or {@code null} if none.
79 */
80 File getProjectDirectory();
81
82 /**
83 * Gets current calculated project properties
84 * <p>
85 * These are the properties declared in the model's own {@code <properties>} section.
86 * They are part of the artifact's published identity and are consulted for profile activation
87 * in all contexts, including repository-resolved (external) model builds. Unlike
88 * {@link #getUserProperties()}, these are never suppressed when evaluating dependency profiles.
89 *
90 * @return The project properties, never {@code null}.
91 */
92 Map<String, String> getProjectProperties();
93 }