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.eclipse.aether.util.graph.manager;
20
21 import java.util.Collection;
22 import java.util.Map;
23
24 import org.eclipse.aether.ConfigurationProperties;
25 import org.eclipse.aether.RepositorySystemSession;
26 import org.eclipse.aether.graph.DependencyNode;
27 import org.eclipse.aether.graph.Exclusion;
28
29 /**
30 * A utility class assisting in analyzing the effects of dependency management.
31 */
32 public final class DependencyManagerUtils {
33
34 /**
35 * The key in the repository session's {@link org.eclipse.aether.RepositorySystemSession#getConfigProperties()
36 * configuration properties} used to store a {@link Boolean} flag controlling the verbose mode for dependency
37 * management. If enabled, the original attributes of a dependency before its update due to dependency management
38 * will be recorded * in the node's {@link DependencyNode#getData() custom data} when building a dependency graph.
39 *
40 * @configurationSource {@link RepositorySystemSession#getConfigProperties()}
41 * @configurationType {@link java.lang.Boolean}
42 * @configurationDefaultValue false
43 */
44 public static final String CONFIG_PROP_VERBOSE =
45 ConfigurationProperties.PREFIX_AETHER + "dependencyManager.verbose";
46
47 /**
48 * The key in the dependency node's {@link DependencyNode#getData() custom data} under which the original version is
49 * stored.
50 */
51 public static final String NODE_DATA_PREMANAGED_VERSION = "premanaged.version";
52
53 /**
54 * The key in the dependency node's {@link DependencyNode#getData() custom data} under which the original scope is
55 * stored.
56 */
57 public static final String NODE_DATA_PREMANAGED_SCOPE = "premanaged.scope";
58
59 /**
60 * The key in the dependency node's {@link DependencyNode#getData() custom data} under which the original optional
61 * flag is stored.
62 */
63 public static final String NODE_DATA_PREMANAGED_OPTIONAL = "premanaged.optional";
64
65 /**
66 * The key in the dependency node's {@link DependencyNode#getData() custom data} under which the original exclusions
67 * are stored.
68 *
69 * @since 1.1.0
70 */
71 public static final String NODE_DATA_PREMANAGED_EXCLUSIONS = "premanaged.exclusions";
72
73 /**
74 * The key in the dependency node's {@link DependencyNode#getData() custom data} under which the original properties
75 * are stored.
76 *
77 * @since 1.1.0
78 */
79 public static final String NODE_DATA_PREMANAGED_PROPERTIES = "premanaged.properties";
80
81 /**
82 * Gets the version or version range of the specified dependency node before dependency management was applied (if
83 * any).
84 *
85 * @param node The dependency node to retrieve the premanaged data for, must not be {@code null}.
86 *
87 * @return The node's dependency version before dependency management or {@code null} if the version was not managed
88 * or if {@link #CONFIG_PROP_VERBOSE} was not enabled.
89 */
90 public static String getPremanagedVersion(DependencyNode node) {
91 if ((node.getManagedBits() & DependencyNode.MANAGED_VERSION) == 0) {
92 return null;
93 }
94 return cast(node.getData().get(NODE_DATA_PREMANAGED_VERSION), String.class);
95 }
96
97 /**
98 * Gets the scope of the specified dependency node before dependency management was applied (if any).
99 *
100 * @param node The dependency node to retrieve the premanaged data for, must not be {@code null}.
101 *
102 * @return The node's dependency scope before dependency management or {@code null} if the scope was not managed or
103 * if {@link #CONFIG_PROP_VERBOSE} was not enabled.
104 */
105 public static String getPremanagedScope(DependencyNode node) {
106 if ((node.getManagedBits() & DependencyNode.MANAGED_SCOPE) == 0) {
107 return null;
108 }
109 return cast(node.getData().get(NODE_DATA_PREMANAGED_SCOPE), String.class);
110 }
111
112 /**
113 * Gets the optional flag of the specified dependency node before dependency management was applied (if any).
114 *
115 * @param node The dependency node to retrieve the premanaged data for, must not be {@code null}.
116 *
117 * @return The node's optional flag before dependency management or {@code null} if the flag was not managed or if
118 * {@link #CONFIG_PROP_VERBOSE} was not enabled.
119 */
120 public static Boolean getPremanagedOptional(DependencyNode node) {
121 if ((node.getManagedBits() & DependencyNode.MANAGED_OPTIONAL) == 0) {
122 return null;
123 }
124 return cast(node.getData().get(NODE_DATA_PREMANAGED_OPTIONAL), Boolean.class);
125 }
126
127 /**
128 * Gets the {@code Exclusion}s of the specified dependency node before dependency management was applied (if any).
129 *
130 * @param node The dependency node to retrieve the premanaged data for, must not be {@code null}.
131 *
132 * @return The nodes' {@code Exclusion}s before dependency management or {@code null} if exclusions were not managed
133 * or if {@link #CONFIG_PROP_VERBOSE} was not enabled.
134 *
135 * @since 1.1.0
136 */
137 @SuppressWarnings("unchecked")
138 public static Collection<Exclusion> getPremanagedExclusions(DependencyNode node) {
139 if ((node.getManagedBits() & DependencyNode.MANAGED_EXCLUSIONS) == 0) {
140 return null;
141 }
142 return cast(node.getData().get(NODE_DATA_PREMANAGED_EXCLUSIONS), Collection.class);
143 }
144
145 /**
146 * Gets the properties of the specified dependency node before dependency management was applied (if any).
147 *
148 * @param node The dependency node to retrieve the premanaged data for, must not be {@code null}.
149 *
150 * @return The nodes' properties before dependency management or {@code null} if properties were not managed or if
151 * {@link #CONFIG_PROP_VERBOSE} was not enabled.
152 *
153 * @since 1.1.0
154 */
155 @SuppressWarnings("unchecked")
156 public static Map<String, String> getPremanagedProperties(DependencyNode node) {
157 if ((node.getManagedBits() & DependencyNode.MANAGED_PROPERTIES) == 0) {
158 return null;
159 }
160 return cast(node.getData().get(NODE_DATA_PREMANAGED_PROPERTIES), Map.class);
161 }
162
163 private static <T> T cast(Object obj, Class<T> type) {
164 return type.isInstance(obj) ? type.cast(obj) : null;
165 }
166 }