Modified: websites/production/commons/content/proper/commons-release-plugin/apidocs/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html ============================================================================== --- websites/production/commons/content/proper/commons-release-plugin/apidocs/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html (original) +++ websites/production/commons/content/proper/commons-release-plugin/apidocs/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html Tue Jun 19 03:50:24 2018 @@ -3,8 +3,8 @@ <html lang="en"> <head> <!-- Generated by javadoc --> -<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> -<title>CommonsDistributionDetachmentMojo (Apache Commons Release Plugin 1.3-SNAPSHOT API)</title> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title>CommonsDistributionDetachmentMojo (Apache Commons Release Plugin 1.3 API)</title> <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../../../../../script.js"></script> </head> @@ -12,13 +12,13 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="CommonsDistributionDetachmentMojo (Apache Commons Release Plugin 1.3-SNAPSHOT API)"; + parent.document.title="CommonsDistributionDetachmentMojo (Apache Commons Release Plugin 1.3 API)"; } } catch(err) { } //--> -var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10}; +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -97,7 +97,7 @@ var activeTableTab = "activeTableTab"; </div> <div class="contentContainer"> <ul class="inheritance"> -<li><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> <li> <ul class="inheritance"> <li>org.apache.maven.plugin.AbstractMojo</li> @@ -122,11 +122,11 @@ var activeTableTab = "activeTableTab"; defaultPhase=VERIFY, threadSafe=true, aggregator=true) -public class <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line.52">CommonsDistributionDetachmentMojo</a> +public class <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line.54">CommonsDistributionDetachmentMojo</a> extends org.apache.maven.plugin.AbstractMojo</pre> -<div class="block">The purpose of this maven mojo is to detach the artifacts generated by the maven-assembly-plugin, +<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> + in the dev distribution location for Apache projects.</div> <dl> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>1.0</dd> @@ -152,27 +152,43 @@ extends org.apache.maven.plugin.Abstract <th class="colLast" scope="col">Field and Description</th> </tr> <tr class="altColor"> -<td class="colFirst"><code>private static <a href="https://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> +<td class="colFirst"><code>private static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#ARTIFACT_TYPES_TO_DETACH">ARTIFACT_TYPES_TO_DETACH</a></span></code> -<div class="block">A list of "artifact types" in the maven vernacular, to +<div class="block">A list of "artifact types" in the Maven vernacular, to be detached from the deployment.</div> </td> </tr> <tr class="rowColor"> -<td class="colFirst"><code>private <a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><org.apache.maven.artifact.Artifact></code></td> +<td class="colFirst"><code>private <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#artifactSha1s">artifactSha1s</a></span></code> +<div class="block">A <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util"><code>Properties</code></a> of <code>Artifact</code> â <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang"><code>String</code></a> containing the sha1 signatures + for the individual artifacts, where the <code>Artifact</code> is represented as: + <code>groupId:artifactId:version:type=sha1</code>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>private <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#artifactSha256s">artifactSha256s</a></span></code> +<div class="block">A <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util"><code>Properties</code></a> of <code>Artifact</code> â <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang"><code>String</code></a> containing the sha256 signatures + for the individual artifacts, where the <code>Artifact</code> is represented as: + <code>groupId:artifactId:version:type=sha1</code>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>private <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><org.apache.maven.artifact.Artifact></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#detachedArtifacts">detachedArtifacts</a></span></code> -<div class="block">This list is supposed to hold the maven references to the aformentioned artifacts so that we - can upload them to svn after they've been detached from the maven deployment.</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> </td> </tr> <tr class="altColor"> -<td class="colFirst"><code>private <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colFirst"><code>private <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#distSvnStagingUrl">distSvnStagingUrl</a></span></code> <div class="block">The subversion staging url to which we upload all of our staged artifacts.</div> </td> </tr> <tr class="rowColor"> -<td class="colFirst"><code>private <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a></code></td> +<td class="colFirst"><code>private <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#isDistModule">isDistModule</a></span></code> <div class="block">A parameter to generally avoid running unless it is specifically turned on by the consuming module.</div> </td> @@ -184,7 +200,7 @@ extends org.apache.maven.plugin.Abstract </td> </tr> <tr class="rowColor"> -<td class="colFirst"><code>private <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td> +<td class="colFirst"><code>private <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#workingDirectory">workingDirectory</a></span></code> <div class="block">The working directory in <code>target</code> that we use as a sandbox for the plugin.</div> </td> @@ -240,27 +256,64 @@ extends org.apache.maven.plugin.Abstract <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#execute--">execute</a></span>()</code> </td> </tr> <tr id="i2" class="altColor"> -<td class="colFirst"><code>private <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#getMd5FilePath-java.io.File-java.io.File-">getMd5FilePath</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> workingDirectory, - <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file)</code> -<div class="block">A helper method to create a file path for the <code>md5</code> signature file from a given file.</div> +<td class="colFirst"><code>private <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#getArtifactKey-org.apache.maven.artifact.Artifact-">getArtifactKey</a></span>(org.apache.maven.artifact.Artifact artifact)</code> +<div class="block">Generates the unique artifact key for storage in our sha1 map and sha256 map.</div> </td> </tr> <tr id="i3" class="rowColor"> -<td class="colFirst"><code>private <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#getSha1FilePath-java.io.File-java.io.File-">getSha1FilePath</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> workingDirectory, - <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file)</code> -<div class="block">A helper method to create a file path for the <code>sha1</code> signature file from a given file.</div> +<td class="colFirst"><code>private <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#getMd5FilePath-java.io.File-java.io.File-">getMd5FilePath</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> directory, + <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file)</code> +<div class="block">A helper method to create a file path for the <code>md5</code> signature file from a given file.</div> </td> </tr> <tr id="i4" class="altColor"> +<td class="colFirst"><code>private <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#getSha1FilePath-java.io.File-java.io.File-">getSha1FilePath</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> directory, + <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file)</code> +<div class="block">A helper method to create a file path for the <code>sha1</code> signature file from a given file.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>private <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#getSha256FilePath-java.io.File-java.io.File-">getSha256FilePath</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> directory, + <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file)</code> +<div class="block">A helper method to create a file path for the <code>sha1</code> signature file from a given file.</div> +</td> +</tr> +<tr id="i6" class="altColor"> <td class="colFirst"><code>private void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#sha1AndMd5SignArtifacts--">sha1AndMd5SignArtifacts</a></span>()</code> -<div class="block">A helper method that creates md5 and sha1 signature files for our detached artifacts in the - <code>target/commons-release-plugin</code> directory for the purpose of being uploade by +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#hashArtifacts--">hashArtifacts</a></span>()</code> +<div class="block">A helper method that creates md5, sha1, and sha256 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="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos"><code>CommonsDistributionStagingMojo</code></a>.</div> </td> </tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>private void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#putAttachedArtifactInSha1Map-org.apache.maven.artifact.Artifact-">putAttachedArtifactInSha1Map</a></span>(org.apache.maven.artifact.Artifact artifact)</code> +<div class="block">Takes an attached artifact and puts the signature in the map.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>private void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#putAttachedArtifactInSha256Map-org.apache.maven.artifact.Artifact-">putAttachedArtifactInSha256Map</a></span>(org.apache.maven.artifact.Artifact artifact)</code> +<div class="block">Takes an attached artifact and puts the signature in the map.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>private void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#writeAllArtifactsInSha1PropertiesFile--">writeAllArtifactsInSha1PropertiesFile</a></span>()</code> +<div class="block">Writes to ./target/commons-release-plugin/sha1.properties the artifact sha1's.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>private void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#writeAllArtifactsInSha256PropertiesFile--">writeAllArtifactsInSha256PropertiesFile</a></span>()</code> +<div class="block">Writes to ./target/commons-release-plugin/sha256.properties the artifact sha256's.</div> +</td> +</tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods.inherited.from.class.org.apache.maven.plugin.AbstractMojo"> @@ -273,8 +326,8 @@ extends org.apache.maven.plugin.Abstract <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> <!-- --> </a> -<h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> -<code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/7/docs/api/ja va/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> +<h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/ja va/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> </ul> </li> </ul> @@ -296,8 +349,8 @@ extends org.apache.maven.plugin.Abstract <ul class="blockList"> <li class="blockList"> <h4>ARTIFACT_TYPES_TO_DETACH</h4> -<pre>private static final <a href="https://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line.61">ARTIFACT_TYPES_TO_DETACH</a></pre> -<div class="block">A list of "artifact types" in the maven vernacular, to +<pre>private static final <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line.63">ARTIFACT_TYPES_TO_DETACH</a></pre> +<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, @@ -310,9 +363,33 @@ extends org.apache.maven.plugin.Abstract <ul class="blockList"> <li class="blockList"> <h4>detachedArtifacts</h4> -<pre>private <a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><org.apache.maven.artifact.Artifact> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line.75">detachedArtifacts</a></pre> -<div class="block">This list is supposed to hold the maven references to the aformentioned artifacts so that we - can upload them to svn after they've been detached from the maven deployment.</div> +<pre>private final <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><org.apache.maven.artifact.Artifact> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line.77">detachedArtifacts</a></pre> +<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> +</li> +</ul> +<a name="artifactSha1s"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>artifactSha1s</h4> +<pre>private final <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line.84">artifactSha1s</a></pre> +<div class="block">A <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util"><code>Properties</code></a> of <code>Artifact</code> â <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang"><code>String</code></a> containing the sha1 signatures + for the individual artifacts, where the <code>Artifact</code> is represented as: + <code>groupId:artifactId:version:type=sha1</code>.</div> +</li> +</ul> +<a name="artifactSha256s"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>artifactSha256s</h4> +<pre>private final <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line.91">artifactSha256s</a></pre> +<div class="block">A <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util"><code>Properties</code></a> of <code>Artifact</code> â <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang"><code>String</code></a> containing the sha256 signatures + for the individual artifacts, where the <code>Artifact</code> is represented as: + <code>groupId:artifactId:version:type=sha1</code>.</div> </li> </ul> <a name="project"> @@ -323,7 +400,7 @@ extends org.apache.maven.plugin.Abstract <h4>project</h4> <pre>@Parameter(defaultValue="${project}", required=true) -private org.apache.maven.project.MavenProject <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line.81">project</a></pre> +private org.apache.maven.project.MavenProject <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line.97">project</a></pre> <div class="block">The maven project context injection so that we can get a hold of the variables at hand.</div> </li> </ul> @@ -335,7 +412,7 @@ private org.apache.maven.project.Ma <h4>workingDirectory</h4> <pre>@Parameter(defaultValue="${project.build.directory}/commons-release-plugin", property="commons.outputDirectory") -private <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line.88">workingDirectory</a></pre> +private <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line.104">workingDirectory</a></pre> <div class="block">The working directory in <code>target</code> that we use as a sandbox for the plugin.</div> </li> </ul> @@ -347,7 +424,7 @@ private <a href="https://docs.oracl <h4>distSvnStagingUrl</h4> <pre>@Parameter(defaultValue="", property="commons.distSvnStagingUrl") -private <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line.94">distSvnStagingUrl</a></pre> +private <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line.110">distSvnStagingUrl</a></pre> <div class="block">The subversion staging url to which we upload all of our staged artifacts.</div> </li> </ul> @@ -359,7 +436,7 @@ private <a href="https://docs.oracl <h4>isDistModule</h4> <pre>@Parameter(defaultValue="false", property="commons.release.isDistModule") -private <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line.100">isDistModule</a></pre> +private <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line.116">isDistModule</a></pre> <div class="block">A parameter to generally avoid running unless it is specifically turned on by the consuming module.</div> </li> </ul> @@ -377,7 +454,7 @@ private <a href="https://docs.oracl <ul class="blockListLast"> <li class="blockList"> <h4>CommonsDistributionDetachmentMojo</h4> -<pre>public <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line.52">CommonsDistributionDetachmentMojo</a>()</pre> +<pre>public <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line.54">CommonsDistributionDetachmentMojo</a>()</pre> </li> </ul> </li> @@ -394,7 +471,7 @@ private <a href="https://docs.oracl <ul class="blockList"> <li class="blockList"> <h4>execute</h4> -<pre>public void <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line.103">execute</a>() +<pre>public void <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line.119">execute</a>() throws org.apache.maven.plugin.MojoExecutionException</pre> <dl> <dt><span class="throwsLabel">Throws:</span></dt> @@ -402,38 +479,104 @@ private <a href="https://docs.oracl </dl> </li> </ul> +<a name="putAttachedArtifactInSha1Map-org.apache.maven.artifact.Artifact-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>putAttachedArtifactInSha1Map</h4> +<pre>private void <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line.160">putAttachedArtifactInSha1Map</a>(org.apache.maven.artifact.Artifact artifact) + throws org.apache.maven.plugin.MojoExecutionException</pre> +<div class="block">Takes an attached artifact and puts the signature in the map.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>artifact</code> - is a Maven <code>Artifact</code> taken from the project at start time of mojo.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - if an <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io"><code>IOException</code></a> occurs when getting the sha1 of the + artifact.</dd> +</dl> +</li> +</ul> +<a name="putAttachedArtifactInSha256Map-org.apache.maven.artifact.Artifact-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>putAttachedArtifactInSha256Map</h4> +<pre>private void <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line.186">putAttachedArtifactInSha256Map</a>(org.apache.maven.artifact.Artifact artifact) + throws org.apache.maven.plugin.MojoExecutionException</pre> +<div class="block">Takes an attached artifact and puts the signature in the map.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>artifact</code> - is a Maven <code>Artifact</code> taken from the project at start time of mojo.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - if an <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io"><code>IOException</code></a> occurs when getting the sha1 of the + artifact.</dd> +</dl> +</li> +</ul> +<a name="writeAllArtifactsInSha1PropertiesFile--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>writeAllArtifactsInSha1PropertiesFile</h4> +<pre>private void <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line.211">writeAllArtifactsInSha1PropertiesFile</a>() + throws org.apache.maven.plugin.MojoExecutionException</pre> +<div class="block">Writes to ./target/commons-release-plugin/sha1.properties the artifact sha1's.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></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/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io"><code>IOException</code></a>.</dd> +</dl> +</li> +</ul> +<a name="writeAllArtifactsInSha256PropertiesFile--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>writeAllArtifactsInSha256PropertiesFile</h4> +<pre>private void <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line.226">writeAllArtifactsInSha256PropertiesFile</a>() + throws org.apache.maven.plugin.MojoExecutionException</pre> +<div class="block">Writes to ./target/commons-release-plugin/sha256.properties the artifact sha256's.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></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/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io"><code>IOException</code></a>.</dd> +</dl> +</li> +</ul> <a name="copyRemovedArtifactsToWorkingDirectory--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>copyRemovedArtifactsToWorkingDirectory</h4> -<pre>private void <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line.141">copyRemovedArtifactsToWorkingDirectory</a>() +<pre>private void <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line.243">copyRemovedArtifactsToWorkingDirectory</a>() throws org.apache.maven.plugin.MojoExecutionException</pre> <div class="block">A helper method to copy the newly detached artifacts to <code>target/commons-release-plugin</code> so that the <a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos"><code>CommonsDistributionStagingMojo</code></a> can find the artifacts later.</div> <dl> <dt><span class="throwsLabel">Throws:</span></dt> -<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - if some form of an <a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io"><code>IOException</code></a> occurs, we want it - properly wrapped so that maven can handle it.</dd> +<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - if some form of an <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io"><code>IOException</code></a> occurs, we want it + properly wrapped so that Maven can handle it.</dd> </dl> </li> </ul> -<a name="sha1AndMd5SignArtifacts--"> +<a name="hashArtifacts--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>sha1AndMd5SignArtifacts</h4> -<pre>private void <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line.163">sha1AndMd5SignArtifacts</a>() - throws org.apache.maven.plugin.MojoExecutionException</pre> -<div class="block">A helper method that creates md5 and sha1 signature files for our detached artifacts in the - <code>target/commons-release-plugin</code> directory for the purpose of being uploade by +<h4>hashArtifacts</h4> +<pre>private void <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line.267">hashArtifacts</a>() + throws org.apache.maven.plugin.MojoExecutionException</pre> +<div class="block">A helper method that creates md5, sha1, and sha256 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="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos"><code>CommonsDistributionStagingMojo</code></a>.</div> <dl> <dt><span class="throwsLabel">Throws:</span></dt> -<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - if some form of an <a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io"><code>IOException</code></a> occurs, we want it - properly wrapped so that maven can handle it.</dd> +<dd><code>org.apache.maven.plugin.MojoExecutionException</code> - if some form of an <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io"><code>IOException</code></a> occurs, we want it + properly wrapped so that Maven can handle it.</dd> </dl> </li> </ul> @@ -443,33 +586,68 @@ private <a href="https://docs.oracl <ul class="blockList"> <li class="blockList"> <h4>getMd5FilePath</h4> -<pre>private <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line.191">getMd5FilePath</a>(<a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> workingDirectory, - <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file)</pre> +<pre>private <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line.301">getMd5FilePath</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> directory, + <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file)</pre> <div class="block">A helper method to create a file path for the <code>md5</code> signature file from a given file.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>workingDirectory</code> - is the <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io"><code>File</code></a> for the directory in which to make the <code>.md5</code> file.</dd> -<dd><code>file</code> - the <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io"><code>File</code></a> whose name we should use to create the <code>.md5</code> file.</dd> +<dd><code>directory</code> - is the <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io"><code>File</code></a> for the directory in which to make the <code>.md5</code> file.</dd> +<dd><code>file</code> - the <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io"><code>File</code></a> whose name we should use to create the <code>.md5</code> file.</dd> <dt><span class="returnLabel">Returns:</span></dt> -<dd>a <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang"><code>String</code></a> that is the absolute path to the <code>.md5</code> file.</dd> +<dd>a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang"><code>String</code></a> that is the absolute path to the <code>.md5</code> file.</dd> </dl> </li> </ul> <a name="getSha1FilePath-java.io.File-java.io.File-"> <!-- --> </a> -<ul class="blockListLast"> +<ul class="blockList"> <li class="blockList"> <h4>getSha1FilePath</h4> -<pre>private <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line.206">getSha1FilePath</a>(<a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> workingDirectory, - <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file)</pre> +<pre>private <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line.316">getSha1FilePath</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> directory, + <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file)</pre> <div class="block">A helper method to create a file path for the <code>sha1</code> signature file from a given file.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>workingDirectory</code> - is the <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io"><code>File</code></a> for the directory in which to make the <code>.sha1</code> file.</dd> -<dd><code>file</code> - the <a href="https://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io"><code>File</code></a> whose name we should use to create the <code>.sha1</code> file.</dd> +<dd><code>directory</code> - is the <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io"><code>File</code></a> for the directory in which to make the <code>.sha1</code> file.</dd> +<dd><code>file</code> - the <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io"><code>File</code></a> whose name we should use to create the <code>.sha1</code> file.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang"><code>String</code></a> that is the absolute path to the <code>.sha1</code> file.</dd> +</dl> +</li> +</ul> +<a name="getSha256FilePath-java.io.File-java.io.File-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSha256FilePath</h4> +<pre>private <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line.331">getSha256FilePath</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> directory, + <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file)</pre> +<div class="block">A helper method to create a file path for the <code>sha1</code> signature file from a given file.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>directory</code> - is the <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io"><code>File</code></a> for the directory in which to make the <code>.sha1</code> file.</dd> +<dd><code>file</code> - the <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io"><code>File</code></a> whose name we should use to create the <code>.sha1</code> file.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang"><code>String</code></a> that is the absolute path to the <code>.sha1</code> file.</dd> +</dl> +</li> +</ul> +<a name="getArtifactKey-org.apache.maven.artifact.Artifact-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getArtifactKey</h4> +<pre>private <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../src-html/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#line.346">getArtifactKey</a>(org.apache.maven.artifact.Artifact artifact)</pre> +<div class="block">Generates the unique artifact key for storage in our sha1 map and sha256 map. For example, + commons-test-1.4-src.tar.gz should have it's name as the key.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>artifact</code> - the <code>Artifact</code> that we wish to generate a key for.</dd> <dt><span class="returnLabel">Returns:</span></dt> -<dd>a <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang"><code>String</code></a> that is the absolute path to the <code>.sha1</code> file.</dd> +<dd>the generated key</dd> </dl> </li> </ul>