Modified:
maven/website/components/enforcer-archives/enforcer-LATEST/enforcer-rules/xref/org/apache/maven/enforcer/rules/dependency/BannedDependenciesBase.html
==============================================================================
---
maven/website/components/enforcer-archives/enforcer-LATEST/enforcer-rules/xref/org/apache/maven/enforcer/rules/dependency/BannedDependenciesBase.html
(original)
+++
maven/website/components/enforcer-archives/enforcer-LATEST/enforcer-rules/xref/org/apache/maven/enforcer/rules/dependency/BannedDependenciesBase.html
Sat Apr 1 21:10:25 2023
@@ -26,193 +26,194 @@
<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em
class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong
class="jxr_keyword">package</strong> org.apache.maven.enforcer.rules.dependency;
<a class="jxr_linenumber" name="L20" href="#L20">20</a>
-<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong
class="jxr_keyword">import</strong> java.util.List;
-<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong
class="jxr_keyword">import</strong> java.util.Objects;
-<a class="jxr_linenumber" name="L23" href="#L23">23</a>
-<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong
class="jxr_keyword">import</strong> org.apache.commons.lang3.StringUtils;
-<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.artifact.Artifact;
-<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.enforcer.rule.api.EnforcerRuleException;
-<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.enforcer.rules.AbstractStandardEnforcerRule;
-<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.enforcer.rules.utils.ArtifactUtils;
-<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.execution.MavenSession;
-<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong
class="jxr_keyword">import</strong> org.eclipse.aether.graph.DependencyNode;
-<a class="jxr_linenumber" name="L31" href="#L31">31</a>
-<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em
class="jxr_javadoccomment"> * Abstract base class for rules which validate the
transitive</em>
-<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em
class="jxr_javadoccomment"> * dependency tree by traversing all children and
validating every</em>
-<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em
class="jxr_javadoccomment"> * dependency artifact.</em>
-<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong
class="jxr_keyword">abstract</strong> <strong
class="jxr_keyword">class</strong> <a name="BannedDependenciesBase"
href="../../../../../../org/apache/maven/enforcer/rules/dependency/BannedDependenciesBase.html#BannedDependenciesBase">BannedDependenciesBase</a>
<strong class="jxr_keyword">extends</strong> <a
name="AbstractStandardEnforcerRule"
href="../../../../../../org/apache/maven/enforcer/rules/AbstractStandardEnforcerRule.html#AbstractStandardEnforcerRule">AbstractStandardEnforcerRule</a>
{
-<a class="jxr_linenumber" name="L38" href="#L38">38</a>
-<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em
class="jxr_javadoccomment"> * Specify the banned dependencies. This can be
a list of artifacts in the format</em>
-<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em
class="jxr_javadoccomment"> *
<code>groupId[:artifactId][:version]</code>. Any of the sections
can be a wildcard</em>
-<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em
class="jxr_javadoccomment"> * by using '*' (ie group:*:1.0) <br></em>
-<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em
class="jxr_javadoccomment"> * The rule will fail if any dependency matches
any exclude, unless it also matches</em>
-<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em
class="jxr_javadoccomment"> * an include rule.</em>
-<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em
class="jxr_javadoccomment"> * @see #setExcludes(List)</em>
-<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em
class="jxr_javadoccomment"> * @see #getExcludes()</em>
-<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong
class="jxr_keyword">private</strong> List<String> excludes = <strong
class="jxr_keyword">null</strong>;
-<a class="jxr_linenumber" name="L50" href="#L50">50</a>
-<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em
class="jxr_javadoccomment"> * Specify the allowed dependencies. This can be
a list of artifacts in the format</em>
-<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em
class="jxr_javadoccomment"> *
<code>groupId[:artifactId][:version]</code>. Any of the sections
can be a wildcard</em>
-<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em
class="jxr_javadoccomment"> * by using '*' (ie group:*:1.0) <br></em>
-<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em
class="jxr_javadoccomment"> * Includes override the exclude rules. It is
meant to allow wide exclusion rules</em>
-<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em
class="jxr_javadoccomment"> * with wildcards and still allow a</em>
-<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em
class="jxr_javadoccomment"> * smaller set of includes. <br></em>
-<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em
class="jxr_javadoccomment"> * For example, to ban all xerces except
xerces-api -&gt; exclude "xerces", include "xerces:xerces-api"</em>
-<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em
class="jxr_javadoccomment"> * @see #setIncludes(List)</em>
-<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em
class="jxr_javadoccomment"> * @see #getIncludes()</em>
-<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong
class="jxr_keyword">private</strong> List<String> includes = <strong
class="jxr_keyword">null</strong>;
-<a class="jxr_linenumber" name="L64" href="#L64">64</a>
-<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em
class="jxr_javadoccomment">/** Specify if transitive dependencies should be
searched (default) or only look at direct dependencies. */</em>
-<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">boolean</strong> searchTransitive = <strong
class="jxr_keyword">true</strong>;
-<a class="jxr_linenumber" name="L67" href="#L67">67</a>
-<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong
class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong>
MavenSession session;
-<a class="jxr_linenumber" name="L69" href="#L69">69</a>
-<a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong
class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong>
<a name="ResolveUtil"
href="../../../../../../org/apache/maven/enforcer/rules/dependency/ResolveUtil.html#ResolveUtil">ResolveUtil</a>
resolveUtil;
-<a class="jxr_linenumber" name="L71" href="#L71">71</a>
-<a class="jxr_linenumber" name="L72" href="#L72">72</a> <a
name="BannedDependenciesBase"
href="../../../../../../org/apache/maven/enforcer/rules/dependency/BannedDependenciesBase.html#BannedDependenciesBase">BannedDependenciesBase</a>(MavenSession
session, <a name="ResolveUtil"
href="../../../../../../org/apache/maven/enforcer/rules/dependency/ResolveUtil.html#ResolveUtil">ResolveUtil</a>
resolveUtil) {
-<a class="jxr_linenumber" name="L73" href="#L73">73</a> <strong
class="jxr_keyword">this</strong>.session = Objects.requireNonNull(session);
-<a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong
class="jxr_keyword">this</strong>.resolveUtil =
Objects.requireNonNull(resolveUtil);
-<a class="jxr_linenumber" name="L75" href="#L75">75</a> }
-<a class="jxr_linenumber" name="L76" href="#L76">76</a>
-<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong
class="jxr_keyword">protected</strong> MavenSession getSession() {
-<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong
class="jxr_keyword">return</strong> session;
-<a class="jxr_linenumber" name="L79" href="#L79">79</a> }
-<a class="jxr_linenumber" name="L80" href="#L80">80</a>
-<a class="jxr_linenumber" name="L81" href="#L81">81</a> @Override
-<a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong>
execute() <strong class="jxr_keyword">throws</strong> EnforcerRuleException {
-<a class="jxr_linenumber" name="L83" href="#L83">83</a>
-<a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong
class="jxr_keyword">if</strong> (!searchTransitive) {
-<a class="jxr_linenumber" name="L85" href="#L85">85</a> String
result = session.getCurrentProject().getDependencyArtifacts().stream()
-<a class="jxr_linenumber" name="L86" href="#L86">86</a>
.filter(a -> !validate(a))
-<a class="jxr_linenumber" name="L87" href="#L87">87</a>
.collect(
-<a class="jxr_linenumber" name="L88" href="#L88">88</a>
StringBuilder::<strong class="jxr_keyword">new</strong>,
-<a class="jxr_linenumber" name="L89" href="#L89">89</a>
(messageBuilder, node) -> messageBuilder
-<a class="jxr_linenumber" name="L90" href="#L90">90</a>
.append(System.lineSeparator())
-<a class="jxr_linenumber" name="L91" href="#L91">91</a>
.append(node.getId())
-<a class="jxr_linenumber" name="L92" href="#L92">92</a>
.append(<span class="jxr_string">" <--- "</span>)
-<a class="jxr_linenumber" name="L93" href="#L93">93</a>
.append(getErrorMessage()),
-<a class="jxr_linenumber" name="L94" href="#L94">94</a>
(m1, m2) -> m1.append(m2.toString()))
-<a class="jxr_linenumber" name="L95" href="#L95">95</a>
.toString();
-<a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong
class="jxr_keyword">if</strong> (!result.isEmpty()) {
-<a class="jxr_linenumber" name="L97" href="#L97">97</a>
String message = <span class="jxr_string">""</span>;
-<a class="jxr_linenumber" name="L98" href="#L98">98</a>
<strong class="jxr_keyword">if</strong> (getMessage() != <strong
class="jxr_keyword">null</strong>) {
-<a class="jxr_linenumber" name="L99" href="#L99">99</a>
message = getMessage() + System.lineSeparator();
-<a class="jxr_linenumber" name="L100" href="#L100">100</a> }
-<a class="jxr_linenumber" name="L101" href="#L101">101</a>
<strong class="jxr_keyword">throw</strong> <strong
class="jxr_keyword">new</strong> EnforcerRuleException(message + result);
-<a class="jxr_linenumber" name="L102" href="#L102">102</a> }
-<a class="jxr_linenumber" name="L103" href="#L103">103</a> } <strong
class="jxr_keyword">else</strong> {
-<a class="jxr_linenumber" name="L104" href="#L104">104</a>
StringBuilder messageBuilder = <strong class="jxr_keyword">new</strong>
StringBuilder();
-<a class="jxr_linenumber" name="L105" href="#L105">105</a>
DependencyNode rootNode = resolveUtil.resolveTransitiveDependencies();
-<a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong
class="jxr_keyword">if</strong> (!validate(rootNode, 0, messageBuilder)) {
-<a class="jxr_linenumber" name="L107" href="#L107">107</a>
String message = <span class="jxr_string">""</span>;
-<a class="jxr_linenumber" name="L108" href="#L108">108</a>
<strong class="jxr_keyword">if</strong> (getMessage() != <strong
class="jxr_keyword">null</strong>) {
-<a class="jxr_linenumber" name="L109" href="#L109">109</a>
message = getMessage() + System.lineSeparator();
-<a class="jxr_linenumber" name="L110" href="#L110">110</a> }
-<a class="jxr_linenumber" name="L111" href="#L111">111</a>
<strong class="jxr_keyword">throw</strong> <strong
class="jxr_keyword">new</strong> EnforcerRuleException(message +
messageBuilder);
-<a class="jxr_linenumber" name="L112" href="#L112">112</a> }
-<a class="jxr_linenumber" name="L113" href="#L113">113</a> }
-<a class="jxr_linenumber" name="L114" href="#L114">114</a> }
-<a class="jxr_linenumber" name="L115" href="#L115">115</a>
-<a class="jxr_linenumber" name="L116" href="#L116">116</a> <strong
class="jxr_keyword">protected</strong> <strong
class="jxr_keyword">boolean</strong> validate(DependencyNode node, <strong
class="jxr_keyword">int</strong> level, StringBuilder messageBuilder) {
-<a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong
class="jxr_keyword">boolean</strong> rootFailed = level > 0 &&
!validate(ArtifactUtils.toArtifact(node));
-<a class="jxr_linenumber" name="L118" href="#L118">118</a>
StringBuilder childMessageBuilder = <strong class="jxr_keyword">new</strong>
StringBuilder();
-<a class="jxr_linenumber" name="L119" href="#L119">119</a> <strong
class="jxr_keyword">if</strong> (rootFailed
-<a class="jxr_linenumber" name="L120" href="#L120">120</a> ||
!node.getChildren().stream()
-<a class="jxr_linenumber" name="L121" href="#L121">121</a>
.map(childNode -> validate(childNode, level + 1, childMessageBuilder))
-<a class="jxr_linenumber" name="L122" href="#L122">122</a>
.reduce(<strong class="jxr_keyword">true</strong>, Boolean::logicalAnd)) {
-<a class="jxr_linenumber" name="L123" href="#L123">123</a>
messageBuilder
-<a class="jxr_linenumber" name="L124" href="#L124">124</a>
.append(StringUtils.repeat(<span class="jxr_string">" "</span>, level))
-<a class="jxr_linenumber" name="L125" href="#L125">125</a>
.append(ArtifactUtils.toArtifact(node).getId());
-<a class="jxr_linenumber" name="L126" href="#L126">126</a> <strong
class="jxr_keyword">if</strong> (rootFailed) {
-<a class="jxr_linenumber" name="L127" href="#L127">127</a>
messageBuilder.append(<span class="jxr_string">" <---
"</span>).append(getErrorMessage());
-<a class="jxr_linenumber" name="L128" href="#L128">128</a> }
-<a class="jxr_linenumber" name="L129" href="#L129">129</a>
messageBuilder.append(System.lineSeparator()).append(childMessageBuilder);
-<a class="jxr_linenumber" name="L130" href="#L130">130</a> <strong
class="jxr_keyword">return</strong> false;
-<a class="jxr_linenumber" name="L131" href="#L131">131</a> }
-<a class="jxr_linenumber" name="L132" href="#L132">132</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
-<a class="jxr_linenumber" name="L133" href="#L133">133</a> }
-<a class="jxr_linenumber" name="L134" href="#L134">134</a>
-<a class="jxr_linenumber" name="L135" href="#L135">135</a> <strong
class="jxr_keyword">protected</strong> <strong
class="jxr_keyword">abstract</strong> String getErrorMessage();
-<a class="jxr_linenumber" name="L136" href="#L136">136</a>
-<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em
class="jxr_javadoccomment"> * Validates a dependency artifact if it
fulfills the enforcer rule</em>
-<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em
class="jxr_javadoccomment"> * @param dependency dependency to be checked
against the list of excludes</em>
-<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em
class="jxr_javadoccomment"> * @return {@code true} if the dependency
<b>passes</b> the rule, {@code false} if the dependency</em>
-<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em
class="jxr_javadoccomment"> * triggers a validation error</em>
-<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L144" href="#L144">144</a> <strong
class="jxr_keyword">protected</strong> <strong
class="jxr_keyword">abstract</strong> <strong
class="jxr_keyword">boolean</strong> validate(Artifact dependency);
-<a class="jxr_linenumber" name="L145" href="#L145">145</a>
-<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em
class="jxr_javadoccomment"> * Sets the search transitive.</em>
-<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em
class="jxr_javadoccomment"> * @param theSearchTransitive the
searchTransitive to set</em>
-<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L151" href="#L151">151</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong>
setSearchTransitive(<strong class="jxr_keyword">boolean</strong>
theSearchTransitive) {
-<a class="jxr_linenumber" name="L152" href="#L152">152</a> <strong
class="jxr_keyword">this</strong>.searchTransitive = theSearchTransitive;
-<a class="jxr_linenumber" name="L153" href="#L153">153</a> }
-<a class="jxr_linenumber" name="L154" href="#L154">154</a>
-<a class="jxr_linenumber" name="L155" href="#L155">155</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em
class="jxr_javadoccomment"> * Gets the excludes.</em>
-<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L158" href="#L158">158</a> <em
class="jxr_javadoccomment"> * @return the excludes</em>
-<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L160" href="#L160">160</a> <strong
class="jxr_keyword">public</strong> List<String> getExcludes() {
-<a class="jxr_linenumber" name="L161" href="#L161">161</a> <strong
class="jxr_keyword">return</strong> <strong
class="jxr_keyword">this</strong>.excludes;
-<a class="jxr_linenumber" name="L162" href="#L162">162</a> }
-<a class="jxr_linenumber" name="L163" href="#L163">163</a>
-<a class="jxr_linenumber" name="L164" href="#L164">164</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L165" href="#L165">165</a> <em
class="jxr_javadoccomment"> * Specify the banned dependencies. This can be
a list of artifacts in the format</em>
-<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em
class="jxr_javadoccomment"> *
<code>groupId[:artifactId][:version]</code>. Any of the sections
can be a wildcard</em>
-<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em
class="jxr_javadoccomment"> * by using '*' (ie group:*:1.0) <br></em>
-<a class="jxr_linenumber" name="L168" href="#L168">168</a> <em
class="jxr_javadoccomment"> * The rule will fail if any dependency matches
any exclude, unless it also matches an</em>
-<a class="jxr_linenumber" name="L169" href="#L169">169</a> <em
class="jxr_javadoccomment"> * include rule.</em>
-<a class="jxr_linenumber" name="L170" href="#L170">170</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L171" href="#L171">171</a> <em
class="jxr_javadoccomment"> * @see #getExcludes()</em>
-<a class="jxr_linenumber" name="L172" href="#L172">172</a> <em
class="jxr_javadoccomment"> * @param theExcludes the excludes to set</em>
-<a class="jxr_linenumber" name="L173" href="#L173">173</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L174" href="#L174">174</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong>
setExcludes(List<String> theExcludes) {
-<a class="jxr_linenumber" name="L175" href="#L175">175</a> <strong
class="jxr_keyword">this</strong>.excludes = theExcludes;
-<a class="jxr_linenumber" name="L176" href="#L176">176</a> }
-<a class="jxr_linenumber" name="L177" href="#L177">177</a>
-<a class="jxr_linenumber" name="L178" href="#L178">178</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L179" href="#L179">179</a> <em
class="jxr_javadoccomment"> * Gets the includes.</em>
-<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L181" href="#L181">181</a> <em
class="jxr_javadoccomment"> * @return the includes</em>
-<a class="jxr_linenumber" name="L182" href="#L182">182</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L183" href="#L183">183</a> <strong
class="jxr_keyword">public</strong> List<String> getIncludes() {
-<a class="jxr_linenumber" name="L184" href="#L184">184</a> <strong
class="jxr_keyword">return</strong> <strong
class="jxr_keyword">this</strong>.includes;
-<a class="jxr_linenumber" name="L185" href="#L185">185</a> }
-<a class="jxr_linenumber" name="L186" href="#L186">186</a>
-<a class="jxr_linenumber" name="L187" href="#L187">187</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L188" href="#L188">188</a> <em
class="jxr_javadoccomment"> * Specify the allowed dependencies. This can be
a list of artifacts in the format</em>
-<a class="jxr_linenumber" name="L189" href="#L189">189</a> <em
class="jxr_javadoccomment"> *
<code>groupId[:artifactId][:version]</code>. Any of the sections
can be a wildcard</em>
-<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em
class="jxr_javadoccomment"> * by using '*' (ie group:*:1.0) <br></em>
-<a class="jxr_linenumber" name="L191" href="#L191">191</a> <em
class="jxr_javadoccomment"> * Includes override the exclude rules. It is
meant to allow wide exclusion rules with</em>
-<a class="jxr_linenumber" name="L192" href="#L192">192</a> <em
class="jxr_javadoccomment"> * wildcards and still allow a</em>
-<a class="jxr_linenumber" name="L193" href="#L193">193</a> <em
class="jxr_javadoccomment"> * smaller set of includes. <br></em>
-<a class="jxr_linenumber" name="L194" href="#L194">194</a> <em
class="jxr_javadoccomment"> * For example, to ban all xerces except
xerces-api â exclude "xerces",</em>
-<a class="jxr_linenumber" name="L195" href="#L195">195</a> <em
class="jxr_javadoccomment"> * include "xerces:xerces-api"</em>
-<a class="jxr_linenumber" name="L196" href="#L196">196</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L197" href="#L197">197</a> <em
class="jxr_javadoccomment"> * @see #setIncludes(List)</em>
-<a class="jxr_linenumber" name="L198" href="#L198">198</a> <em
class="jxr_javadoccomment"> * @param theIncludes the includes to set</em>
-<a class="jxr_linenumber" name="L199" href="#L199">199</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L200" href="#L200">200</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong>
setIncludes(List<String> theIncludes) {
-<a class="jxr_linenumber" name="L201" href="#L201">201</a> <strong
class="jxr_keyword">this</strong>.includes = theIncludes;
-<a class="jxr_linenumber" name="L202" href="#L202">202</a> }
-<a class="jxr_linenumber" name="L203" href="#L203">203</a>
-<a class="jxr_linenumber" name="L204" href="#L204">204</a> <strong
class="jxr_keyword">public</strong> <strong
class="jxr_keyword">boolean</strong> isSearchTransitive() {
-<a class="jxr_linenumber" name="L205" href="#L205">205</a> <strong
class="jxr_keyword">return</strong> searchTransitive;
-<a class="jxr_linenumber" name="L206" href="#L206">206</a> }
-<a class="jxr_linenumber" name="L207" href="#L207">207</a> }
+<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong
class="jxr_keyword">import</strong> java.util.Collections;
+<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong
class="jxr_keyword">import</strong> java.util.List;
+<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong
class="jxr_keyword">import</strong> java.util.Objects;
+<a class="jxr_linenumber" name="L24" href="#L24">24</a>
+<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong
class="jxr_keyword">import</strong> org.apache.commons.lang3.StringUtils;
+<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.artifact.Artifact;
+<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.enforcer.rule.api.EnforcerRuleException;
+<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.enforcer.rules.AbstractStandardEnforcerRule;
+<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.enforcer.rules.utils.ArtifactUtils;
+<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong
class="jxr_keyword">import</strong> org.apache.maven.execution.MavenSession;
+<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong
class="jxr_keyword">import</strong> org.eclipse.aether.graph.DependencyNode;
+<a class="jxr_linenumber" name="L32" href="#L32">32</a>
+<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em
class="jxr_javadoccomment"> * Abstract base class for rules which validate the
transitive</em>
+<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em
class="jxr_javadoccomment"> * dependency tree by traversing all children and
validating every</em>
+<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em
class="jxr_javadoccomment"> * dependency artifact.</em>
+<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong
class="jxr_keyword">abstract</strong> <strong
class="jxr_keyword">class</strong> <a name="BannedDependenciesBase"
href="../../../../../../org/apache/maven/enforcer/rules/dependency/BannedDependenciesBase.html#BannedDependenciesBase">BannedDependenciesBase</a>
<strong class="jxr_keyword">extends</strong> <a
name="AbstractStandardEnforcerRule"
href="../../../../../../org/apache/maven/enforcer/rules/AbstractStandardEnforcerRule.html#AbstractStandardEnforcerRule">AbstractStandardEnforcerRule</a>
{
+<a class="jxr_linenumber" name="L39" href="#L39">39</a>
+<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em
class="jxr_javadoccomment"> * Specify the banned dependencies. This can be
a list of artifacts in the format</em>
+<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em
class="jxr_javadoccomment"> *
<code>groupId[:artifactId][:version]</code>. Any of the sections
can be a wildcard</em>
+<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em
class="jxr_javadoccomment"> * by using '*' (ie group:*:1.0) <br></em>
+<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em
class="jxr_javadoccomment"> * The rule will fail if any dependency matches
any exclude, unless it also matches</em>
+<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em
class="jxr_javadoccomment"> * an include rule.</em>
+<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em
class="jxr_javadoccomment"> * @see #setExcludes(List)</em>
+<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em
class="jxr_javadoccomment"> * @see #getExcludes()</em>
+<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong
class="jxr_keyword">private</strong> List<String> excludes = <strong
class="jxr_keyword">null</strong>;
+<a class="jxr_linenumber" name="L51" href="#L51">51</a>
+<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em
class="jxr_javadoccomment"> * Specify the allowed dependencies. This can be
a list of artifacts in the format</em>
+<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em
class="jxr_javadoccomment"> *
<code>groupId[:artifactId][:version]</code>. Any of the sections
can be a wildcard</em>
+<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em
class="jxr_javadoccomment"> * by using '*' (ie group:*:1.0) <br></em>
+<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em
class="jxr_javadoccomment"> * Includes override the exclude rules. It is
meant to allow wide exclusion rules</em>
+<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em
class="jxr_javadoccomment"> * with wildcards and still allow a</em>
+<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em
class="jxr_javadoccomment"> * smaller set of includes. <br></em>
+<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em
class="jxr_javadoccomment"> * For example, to ban all xerces except
xerces-api -&gt; exclude "xerces", include "xerces:xerces-api"</em>
+<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em
class="jxr_javadoccomment"> * @see #setIncludes(List)</em>
+<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em
class="jxr_javadoccomment"> * @see #getIncludes()</em>
+<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L64" href="#L64">64</a> <strong
class="jxr_keyword">private</strong> List<String> includes = <strong
class="jxr_keyword">null</strong>;
+<a class="jxr_linenumber" name="L65" href="#L65">65</a>
+<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em
class="jxr_javadoccomment">/** Specify if transitive dependencies should be
searched (default) or only look at direct dependencies. */</em>
+<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">boolean</strong> searchTransitive = <strong
class="jxr_keyword">true</strong>;
+<a class="jxr_linenumber" name="L68" href="#L68">68</a>
+<a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong
class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong>
MavenSession session;
+<a class="jxr_linenumber" name="L70" href="#L70">70</a>
+<a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong
class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong>
<a name="ResolverUtil"
href="../../../../../../org/apache/maven/enforcer/rules/dependency/ResolverUtil.html#ResolverUtil">ResolverUtil</a>
resolverUtil;
+<a class="jxr_linenumber" name="L72" href="#L72">72</a>
+<a class="jxr_linenumber" name="L73" href="#L73">73</a> <a
name="BannedDependenciesBase"
href="../../../../../../org/apache/maven/enforcer/rules/dependency/BannedDependenciesBase.html#BannedDependenciesBase">BannedDependenciesBase</a>(MavenSession
session, <a name="ResolverUtil"
href="../../../../../../org/apache/maven/enforcer/rules/dependency/ResolverUtil.html#ResolverUtil">ResolverUtil</a>
resolverUtil) {
+<a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong
class="jxr_keyword">this</strong>.session = Objects.requireNonNull(session);
+<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong
class="jxr_keyword">this</strong>.resolverUtil =
Objects.requireNonNull(resolverUtil);
+<a class="jxr_linenumber" name="L76" href="#L76">76</a> }
+<a class="jxr_linenumber" name="L77" href="#L77">77</a>
+<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong
class="jxr_keyword">protected</strong> MavenSession getSession() {
+<a class="jxr_linenumber" name="L79" href="#L79">79</a> <strong
class="jxr_keyword">return</strong> session;
+<a class="jxr_linenumber" name="L80" href="#L80">80</a> }
+<a class="jxr_linenumber" name="L81" href="#L81">81</a>
+<a class="jxr_linenumber" name="L82" href="#L82">82</a> @Override
+<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong>
execute() <strong class="jxr_keyword">throws</strong> EnforcerRuleException {
+<a class="jxr_linenumber" name="L84" href="#L84">84</a>
+<a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong
class="jxr_keyword">if</strong> (!searchTransitive) {
+<a class="jxr_linenumber" name="L86" href="#L86">86</a> String
result = session.getCurrentProject().getDependencyArtifacts().stream()
+<a class="jxr_linenumber" name="L87" href="#L87">87</a>
.filter(a -> !validate(a))
+<a class="jxr_linenumber" name="L88" href="#L88">88</a>
.collect(
+<a class="jxr_linenumber" name="L89" href="#L89">89</a>
StringBuilder::<strong class="jxr_keyword">new</strong>,
+<a class="jxr_linenumber" name="L90" href="#L90">90</a>
(messageBuilder, node) -> messageBuilder
+<a class="jxr_linenumber" name="L91" href="#L91">91</a>
.append(System.lineSeparator())
+<a class="jxr_linenumber" name="L92" href="#L92">92</a>
.append(node.getId())
+<a class="jxr_linenumber" name="L93" href="#L93">93</a>
.append(<span class="jxr_string">" <--- "</span>)
+<a class="jxr_linenumber" name="L94" href="#L94">94</a>
.append(getErrorMessage()),
+<a class="jxr_linenumber" name="L95" href="#L95">95</a>
(m1, m2) -> m1.append(m2.toString()))
+<a class="jxr_linenumber" name="L96" href="#L96">96</a>
.toString();
+<a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong
class="jxr_keyword">if</strong> (!result.isEmpty()) {
+<a class="jxr_linenumber" name="L98" href="#L98">98</a>
String message = <span class="jxr_string">""</span>;
+<a class="jxr_linenumber" name="L99" href="#L99">99</a>
<strong class="jxr_keyword">if</strong> (getMessage() != <strong
class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="L100" href="#L100">100</a>
message = getMessage() + System.lineSeparator();
+<a class="jxr_linenumber" name="L101" href="#L101">101</a> }
+<a class="jxr_linenumber" name="L102" href="#L102">102</a>
<strong class="jxr_keyword">throw</strong> <strong
class="jxr_keyword">new</strong> EnforcerRuleException(message + result);
+<a class="jxr_linenumber" name="L103" href="#L103">103</a> }
+<a class="jxr_linenumber" name="L104" href="#L104">104</a> } <strong
class="jxr_keyword">else</strong> {
+<a class="jxr_linenumber" name="L105" href="#L105">105</a>
StringBuilder messageBuilder = <strong class="jxr_keyword">new</strong>
StringBuilder();
+<a class="jxr_linenumber" name="L106" href="#L106">106</a>
DependencyNode rootNode =
resolverUtil.resolveTransitiveDependenciesVerbose(Collections.emptyList());
+<a class="jxr_linenumber" name="L107" href="#L107">107</a> <strong
class="jxr_keyword">if</strong> (!validate(rootNode, 0, messageBuilder)) {
+<a class="jxr_linenumber" name="L108" href="#L108">108</a>
String message = <span class="jxr_string">""</span>;
+<a class="jxr_linenumber" name="L109" href="#L109">109</a>
<strong class="jxr_keyword">if</strong> (getMessage() != <strong
class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="L110" href="#L110">110</a>
message = getMessage() + System.lineSeparator();
+<a class="jxr_linenumber" name="L111" href="#L111">111</a> }
+<a class="jxr_linenumber" name="L112" href="#L112">112</a>
<strong class="jxr_keyword">throw</strong> <strong
class="jxr_keyword">new</strong> EnforcerRuleException(message +
messageBuilder);
+<a class="jxr_linenumber" name="L113" href="#L113">113</a> }
+<a class="jxr_linenumber" name="L114" href="#L114">114</a> }
+<a class="jxr_linenumber" name="L115" href="#L115">115</a> }
+<a class="jxr_linenumber" name="L116" href="#L116">116</a>
+<a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong
class="jxr_keyword">protected</strong> <strong
class="jxr_keyword">boolean</strong> validate(DependencyNode node, <strong
class="jxr_keyword">int</strong> level, StringBuilder messageBuilder) {
+<a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong
class="jxr_keyword">boolean</strong> rootFailed = level > 0 &&
!validate(ArtifactUtils.toArtifact(node));
+<a class="jxr_linenumber" name="L119" href="#L119">119</a>
StringBuilder childMessageBuilder = <strong class="jxr_keyword">new</strong>
StringBuilder();
+<a class="jxr_linenumber" name="L120" href="#L120">120</a> <strong
class="jxr_keyword">if</strong> (rootFailed
+<a class="jxr_linenumber" name="L121" href="#L121">121</a> ||
!node.getChildren().stream()
+<a class="jxr_linenumber" name="L122" href="#L122">122</a>
.map(childNode -> validate(childNode, level + 1, childMessageBuilder))
+<a class="jxr_linenumber" name="L123" href="#L123">123</a>
.reduce(<strong class="jxr_keyword">true</strong>, Boolean::logicalAnd)) {
+<a class="jxr_linenumber" name="L124" href="#L124">124</a>
messageBuilder
+<a class="jxr_linenumber" name="L125" href="#L125">125</a>
.append(StringUtils.repeat(<span class="jxr_string">" "</span>, level))
+<a class="jxr_linenumber" name="L126" href="#L126">126</a>
.append(ArtifactUtils.toArtifact(node).getId());
+<a class="jxr_linenumber" name="L127" href="#L127">127</a> <strong
class="jxr_keyword">if</strong> (rootFailed) {
+<a class="jxr_linenumber" name="L128" href="#L128">128</a>
messageBuilder.append(<span class="jxr_string">" <---
"</span>).append(getErrorMessage());
+<a class="jxr_linenumber" name="L129" href="#L129">129</a> }
+<a class="jxr_linenumber" name="L130" href="#L130">130</a>
messageBuilder.append(System.lineSeparator()).append(childMessageBuilder);
+<a class="jxr_linenumber" name="L131" href="#L131">131</a> <strong
class="jxr_keyword">return</strong> false;
+<a class="jxr_linenumber" name="L132" href="#L132">132</a> }
+<a class="jxr_linenumber" name="L133" href="#L133">133</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
+<a class="jxr_linenumber" name="L134" href="#L134">134</a> }
+<a class="jxr_linenumber" name="L135" href="#L135">135</a>
+<a class="jxr_linenumber" name="L136" href="#L136">136</a> <strong
class="jxr_keyword">protected</strong> <strong
class="jxr_keyword">abstract</strong> String getErrorMessage();
+<a class="jxr_linenumber" name="L137" href="#L137">137</a>
+<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em
class="jxr_javadoccomment"> * Validates a dependency artifact if it
fulfills the enforcer rule</em>
+<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em
class="jxr_javadoccomment"> * @param dependency dependency to be checked
against the list of excludes</em>
+<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em
class="jxr_javadoccomment"> * @return {@code true} if the dependency
<b>passes</b> the rule, {@code false} if the dependency</em>
+<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em
class="jxr_javadoccomment"> * triggers a validation error</em>
+<a class="jxr_linenumber" name="L144" href="#L144">144</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L145" href="#L145">145</a> <strong
class="jxr_keyword">protected</strong> <strong
class="jxr_keyword">abstract</strong> <strong
class="jxr_keyword">boolean</strong> validate(Artifact dependency);
+<a class="jxr_linenumber" name="L146" href="#L146">146</a>
+<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em
class="jxr_javadoccomment"> * Sets the search transitive.</em>
+<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em
class="jxr_javadoccomment"> * @param theSearchTransitive the
searchTransitive to set</em>
+<a class="jxr_linenumber" name="L151" href="#L151">151</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L152" href="#L152">152</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong>
setSearchTransitive(<strong class="jxr_keyword">boolean</strong>
theSearchTransitive) {
+<a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong
class="jxr_keyword">this</strong>.searchTransitive = theSearchTransitive;
+<a class="jxr_linenumber" name="L154" href="#L154">154</a> }
+<a class="jxr_linenumber" name="L155" href="#L155">155</a>
+<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em
class="jxr_javadoccomment"> * Gets the excludes.</em>
+<a class="jxr_linenumber" name="L158" href="#L158">158</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em
class="jxr_javadoccomment"> * @return the excludes</em>
+<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L161" href="#L161">161</a> <strong
class="jxr_keyword">public</strong> List<String> getExcludes() {
+<a class="jxr_linenumber" name="L162" href="#L162">162</a> <strong
class="jxr_keyword">return</strong> <strong
class="jxr_keyword">this</strong>.excludes;
+<a class="jxr_linenumber" name="L163" href="#L163">163</a> }
+<a class="jxr_linenumber" name="L164" href="#L164">164</a>
+<a class="jxr_linenumber" name="L165" href="#L165">165</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em
class="jxr_javadoccomment"> * Specify the banned dependencies. This can be
a list of artifacts in the format</em>
+<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em
class="jxr_javadoccomment"> *
<code>groupId[:artifactId][:version]</code>. Any of the sections
can be a wildcard</em>
+<a class="jxr_linenumber" name="L168" href="#L168">168</a> <em
class="jxr_javadoccomment"> * by using '*' (ie group:*:1.0) <br></em>
+<a class="jxr_linenumber" name="L169" href="#L169">169</a> <em
class="jxr_javadoccomment"> * The rule will fail if any dependency matches
any exclude, unless it also matches an</em>
+<a class="jxr_linenumber" name="L170" href="#L170">170</a> <em
class="jxr_javadoccomment"> * include rule.</em>
+<a class="jxr_linenumber" name="L171" href="#L171">171</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L172" href="#L172">172</a> <em
class="jxr_javadoccomment"> * @see #getExcludes()</em>
+<a class="jxr_linenumber" name="L173" href="#L173">173</a> <em
class="jxr_javadoccomment"> * @param theExcludes the excludes to set</em>
+<a class="jxr_linenumber" name="L174" href="#L174">174</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L175" href="#L175">175</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong>
setExcludes(List<String> theExcludes) {
+<a class="jxr_linenumber" name="L176" href="#L176">176</a> <strong
class="jxr_keyword">this</strong>.excludes = theExcludes;
+<a class="jxr_linenumber" name="L177" href="#L177">177</a> }
+<a class="jxr_linenumber" name="L178" href="#L178">178</a>
+<a class="jxr_linenumber" name="L179" href="#L179">179</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em
class="jxr_javadoccomment"> * Gets the includes.</em>
+<a class="jxr_linenumber" name="L181" href="#L181">181</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L182" href="#L182">182</a> <em
class="jxr_javadoccomment"> * @return the includes</em>
+<a class="jxr_linenumber" name="L183" href="#L183">183</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L184" href="#L184">184</a> <strong
class="jxr_keyword">public</strong> List<String> getIncludes() {
+<a class="jxr_linenumber" name="L185" href="#L185">185</a> <strong
class="jxr_keyword">return</strong> <strong
class="jxr_keyword">this</strong>.includes;
+<a class="jxr_linenumber" name="L186" href="#L186">186</a> }
+<a class="jxr_linenumber" name="L187" href="#L187">187</a>
+<a class="jxr_linenumber" name="L188" href="#L188">188</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L189" href="#L189">189</a> <em
class="jxr_javadoccomment"> * Specify the allowed dependencies. This can be
a list of artifacts in the format</em>
+<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em
class="jxr_javadoccomment"> *
<code>groupId[:artifactId][:version]</code>. Any of the sections
can be a wildcard</em>
+<a class="jxr_linenumber" name="L191" href="#L191">191</a> <em
class="jxr_javadoccomment"> * by using '*' (ie group:*:1.0) <br></em>
+<a class="jxr_linenumber" name="L192" href="#L192">192</a> <em
class="jxr_javadoccomment"> * Includes override the exclude rules. It is
meant to allow wide exclusion rules with</em>
+<a class="jxr_linenumber" name="L193" href="#L193">193</a> <em
class="jxr_javadoccomment"> * wildcards and still allow a</em>
+<a class="jxr_linenumber" name="L194" href="#L194">194</a> <em
class="jxr_javadoccomment"> * smaller set of includes. <br></em>
+<a class="jxr_linenumber" name="L195" href="#L195">195</a> <em
class="jxr_javadoccomment"> * For example, to ban all xerces except
xerces-api â exclude "xerces",</em>
+<a class="jxr_linenumber" name="L196" href="#L196">196</a> <em
class="jxr_javadoccomment"> * include "xerces:xerces-api"</em>
+<a class="jxr_linenumber" name="L197" href="#L197">197</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L198" href="#L198">198</a> <em
class="jxr_javadoccomment"> * @see #setIncludes(List)</em>
+<a class="jxr_linenumber" name="L199" href="#L199">199</a> <em
class="jxr_javadoccomment"> * @param theIncludes the includes to set</em>
+<a class="jxr_linenumber" name="L200" href="#L200">200</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L201" href="#L201">201</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong>
setIncludes(List<String> theIncludes) {
+<a class="jxr_linenumber" name="L202" href="#L202">202</a> <strong
class="jxr_keyword">this</strong>.includes = theIncludes;
+<a class="jxr_linenumber" name="L203" href="#L203">203</a> }
+<a class="jxr_linenumber" name="L204" href="#L204">204</a>
+<a class="jxr_linenumber" name="L205" href="#L205">205</a> <strong
class="jxr_keyword">public</strong> <strong
class="jxr_keyword">boolean</strong> isSearchTransitive() {
+<a class="jxr_linenumber" name="L206" href="#L206">206</a> <strong
class="jxr_keyword">return</strong> searchTransitive;
+<a class="jxr_linenumber" name="L207" href="#L207">207</a> }
+<a class="jxr_linenumber" name="L208" href="#L208">208</a> }
</pre>
<hr/>
<div id="footer">Copyright © 2007–2023 <a
href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights
reserved.</div>
Modified:
maven/website/components/enforcer-archives/enforcer-LATEST/enforcer-rules/xref/org/apache/maven/enforcer/rules/dependency/DependencyConvergence.html
==============================================================================
---
maven/website/components/enforcer-archives/enforcer-LATEST/enforcer-rules/xref/org/apache/maven/enforcer/rules/dependency/DependencyConvergence.html
(original)
+++
maven/website/components/enforcer-archives/enforcer-LATEST/enforcer-rules/xref/org/apache/maven/enforcer/rules/dependency/DependencyConvergence.html
Sat Apr 1 21:10:25 2023
@@ -30,130 +30,112 @@
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong
class="jxr_keyword">import</strong> javax.inject.Named;
<a class="jxr_linenumber" name="L23" href="#L23">23</a>
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong
class="jxr_keyword">import</strong> java.util.ArrayList;
-<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong
class="jxr_keyword">import</strong> java.util.Collections;
-<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong
class="jxr_keyword">import</strong> java.util.List;
-<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong
class="jxr_keyword">import</strong> java.util.Objects;
-<a class="jxr_linenumber" name="L28" href="#L28">28</a>
-<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.enforcer.rule.api.EnforcerRuleException;
-<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.enforcer.rules.AbstractStandardEnforcerRule;
-<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.enforcer.rules.utils.ArtifactUtils;
-<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong
class="jxr_keyword">import</strong>
org.eclipse.aether.collection.DependencyCollectionContext;
-<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong
class="jxr_keyword">import</strong>
org.eclipse.aether.collection.DependencySelector;
-<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong
class="jxr_keyword">import</strong> org.eclipse.aether.graph.Dependency;
-<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong
class="jxr_keyword">import</strong> org.eclipse.aether.graph.DependencyNode;
-<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong
class="jxr_keyword">import</strong>
org.eclipse.aether.util.graph.selector.ExclusionDependencySelector;
+<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong
class="jxr_keyword">import</strong> java.util.Arrays;
+<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong
class="jxr_keyword">import</strong> java.util.Collections;
+<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong
class="jxr_keyword">import</strong> java.util.List;
+<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong
class="jxr_keyword">import</strong> java.util.Objects;
+<a class="jxr_linenumber" name="L29" href="#L29">29</a>
+<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.enforcer.rule.api.EnforcerRuleException;
+<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.enforcer.rules.AbstractStandardEnforcerRule;
+<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong
class="jxr_keyword">import</strong>
org.apache.maven.enforcer.rules.utils.ArtifactUtils;
+<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong
class="jxr_keyword">import</strong> org.eclipse.aether.graph.DependencyNode;
+<a class="jxr_linenumber" name="L34" href="#L34">34</a>
+<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong
class="jxr_keyword">import</strong> <strong class="jxr_keyword">static</strong>
org.apache.maven.artifact.Artifact.SCOPE_PROVIDED;
+<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong
class="jxr_keyword">import</strong> <strong class="jxr_keyword">static</strong>
org.apache.maven.artifact.Artifact.SCOPE_TEST;
<a class="jxr_linenumber" name="L37" href="#L37">37</a>
-<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong
class="jxr_keyword">import</strong> <strong class="jxr_keyword">static</strong>
org.apache.maven.artifact.Artifact.SCOPE_PROVIDED;
-<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong
class="jxr_keyword">import</strong> <strong class="jxr_keyword">static</strong>
org.apache.maven.artifact.Artifact.SCOPE_TEST;
-<a class="jxr_linenumber" name="L40" href="#L40">40</a>
-<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em
class="jxr_javadoccomment"> * @author <a href="<a
href="mailto:[email protected]";
target="alexandria_uri">mailto:[email protected]</a>">Rex
Hoffman</a></em>
-<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L44" href="#L44">44</a> @Named(<span
class="jxr_string">"dependencyConvergence"</span>)
-<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong>
<strong class="jxr_keyword">class</strong> <a name="DependencyConvergence"
href="../../../../../../org/apache/maven/enforcer/rules/dependency/DependencyConvergence.html#DependencyConvergence">DependencyConvergence</a>
<strong class="jxr_keyword">extends</strong> <a
name="AbstractStandardEnforcerRule"
href="../../../../../../org/apache/maven/enforcer/rules/AbstractStandardEnforcerRule.html#AbstractStandardEnforcerRule">AbstractStandardEnforcerRule</a>
{
-<a class="jxr_linenumber" name="L46" href="#L46">46</a>
-<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">boolean</strong> uniqueVersions;
-<a class="jxr_linenumber" name="L48" href="#L48">48</a>
-<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong
class="jxr_keyword">private</strong> List<String> includes;
-<a class="jxr_linenumber" name="L50" href="#L50">50</a>
-<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong
class="jxr_keyword">private</strong> List<String> excludes;
-<a class="jxr_linenumber" name="L52" href="#L52">52</a>
-<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong
class="jxr_keyword">private</strong> <a name="DependencyVersionMap"
href="../../../../../../org/apache/maven/enforcer/rules/dependency/DependencyVersionMap.html#DependencyVersionMap">DependencyVersionMap</a>
dependencyVersionMap;
-<a class="jxr_linenumber" name="L54" href="#L54">54</a>
-<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong
class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong>
<a name="ResolveUtil"
href="../../../../../../org/apache/maven/enforcer/rules/dependency/ResolveUtil.html#ResolveUtil">ResolveUtil</a>
resolveUtil;
-<a class="jxr_linenumber" name="L56" href="#L56">56</a>
-<a class="jxr_linenumber" name="L57" href="#L57">57</a> @Inject
-<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong
class="jxr_keyword">public</strong> <a name="DependencyConvergence"
href="../../../../../../org/apache/maven/enforcer/rules/dependency/DependencyConvergence.html#DependencyConvergence">DependencyConvergence</a>(<a
name="ResolveUtil"
href="../../../../../../org/apache/maven/enforcer/rules/dependency/ResolveUtil.html#ResolveUtil">ResolveUtil</a>
resolveUtil) {
-<a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong
class="jxr_keyword">this</strong>.resolveUtil =
Objects.requireNonNull(resolveUtil);
-<a class="jxr_linenumber" name="L60" href="#L60">60</a> }
-<a class="jxr_linenumber" name="L61" href="#L61">61</a>
-<a class="jxr_linenumber" name="L62" href="#L62">62</a> @Override
-<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong>
execute() <strong class="jxr_keyword">throws</strong> EnforcerRuleException {
+<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em
class="jxr_javadoccomment"> * @author <a href="<a
href="mailto:[email protected]";
target="alexandria_uri">mailto:[email protected]</a>">Rex
Hoffman</a></em>
+<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L41" href="#L41">41</a> @Named(<span
class="jxr_string">"dependencyConvergence"</span>)
+<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong>
<strong class="jxr_keyword">class</strong> <a name="DependencyConvergence"
href="../../../../../../org/apache/maven/enforcer/rules/dependency/DependencyConvergence.html#DependencyConvergence">DependencyConvergence</a>
<strong class="jxr_keyword">extends</strong> <a
name="AbstractStandardEnforcerRule"
href="../../../../../../org/apache/maven/enforcer/rules/AbstractStandardEnforcerRule.html#AbstractStandardEnforcerRule">AbstractStandardEnforcerRule</a>
{
+<a class="jxr_linenumber" name="L43" href="#L43">43</a>
+<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em
class="jxr_comment">// parameters</em>
+<a class="jxr_linenumber" name="L45" href="#L45">45</a>
+<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">boolean</strong> uniqueVersions;
+<a class="jxr_linenumber" name="L47" href="#L47">47</a>
+<a class="jxr_linenumber" name="L48" href="#L48">48</a> <strong
class="jxr_keyword">private</strong> List<String> includes;
+<a class="jxr_linenumber" name="L49" href="#L49">49</a>
+<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong
class="jxr_keyword">private</strong> List<String> excludes;
+<a class="jxr_linenumber" name="L51" href="#L51">51</a>
+<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong
class="jxr_keyword">private</strong> List<String> excludedScopes =
Arrays.asList(SCOPE_TEST, SCOPE_PROVIDED);
+<a class="jxr_linenumber" name="L53" href="#L53">53</a>
+<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em
class="jxr_comment">// parameters - end</em>
+<a class="jxr_linenumber" name="L55" href="#L55">55</a>
+<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong
class="jxr_keyword">private</strong> <a name="DependencyVersionMap"
href="../../../../../../org/apache/maven/enforcer/rules/dependency/DependencyVersionMap.html#DependencyVersionMap">DependencyVersionMap</a>
dependencyVersionMap;
+<a class="jxr_linenumber" name="L57" href="#L57">57</a>
+<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong
class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong>
<a name="ResolverUtil"
href="../../../../../../org/apache/maven/enforcer/rules/dependency/ResolverUtil.html#ResolverUtil">ResolverUtil</a>
resolverUtil;
+<a class="jxr_linenumber" name="L59" href="#L59">59</a>
+<a class="jxr_linenumber" name="L60" href="#L60">60</a> @Inject
+<a class="jxr_linenumber" name="L61" href="#L61">61</a> <strong
class="jxr_keyword">public</strong> <a name="DependencyConvergence"
href="../../../../../../org/apache/maven/enforcer/rules/dependency/DependencyConvergence.html#DependencyConvergence">DependencyConvergence</a>(<a
name="ResolverUtil"
href="../../../../../../org/apache/maven/enforcer/rules/dependency/ResolverUtil.html#ResolverUtil">ResolverUtil</a>
resolverUtil) {
+<a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong
class="jxr_keyword">this</strong>.resolverUtil =
Objects.requireNonNull(resolverUtil);
+<a class="jxr_linenumber" name="L63" href="#L63">63</a> }
<a class="jxr_linenumber" name="L64" href="#L64">64</a>
-<a class="jxr_linenumber" name="L65" href="#L65">65</a>
DependencyNode node = resolveUtil.resolveTransitiveDependencies(
-<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em
class="jxr_comment">// TODO: use a modified version of
ExclusionDependencySelector to process excludes and includes</em>
-<a class="jxr_linenumber" name="L67" href="#L67">67</a>
<strong class="jxr_keyword">new</strong> DependencySelector() {
-<a class="jxr_linenumber" name="L68" href="#L68">68</a>
@Override
-<a class="jxr_linenumber" name="L69" href="#L69">69</a>
<strong class="jxr_keyword">public</strong> <strong
class="jxr_keyword">boolean</strong> selectDependency(Dependency dependency) {
-<a class="jxr_linenumber" name="L70" href="#L70">70</a>
<em class="jxr_comment">// regular OptionalDependencySelector only
discriminates optional dependencies at level 2+</em>
-<a class="jxr_linenumber" name="L71" href="#L71">71</a>
<strong class="jxr_keyword">return</strong> !dependency.isOptional()
-<a class="jxr_linenumber" name="L72" href="#L72">72</a>
<em class="jxr_comment">// regular scope selectors only discard
transitive dependencies</em>
-<a class="jxr_linenumber" name="L73" href="#L73">73</a>
<em class="jxr_comment">// and always allow direct dependencies</em>
-<a class="jxr_linenumber" name="L74" href="#L74">74</a>
&& !dependency.getScope().equals(SCOPE_TEST)
-<a class="jxr_linenumber" name="L75" href="#L75">75</a>
&& !dependency.getScope().equals(SCOPE_PROVIDED);
-<a class="jxr_linenumber" name="L76" href="#L76">76</a> }
-<a class="jxr_linenumber" name="L77" href="#L77">77</a>
-<a class="jxr_linenumber" name="L78" href="#L78">78</a>
@Override
-<a class="jxr_linenumber" name="L79" href="#L79">79</a>
<strong class="jxr_keyword">public</strong> DependencySelector
deriveChildSelector(DependencyCollectionContext context) {
-<a class="jxr_linenumber" name="L80" href="#L80">80</a>
<strong class="jxr_keyword">return</strong> <strong
class="jxr_keyword">this</strong>;
-<a class="jxr_linenumber" name="L81" href="#L81">81</a> }
-<a class="jxr_linenumber" name="L82" href="#L82">82</a> },
-<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em
class="jxr_comment">// process dependency exclusions</em>
-<a class="jxr_linenumber" name="L84" href="#L84">84</a>
<strong class="jxr_keyword">new</strong> ExclusionDependencySelector());
-<a class="jxr_linenumber" name="L85" href="#L85">85</a>
dependencyVersionMap = <strong class="jxr_keyword">new</strong> <a
name="DependencyVersionMap"
href="../../../../../../org/apache/maven/enforcer/rules/dependency/DependencyVersionMap.html#DependencyVersionMap">DependencyVersionMap</a>().setUniqueVersions(uniqueVersions);
-<a class="jxr_linenumber" name="L86" href="#L86">86</a>
node.accept(dependencyVersionMap);
-<a class="jxr_linenumber" name="L87" href="#L87">87</a>
-<a class="jxr_linenumber" name="L88" href="#L88">88</a>
List<CharSequence> errorMsgs = <strong class="jxr_keyword">new</strong>
ArrayList<>(
-<a class="jxr_linenumber" name="L89" href="#L89">89</a>
getConvergenceErrorMsgs(dependencyVersionMap.getConflictedVersionNumbers(includes,
excludes)));
-<a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong
class="jxr_keyword">for</strong> (CharSequence errorMsg : errorMsgs) {
-<a class="jxr_linenumber" name="L91" href="#L91">91</a>
getLog().warnOrError(errorMsg);
-<a class="jxr_linenumber" name="L92" href="#L92">92</a> }
-<a class="jxr_linenumber" name="L93" href="#L93">93</a> <strong
class="jxr_keyword">if</strong> (errorMsgs.size() > 0) {
-<a class="jxr_linenumber" name="L94" href="#L94">94</a> <strong
class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong>
EnforcerRuleException(
-<a class="jxr_linenumber" name="L95" href="#L95">95</a>
<span class="jxr_string">"Failed while enforcing releasability. "</span> +
<span class="jxr_string">"See above detailed error message."</span>);
+<a class="jxr_linenumber" name="L65" href="#L65">65</a> @Override
+<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong>
execute() <strong class="jxr_keyword">throws</strong> EnforcerRuleException {
+<a class="jxr_linenumber" name="L67" href="#L67">67</a>
+<a class="jxr_linenumber" name="L68" href="#L68">68</a>
DependencyNode node =
resolverUtil.resolveTransitiveDependenciesVerbose(excludedScopes);
+<a class="jxr_linenumber" name="L69" href="#L69">69</a>
dependencyVersionMap = <strong class="jxr_keyword">new</strong> <a
name="DependencyVersionMap"
href="../../../../../../org/apache/maven/enforcer/rules/dependency/DependencyVersionMap.html#DependencyVersionMap">DependencyVersionMap</a>().setUniqueVersions(uniqueVersions);
+<a class="jxr_linenumber" name="L70" href="#L70">70</a>
node.accept(dependencyVersionMap);
+<a class="jxr_linenumber" name="L71" href="#L71">71</a>
+<a class="jxr_linenumber" name="L72" href="#L72">72</a>
List<String> errorMsgs =
+<a class="jxr_linenumber" name="L73" href="#L73">73</a>
getConvergenceErrorMsgs(dependencyVersionMap.getConflictedVersionNumbers(includes,
excludes));
+<a class="jxr_linenumber" name="L74" href="#L74">74</a>
+<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong
class="jxr_keyword">if</strong> (!errorMsgs.isEmpty()) {
+<a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong
class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong>
EnforcerRuleException(<span class="jxr_string">"Failed while enforcing
releasability."</span> + System.lineSeparator()
+<a class="jxr_linenumber" name="L77" href="#L77">77</a> +
String.join(System.lineSeparator(), errorMsgs));
+<a class="jxr_linenumber" name="L78" href="#L78">78</a> }
+<a class="jxr_linenumber" name="L79" href="#L79">79</a> }
+<a class="jxr_linenumber" name="L80" href="#L80">80</a>
+<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong
class="jxr_keyword">private</strong> StringBuilder
buildTreeString(DependencyNode node) {
+<a class="jxr_linenumber" name="L82" href="#L82">82</a>
List<String> loc = <strong class="jxr_keyword">new</strong>
ArrayList<>();
+<a class="jxr_linenumber" name="L83" href="#L83">83</a>
DependencyNode currentNode = node;
+<a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong
class="jxr_keyword">while</strong> (currentNode != <strong
class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em
class="jxr_comment">// ArtifactUtils.toArtifact(node) adds scope and optional
information, if present</em>
+<a class="jxr_linenumber" name="L86" href="#L86">86</a>
loc.add(ArtifactUtils.toArtifact(currentNode).toString());
+<a class="jxr_linenumber" name="L87" href="#L87">87</a>
currentNode = dependencyVersionMap.getParent(currentNode);
+<a class="jxr_linenumber" name="L88" href="#L88">88</a> }
+<a class="jxr_linenumber" name="L89" href="#L89">89</a>
Collections.reverse(loc);
+<a class="jxr_linenumber" name="L90" href="#L90">90</a> StringBuilder
builder = <strong class="jxr_keyword">new</strong> StringBuilder();
+<a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong
class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i =
0; i < loc.size(); i++) {
+<a class="jxr_linenumber" name="L92" href="#L92">92</a> <strong
class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> j =
0; j < i; j++) {
+<a class="jxr_linenumber" name="L93" href="#L93">93</a>
builder.append(<span class="jxr_string">" "</span>);
+<a class="jxr_linenumber" name="L94" href="#L94">94</a> }
+<a class="jxr_linenumber" name="L95" href="#L95">95</a>
builder.append(<span
class="jxr_string">"+-"</span>).append(loc.get(i)).append(System.lineSeparator());
<a class="jxr_linenumber" name="L96" href="#L96">96</a> }
-<a class="jxr_linenumber" name="L97" href="#L97">97</a> }
-<a class="jxr_linenumber" name="L98" href="#L98">98</a>
-<a class="jxr_linenumber" name="L99" href="#L99">99</a> <strong
class="jxr_keyword">private</strong> StringBuilder
buildTreeString(DependencyNode node) {
-<a class="jxr_linenumber" name="L100" href="#L100">100</a>
List<String> loc = <strong class="jxr_keyword">new</strong>
ArrayList<>();
-<a class="jxr_linenumber" name="L101" href="#L101">101</a>
DependencyNode currentNode = node;
-<a class="jxr_linenumber" name="L102" href="#L102">102</a> <strong
class="jxr_keyword">while</strong> (currentNode != <strong
class="jxr_keyword">null</strong>) {
-<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em
class="jxr_comment">// ArtifactUtils.toArtifact(node) adds scope and optional
information, if present</em>
-<a class="jxr_linenumber" name="L104" href="#L104">104</a>
loc.add(ArtifactUtils.toArtifact(currentNode).toString());
-<a class="jxr_linenumber" name="L105" href="#L105">105</a>
currentNode = dependencyVersionMap.getParent(currentNode);
-<a class="jxr_linenumber" name="L106" href="#L106">106</a> }
-<a class="jxr_linenumber" name="L107" href="#L107">107</a>
Collections.reverse(loc);
-<a class="jxr_linenumber" name="L108" href="#L108">108</a>
StringBuilder builder = <strong class="jxr_keyword">new</strong>
StringBuilder();
-<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong
class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i =
0; i < loc.size(); i++) {
-<a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong
class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> j =
0; j < i; j++) {
-<a class="jxr_linenumber" name="L111" href="#L111">111</a>
builder.append(<span class="jxr_string">" "</span>);
-<a class="jxr_linenumber" name="L112" href="#L112">112</a> }
-<a class="jxr_linenumber" name="L113" href="#L113">113</a>
builder.append(<span
class="jxr_string">"+-"</span>).append(loc.get(i)).append(System.lineSeparator());
-<a class="jxr_linenumber" name="L114" href="#L114">114</a> }
-<a class="jxr_linenumber" name="L115" href="#L115">115</a> <strong
class="jxr_keyword">return</strong> builder;
-<a class="jxr_linenumber" name="L116" href="#L116">116</a> }
-<a class="jxr_linenumber" name="L117" href="#L117">117</a>
-<a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong
class="jxr_keyword">private</strong> List<String>
getConvergenceErrorMsgs(List<List<DependencyNode>> errors) {
-<a class="jxr_linenumber" name="L119" href="#L119">119</a>
List<String> errorMsgs = <strong class="jxr_keyword">new</strong>
ArrayList<>();
-<a class="jxr_linenumber" name="L120" href="#L120">120</a> <strong
class="jxr_keyword">for</strong> (List<DependencyNode> nodeList : errors)
{
-<a class="jxr_linenumber" name="L121" href="#L121">121</a>
errorMsgs.add(buildConvergenceErrorMsg(nodeList));
-<a class="jxr_linenumber" name="L122" href="#L122">122</a> }
-<a class="jxr_linenumber" name="L123" href="#L123">123</a> <strong
class="jxr_keyword">return</strong> errorMsgs;
-<a class="jxr_linenumber" name="L124" href="#L124">124</a> }
-<a class="jxr_linenumber" name="L125" href="#L125">125</a>
-<a class="jxr_linenumber" name="L126" href="#L126">126</a> <strong
class="jxr_keyword">private</strong> String
buildConvergenceErrorMsg(List<DependencyNode> nodeList) {
-<a class="jxr_linenumber" name="L127" href="#L127">127</a>
StringBuilder builder = <strong class="jxr_keyword">new</strong>
StringBuilder();
-<a class="jxr_linenumber" name="L128" href="#L128">128</a>
builder.append(System.lineSeparator())
-<a class="jxr_linenumber" name="L129" href="#L129">129</a>
.append(<span class="jxr_string">"Dependency convergence error for "</span>)
-<a class="jxr_linenumber" name="L130" href="#L130">130</a>
.append(nodeList.get(0).getArtifact().toString())
-<a class="jxr_linenumber" name="L131" href="#L131">131</a>
.append(<span class="jxr_string">" paths to dependency are:"</span>)
-<a class="jxr_linenumber" name="L132" href="#L132">132</a>
.append(System.lineSeparator());
-<a class="jxr_linenumber" name="L133" href="#L133">133</a> <strong
class="jxr_keyword">if</strong> (nodeList.size() > 0) {
-<a class="jxr_linenumber" name="L134" href="#L134">134</a>
builder.append(buildTreeString(nodeList.get(0)));
-<a class="jxr_linenumber" name="L135" href="#L135">135</a> }
-<a class="jxr_linenumber" name="L136" href="#L136">136</a> <strong
class="jxr_keyword">for</strong> (DependencyNode node : nodeList.subList(1,
nodeList.size())) {
-<a class="jxr_linenumber" name="L137" href="#L137">137</a>
builder.append(<span
class="jxr_string">"and"</span>).append(System.lineSeparator()).append(buildTreeString(node));
-<a class="jxr_linenumber" name="L138" href="#L138">138</a> }
-<a class="jxr_linenumber" name="L139" href="#L139">139</a> <strong
class="jxr_keyword">return</strong> builder.toString();
-<a class="jxr_linenumber" name="L140" href="#L140">140</a> }
-<a class="jxr_linenumber" name="L141" href="#L141">141</a>
-<a class="jxr_linenumber" name="L142" href="#L142">142</a> @Override
-<a class="jxr_linenumber" name="L143" href="#L143">143</a> <strong
class="jxr_keyword">public</strong> String toString() {
-<a class="jxr_linenumber" name="L144" href="#L144">144</a> <strong
class="jxr_keyword">return</strong> String.format(
-<a class="jxr_linenumber" name="L145" href="#L145">145</a>
<span class="jxr_string">"DependencyConvergence[includes=%s, excludes=%s,
uniqueVersions=%b]"</span>,
-<a class="jxr_linenumber" name="L146" href="#L146">146</a>
includes, excludes, uniqueVersions);
-<a class="jxr_linenumber" name="L147" href="#L147">147</a> }
-<a class="jxr_linenumber" name="L148" href="#L148">148</a> }
+<a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong
class="jxr_keyword">return</strong> builder;
+<a class="jxr_linenumber" name="L98" href="#L98">98</a> }
+<a class="jxr_linenumber" name="L99" href="#L99">99</a>
+<a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong
class="jxr_keyword">private</strong> List<String>
getConvergenceErrorMsgs(List<List<DependencyNode>> errors) {
+<a class="jxr_linenumber" name="L101" href="#L101">101</a>
List<String> errorMsgs = <strong class="jxr_keyword">new</strong>
ArrayList<>();
+<a class="jxr_linenumber" name="L102" href="#L102">102</a> <strong
class="jxr_keyword">for</strong> (List<DependencyNode> nodeList : errors)
{
+<a class="jxr_linenumber" name="L103" href="#L103">103</a>
errorMsgs.add(buildConvergenceErrorMsg(nodeList));
+<a class="jxr_linenumber" name="L104" href="#L104">104</a> }
+<a class="jxr_linenumber" name="L105" href="#L105">105</a> <strong
class="jxr_keyword">return</strong> errorMsgs;
+<a class="jxr_linenumber" name="L106" href="#L106">106</a> }
+<a class="jxr_linenumber" name="L107" href="#L107">107</a>
+<a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong
class="jxr_keyword">private</strong> String
buildConvergenceErrorMsg(List<DependencyNode> nodeList) {
+<a class="jxr_linenumber" name="L109" href="#L109">109</a>
StringBuilder builder = <strong class="jxr_keyword">new</strong>
StringBuilder();
+<a class="jxr_linenumber" name="L110" href="#L110">110</a>
builder.append(System.lineSeparator())
+<a class="jxr_linenumber" name="L111" href="#L111">111</a>
.append(<span class="jxr_string">"Dependency convergence error for "</span>)
+<a class="jxr_linenumber" name="L112" href="#L112">112</a>
.append(nodeList.get(0).getArtifact().toString())
+<a class="jxr_linenumber" name="L113" href="#L113">113</a>
.append(<span class="jxr_string">" paths to dependency are:"</span>)
+<a class="jxr_linenumber" name="L114" href="#L114">114</a>
.append(System.lineSeparator());
+<a class="jxr_linenumber" name="L115" href="#L115">115</a> <strong
class="jxr_keyword">if</strong> (nodeList.size() > 0) {
+<a class="jxr_linenumber" name="L116" href="#L116">116</a>
builder.append(buildTreeString(nodeList.get(0)));
+<a class="jxr_linenumber" name="L117" href="#L117">117</a> }
+<a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong
class="jxr_keyword">for</strong> (DependencyNode node : nodeList.subList(1,
nodeList.size())) {
+<a class="jxr_linenumber" name="L119" href="#L119">119</a>
builder.append(<span
class="jxr_string">"and"</span>).append(System.lineSeparator()).append(buildTreeString(node));
+<a class="jxr_linenumber" name="L120" href="#L120">120</a> }
+<a class="jxr_linenumber" name="L121" href="#L121">121</a> <strong
class="jxr_keyword">return</strong> builder.toString();
+<a class="jxr_linenumber" name="L122" href="#L122">122</a> }
+<a class="jxr_linenumber" name="L123" href="#L123">123</a>
+<a class="jxr_linenumber" name="L124" href="#L124">124</a> @Override
+<a class="jxr_linenumber" name="L125" href="#L125">125</a> <strong
class="jxr_keyword">public</strong> String toString() {
+<a class="jxr_linenumber" name="L126" href="#L126">126</a> <strong
class="jxr_keyword">return</strong> String.format(
+<a class="jxr_linenumber" name="L127" href="#L127">127</a>
<span class="jxr_string">"DependencyConvergence[includes=%s, excludes=%s,
uniqueVersions=%b]"</span>,
+<a class="jxr_linenumber" name="L128" href="#L128">128</a>
includes, excludes, uniqueVersions);
+<a class="jxr_linenumber" name="L129" href="#L129">129</a> }
+<a class="jxr_linenumber" name="L130" href="#L130">130</a> }
</pre>
<hr/>
<div id="footer">Copyright © 2007–2023 <a
href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights
reserved.</div>
Modified:
maven/website/components/enforcer-archives/enforcer-LATEST/enforcer-rules/xref/org/apache/maven/enforcer/rules/dependency/RequireReleaseDeps.html
==============================================================================
---
maven/website/components/enforcer-archives/enforcer-LATEST/enforcer-rules/xref/org/apache/maven/enforcer/rules/dependency/RequireReleaseDeps.html
(original)
+++
maven/website/components/enforcer-archives/enforcer-LATEST/enforcer-rules/xref/org/apache/maven/enforcer/rules/dependency/RequireReleaseDeps.html
Sat Apr 1 21:10:25 2023
@@ -59,8 +59,8 @@
<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">boolean</strong> failWhenParentIsSnapshot = <strong
class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L52" href="#L52">52</a>
<a class="jxr_linenumber" name="L53" href="#L53">53</a> @Inject
-<a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong
class="jxr_keyword">public</strong> <a name="RequireReleaseDeps"
href="../../../../../../org/apache/maven/enforcer/rules/dependency/RequireReleaseDeps.html#RequireReleaseDeps">RequireReleaseDeps</a>(MavenSession
session, <a name="ResolveUtil"
href="../../../../../../org/apache/maven/enforcer/rules/dependency/ResolveUtil.html#ResolveUtil">ResolveUtil</a>
resolveUtil) {
-<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong
class="jxr_keyword">super</strong>(session, resolveUtil);
+<a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong
class="jxr_keyword">public</strong> <a name="RequireReleaseDeps"
href="../../../../../../org/apache/maven/enforcer/rules/dependency/RequireReleaseDeps.html#RequireReleaseDeps">RequireReleaseDeps</a>(MavenSession
session, <a name="ResolverUtil"
href="../../../../../../org/apache/maven/enforcer/rules/dependency/ResolverUtil.html#ResolverUtil">ResolverUtil</a>
resolverUtil) {
+<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong
class="jxr_keyword">super</strong>(session, resolverUtil);
<a class="jxr_linenumber" name="L56" href="#L56">56</a> }
<a class="jxr_linenumber" name="L57" href="#L57">57</a>
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em
class="jxr_comment">// Override parent to allow optional ignore of this
rule.</em>
