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