Added: dev/commons/release-plugin/1.8.3-RC1/site/apidocs/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html ============================================================================== --- dev/commons/release-plugin/1.8.3-RC1/site/apidocs/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html (added) +++ dev/commons/release-plugin/1.8.3-RC1/site/apidocs/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html Sun Nov 3 20:07:40 2024 @@ -0,0 +1,433 @@ +<!DOCTYPE HTML> +<html lang> +<head> +<!-- Generated by javadoc (17) --> +<title>CommonsDistributionDetachmentMojo (Apache Commons Release Plugin 1.8.3 API)</title> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<meta name="description" content="declaration: package: org.apache.commons.release.plugin.mojos, class: CommonsDistributionDetachmentMojo"> +<meta name="generator" content="javadoc/ClassWriterImpl"> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> +<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-3.7.1.min.js"></script> +<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> +</head> +<body class="class-declaration-page"> +<script type="text/javascript">var evenRowColor = "even-row-color"; +var oddRowColor = "odd-row-color"; +var tableTab = "table-tab"; +var activeTableTab = "active-table-tab"; +var pathtoroot = "../../../../../../"; +loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="flex-box"> +<header role="banner" class="flex-header"> +<nav role="navigation"> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="top-nav" id="navbar-top"> +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> +<li><a href="../../../../../../index.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="nav-bar-cell1-rev">Class</li> +<li><a href="class-use/CommonsDistributionDetachmentMojo.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html#class">Help</a></li> +</ul> +</div> +<div class="sub-nav"> +<div> +<ul class="sub-nav-list"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field-summary">Field</a> | </li> +<li><a href="#constructor-summary">Constr</a> | </li> +<li><a href="#method-summary">Method</a></li> +</ul> +<ul class="sub-nav-list"> +<li>Detail: </li> +<li><a href="#field-detail">Field</a> | </li> +<li><a href="#constructor-detail">Constr</a> | </li> +<li><a href="#method-detail">Method</a></li> +</ul> +</div> +<div class="nav-list-search"><label for="search-input">SEARCH:</label> +<input type="text" id="search-input" value="search" disabled="disabled"> +<input type="reset" id="reset-button" value="reset" disabled="disabled"> +</div> +</div> +<!-- ========= END OF TOP NAVBAR ========= --> +<span class="skip-nav" id="skip-navbar-top"></span></nav> +</header> +<div class="flex-content"> +<main role="main"> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.commons.release.plugin.mojos</a></div> +<h1 title="Class CommonsDistributionDetachmentMojo" class="title">Class CommonsDistributionDetachmentMojo</h1> +</div> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html"; title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance">org.apache.maven.plugin.AbstractMojo +<div class="inheritance">org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo</div> +</div> +</div> +<section class="class-description" id="class-description"> +<dl class="notes"> +<dt>All Implemented Interfaces:</dt> +<dd><code>org.apache.maven.plugin.ContextEnabled</code>, <code>org.apache.maven.plugin.Mojo</code></dd> +</dl> +<hr> +<div class="type-signature"><span class="annotations">@Mojo(name="detach-distributions", + defaultPhase=VERIFY, + threadSafe=true, + aggregator=true) +</span><span class="modifiers">public class </span><span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line-52">CommonsDistributionDetachmentMojo</a></span> +<span class="extends-implements">extends org.apache.maven.plugin.AbstractMojo</span></div> +<div class="block">The purpose of this Maven mojo is to detach the artifacts generated by the maven-assembly-plugin, + which for the Apache Commons Project do not get uploaded to Nexus, and putting those artifacts + in the dev distribution location for Apache projects.</div> +<dl class="notes"> +<dt>Since:</dt> +<dd>1.0</dd> +</dl> +</section> +<section class="summary"> +<ul class="summary-list"> +<!-- =========== FIELD SUMMARY =========== --> +<li> +<section class="field-summary" id="field-summary"> +<h2>Field Summary</h2> +<div class="caption"><span>Fields</span></div> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Field</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color"><code>private static final <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/Set.html"; title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a>></code></div> +<div class="col-second even-row-color"><code><a href="#ARTIFACT_TYPES_TO_DETACH" class="member-name-link">ARTIFACT_TYPES_TO_DETACH</a></code></div> +<div class="col-last even-row-color"> +<div class="block">A list of "artifact types" in the Maven vernacular, to + be detached from the deployment.</div> +</div> +<div class="col-first odd-row-color"><code>private final org.apache.commons.collections4.properties.SortedProperties</code></div> +<div class="col-second odd-row-color"><code><a href="#artifactSha512s" class="member-name-link">artifactSha512s</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">A <code>SortedProperties</code> of <code>Artifact</code> â <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link"><code>String</code></a> containing the sha512 signatures + for the individual artifacts, where the <code>Artifact</code> is represented as: + <code>groupId:artifactId:version:type=sha512</code>.</div> +</div> +<div class="col-first even-row-color"><code>private final <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/List.html"; title="class or interface in java.util" class="external-link">List</a><org.apache.maven.artifact.Artifact></code></div> +<div class="col-second even-row-color"><code><a href="#detachedArtifacts" class="member-name-link">detachedArtifacts</a></code></div> +<div class="col-last even-row-color"> +<div class="block">This list is supposed to hold the Maven references to the aforementioned artifacts so that we + can upload them to svn after they've been detached from the Maven deployment.</div> +</div> +<div class="col-first odd-row-color"><code>private <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color"><code><a href="#distSvnStagingUrl" class="member-name-link">distSvnStagingUrl</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">The subversion staging url to which we upload all of our staged artifacts.</div> +</div> +<div class="col-first even-row-color"><code>private <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Boolean.html"; title="class or interface in java.lang" class="external-link">Boolean</a></code></div> +<div class="col-second even-row-color"><code><a href="#isDistModule" class="member-name-link">isDistModule</a></code></div> +<div class="col-last even-row-color"> +<div class="block">A parameter to generally avoid running unless it is specifically turned on by the consuming module.</div> +</div> +<div class="col-first odd-row-color"><code>private org.apache.maven.project.MavenProject</code></div> +<div class="col-second odd-row-color"><code><a href="#project" class="member-name-link">project</a></code></div> +<div class="col-last odd-row-color"> +<div class="block">The maven project context injection so that we can get a hold of the variables at hand.</div> +</div> +<div class="col-first even-row-color"><code>private <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a></code></div> +<div class="col-second even-row-color"><code><a href="#workingDirectory" class="member-name-link">workingDirectory</a></code></div> +<div class="col-last even-row-color"> +<div class="block">The working directory in <code>target</code> that we use as a sandbox for the plugin.</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="fields-inherited-from-class-org.apache.maven.plugin.Mojo">Fields inherited from interface org.apache.maven.plugin.Mojo</h3> +<code>ROLE</code></div> +</section> +</li> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<li> +<section class="constructor-summary" id="constructor-summary"> +<h2>Constructor Summary</h2> +<div class="caption"><span>Constructors</span></div> +<div class="summary-table two-column-summary"> +<div class="table-header col-first">Constructor</div> +<div class="table-header col-last">Description</div> +<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">CommonsDistributionDetachmentMojo</a>()</code></div> +<div class="col-last even-row-color"> </div> +</div> +</section> +</li> +<!-- ========== METHOD SUMMARY =========== --> +<li> +<section class="method-summary" id="method-summary"> +<h2>Method Summary</h2> +<div id="method-summary-table"> +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> +<div class="summary-table three-column-summary"> +<div class="table-header col-first">Modifier and Type</div> +<div class="table-header col-second">Method</div> +<div class="table-header col-last">Description</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#copyRemovedArtifactsToWorkingDirectory()" class="member-name-link">copyRemovedArtifactsToWorkingDirectory</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">A helper method to copy the newly detached artifacts to <code>target/commons-release-plugin</code> + so that the <a href="CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos"><code>CommonsDistributionStagingMojo</code></a> can find the artifacts later.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#execute()" class="member-name-link">execute</a>()</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getArtifactKey(org.apache.maven.artifact.Artifact)" class="member-name-link">getArtifactKey</a><wbr>(org.apache.maven.artifact.Artifact artifact)</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Generates the unique artifact key for storage in our sha512 map.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a></code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSha512FilePath(java.io.File,java.io.File)" class="member-name-link">getSha512FilePath</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a> directory, + <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a> file)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">A helper method to create a file path for the <code>sha512</code> signature file from a given file.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hashArtifacts()" class="member-name-link">hashArtifacts</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">A helper method that creates sha512 signature files for our detached artifacts in the + <code>target/commons-release-plugin</code> directory for the purpose of being uploaded by + the <a href="CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos"><code>CommonsDistributionStagingMojo</code></a>.</div> +</div> +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private void</code></div> +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#putAttachedArtifactInSha512Map(org.apache.maven.artifact.Artifact)" class="member-name-link">putAttachedArtifactInSha512Map</a><wbr>(org.apache.maven.artifact.Artifact artifact)</code></div> +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Takes an attached artifact and puts the signature in the map.</div> +</div> +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private void</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#writeAllArtifactsInSha512PropertiesFile()" class="member-name-link">writeAllArtifactsInSha512PropertiesFile</a>()</code></div> +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> +<div class="block">Writes to .</div> +</div> +</div> +</div> +</div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-org.apache.maven.plugin.AbstractMojo">Methods inherited from class org.apache.maven.plugin.AbstractMojo</h3> +<code>getLog, getPluginContext, setLog, setPluginContext</code></div> +<div class="inherited-list"> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html"; title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Objec t.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +</section> +</li> +</ul> +</section> +<section class="details"> +<ul class="details-list"> +<!-- ============ FIELD DETAIL =========== --> +<li> +<section class="field-details" id="field-detail"> +<h2>Field Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="ARTIFACT_TYPES_TO_DETACH"> +<h3>ARTIFACT_TYPES_TO_DETACH</h3> +<div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/Set.html"; title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a>></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line-65">ARTIFACT_TYPES_TO_DETACH</a></span></div> +<div class="block">A list of "artifact types" in the Maven vernacular, to + be detached from the deployment. For the time being we want + all artifacts generated by the maven-assembly-plugin to be detached + from the deployment, namely *-src.zip, *-src.tar.gz, *-bin.zip, + *-bin.tar.gz, and the corresponding .asc pgp signatures.</div> +</section> +</li> +<li> +<section class="detail" id="detachedArtifacts"> +<h3>detachedArtifacts</h3> +<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/List.html"; title="class or interface in java.util" class="external-link">List</a><org.apache.maven.artifact.Artifact></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line-79">detachedArtifacts</a></span></div> +<div class="block">This list is supposed to hold the Maven references to the aforementioned artifacts so that we + can upload them to svn after they've been detached from the Maven deployment.</div> +</section> +</li> +<li> +<section class="detail" id="artifactSha512s"> +<h3>artifactSha512s</h3> +<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">org.apache.commons.collections4.properties.SortedProperties</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line-86">artifactSha512s</a></span></div> +<div class="block">A <code>SortedProperties</code> of <code>Artifact</code> â <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link"><code>String</code></a> containing the sha512 signatures + for the individual artifacts, where the <code>Artifact</code> is represented as: + <code>groupId:artifactId:version:type=sha512</code>.</div> +</section> +</li> +<li> +<section class="detail" id="project"> +<h3>project</h3> +<div class="member-signature"><span class="annotations">@Parameter(defaultValue="${project}", + required=true) +</span><span class="modifiers">private</span> <span class="return-type">org.apache.maven.project.MavenProject</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line-91">project</a></span></div> +<div class="block">The maven project context injection so that we can get a hold of the variables at hand.</div> +</section> +</li> +<li> +<section class="detail" id="workingDirectory"> +<h3>workingDirectory</h3> +<div class="member-signature"><span class="annotations">@Parameter(defaultValue="${project.build.directory}/commons-release-plugin", + property="commons.outputDirectory") +</span><span class="modifiers">private</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line-97">workingDirectory</a></span></div> +<div class="block">The working directory in <code>target</code> that we use as a sandbox for the plugin.</div> +</section> +</li> +<li> +<section class="detail" id="distSvnStagingUrl"> +<h3>distSvnStagingUrl</h3> +<div class="member-signature"><span class="annotations">@Parameter(defaultValue="", + property="commons.distSvnStagingUrl") +</span><span class="modifiers">private</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line-104">distSvnStagingUrl</a></span></div> +<div class="block">The subversion staging url to which we upload all of our staged artifacts.</div> +</section> +</li> +<li> +<section class="detail" id="isDistModule"> +<h3>isDistModule</h3> +<div class="member-signature"><span class="annotations">@Parameter(defaultValue="false", + property="commons.release.isDistModule") +</span><span class="modifiers">private</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Boolean.html"; title="class or interface in java.lang" class="external-link">Boolean</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line-110">isDistModule</a></span></div> +<div class="block">A parameter to generally avoid running unless it is specifically turned on by the consuming module.</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<li> +<section class="constructor-details" id="constructor-detail"> +<h2>Constructor Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="<init>()"> +<h3>CommonsDistributionDetachmentMojo</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line-56">CommonsDistributionDetachmentMojo</a></span>()</div> +</section> +</li> +</ul> +</section> +</li> +<!-- ============ METHOD DETAIL ========== --> +<li> +<section class="method-details" id="method-detail"> +<h2>Method Details</h2> +<ul class="member-list"> +<li> +<section class="detail" id="execute()"> +<h3>execute</h3> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line-113">execute</a></span>() + throws <span class="exceptions">org.apache.maven.plugin.MojoExecutionException</span></div> +<dl class="notes"> +<dt>Throws:</dt> +<dd><code>org.apache.maven.plugin.MojoExecutionException</code></dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="putAttachedArtifactInSha512Map(org.apache.maven.artifact.Artifact)"> +<h3>putAttachedArtifactInSha512Map</h3> +<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line-168">putAttachedArtifactInSha512Map</a></span><wbr><span class="parameters">(org.apache.maven.artifact.Artifact artifact)</span> + throws <span class="exceptions">org.apache.maven.plugin.MojoExecutionException</span></div> +<div class="block">Takes an attached artifact and puts the signature in the map.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>artifact</code> - is a Maven <code>Artifact</code> taken from the project at start time of mojo.</dd> +<dt>Throws:</dt> +<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - if an <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/IOException.html"; title="class or interface in java.io" class="external-link"><code>IOException</code></a> occurs when getting the sha512 of the + artifact.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="writeAllArtifactsInSha512PropertiesFile()"> +<h3>writeAllArtifactsInSha512PropertiesFile</h3> +<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line-195">writeAllArtifactsInSha512PropertiesFile</a></span>() + throws <span class="exceptions">org.apache.maven.plugin.MojoExecutionException</span></div> +<div class="block">Writes to ./target/commons-release-plugin/sha512.properties the artifact sha512's.</div> +<dl class="notes"> +<dt>Throws:</dt> +<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - if we can't write the file due to an <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/IOException.html"; title="class or interface in java.io" class="external-link"><code>IOException</code></a>.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="copyRemovedArtifactsToWorkingDirectory()"> +<h3>copyRemovedArtifactsToWorkingDirectory</h3> +<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line-212">copyRemovedArtifactsToWorkingDirectory</a></span>() + throws <span class="exceptions">org.apache.maven.plugin.MojoExecutionException</span></div> +<div class="block">A helper method to copy the newly detached artifacts to <code>target/commons-release-plugin</code> + so that the <a href="CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos"><code>CommonsDistributionStagingMojo</code></a> can find the artifacts later.</div> +<dl class="notes"> +<dt>Throws:</dt> +<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - if some form of an <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/IOException.html"; title="class or interface in java.io" class="external-link"><code>IOException</code></a> occurs, we want it + properly wrapped so that Maven can handle it.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="hashArtifacts()"> +<h3>hashArtifacts</h3> +<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line-235">hashArtifacts</a></span>() + throws <span class="exceptions">org.apache.maven.plugin.MojoExecutionException</span></div> +<div class="block">A helper method that creates sha512 signature files for our detached artifacts in the + <code>target/commons-release-plugin</code> directory for the purpose of being uploaded by + the <a href="CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos"><code>CommonsDistributionStagingMojo</code></a>.</div> +<dl class="notes"> +<dt>Throws:</dt> +<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - if some form of an <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/IOException.html"; title="class or interface in java.io" class="external-link"><code>IOException</code></a> occurs, we want it + properly wrapped so that Maven can handle it.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getSha512FilePath(java.io.File,java.io.File)"> +<h3>getSha512FilePath</h3> +<div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line-262">getSha512FilePath</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a> directory, + <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link">File</a> file)</span></div> +<div class="block">A helper method to create a file path for the <code>sha512</code> signature file from a given file.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>directory</code> - is the <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link"><code>File</code></a> for the directory in which to make the <code>.sha512</code> file.</dd> +<dd><code>file</code> - the <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html"; title="class or interface in java.io" class="external-link"><code>File</code></a> whose name we should use to create the <code>.sha512</code> file.</dd> +<dt>Returns:</dt> +<dd>a <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link"><code>String</code></a> that is the absolute path to the <code>.sha512</code> file.</dd> +</dl> +</section> +</li> +<li> +<section class="detail" id="getArtifactKey(org.apache.maven.artifact.Artifact)"> +<h3>getArtifactKey</h3> +<div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line-277">getArtifactKey</a></span><wbr><span class="parameters">(org.apache.maven.artifact.Artifact artifact)</span></div> +<div class="block">Generates the unique artifact key for storage in our sha512 map. For example, + commons-test-1.4-src.tar.gz should have its name as the key.</div> +<dl class="notes"> +<dt>Parameters:</dt> +<dd><code>artifact</code> - the <code>Artifact</code> that we wish to generate a key for.</dd> +<dt>Returns:</dt> +<dd>the generated key</dd> +</dl> +</section> +</li> +</ul> +</section> +</li> +</ul> +</section> +<!-- ========= END OF CLASS DATA ========= --> +</main> +<footer role="contentinfo"> +<hr> +<p class="legal-copy"><small>Copyright © 2018-2024 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</br> <a href="https://commons.apache.org/proper/commons-release-plugin/";>Apache Commons Release Plugin</a> | <a href="https://issues.apache.org/jira/browse/COMMONSSITE";>Issue management</a> | <a href="https://gitbox.apache.org/repos/asf?p=commons-release-plugin.git";>Source repository</a></small></p> +</footer> +</div> +</div> +</body> +</html>
