Added: dev/commons/commons-release-plugin/1.4-RC1/site/apidocs/org/apache/commons/release/plugin/class-use/SharedFunctions.html ============================================================================== --- dev/commons/commons-release-plugin/1.4-RC1/site/apidocs/org/apache/commons/release/plugin/class-use/SharedFunctions.html (added) +++ dev/commons/commons-release-plugin/1.4-RC1/site/apidocs/org/apache/commons/release/plugin/class-use/SharedFunctions.html Sat Aug 25 01:39:02 2018 @@ -0,0 +1,125 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc --> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title>Uses of Class org.apache.commons.release.plugin.SharedFunctions (Apache Commons Release Plugin 1.4 API)</title> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Uses of Class org.apache.commons.release.plugin.SharedFunctions (Apache Commons Release Plugin 1.4 API)"; + } + } + catch(err) { + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../org/apache/commons/release/plugin/SharedFunctions.html" title="class in org.apache.commons.release.plugin">Class</a></li> +<li class="navBarCell1Rev">Use</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">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/commons/release/plugin/class-use/SharedFunctions.html" target="_top">Frames</a></li> +<li><a href="SharedFunctions.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class org.apache.commons.release.plugin.SharedFunctions" class="title">Uses of Class<br>org.apache.commons.release.plugin.SharedFunctions</h2> +</div> +<div class="classUseContainer">No usage of org.apache.commons.release.plugin.SharedFunctions</div> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../../org/apache/commons/release/plugin/SharedFunctions.html" title="class in org.apache.commons.release.plugin">Class</a></li> +<li class="navBarCell1Rev">Use</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">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/commons/release/plugin/class-use/SharedFunctions.html" target="_top">Frames</a></li> +<li><a href="SharedFunctions.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2018 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
Added: dev/commons/commons-release-plugin/1.4-RC1/site/apidocs/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html ============================================================================== --- dev/commons/commons-release-plugin/1.4-RC1/site/apidocs/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html (added) +++ dev/commons/commons-release-plugin/1.4-RC1/site/apidocs/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html Sat Aug 25 01:39:02 2018 @@ -0,0 +1,700 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<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.4 API)</title> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="CommonsDistributionDetachmentMojo (Apache Commons Release Plugin 1.4 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">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">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html" target="_top">Frames</a></li> +<li><a href="CommonsDistributionDetachmentMojo.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<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="subNavList"> +<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> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.commons.release.plugin.mojos</div> +<h2 title="Class CommonsDistributionDetachmentMojo" class="title">Class CommonsDistributionDetachmentMojo</h2> +</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> +<ul class="inheritance"> +<li>org.apache.maven.plugin.AbstractMojo</li> +<li> +<ul class="inheritance"> +<li>org.apache.commons.release.plugin.mojos.CommonsDistributionDetachmentMojo</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo</dd> +</dl> +<hr> +<br> +<pre>@Mojo(name="detach-distributions", + defaultPhase=VERIFY, + threadSafe=true, + aggregator=true) +public class <span class="typeNameLabel">CommonsDistributionDetachmentMojo</span> +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, + 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> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>1.0</dd> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>chtompki</dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<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="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 + 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/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/7/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/7/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=sha256</code>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>private <a href="https://docs.oracle.com/javase/7/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#artifactSha512s">artifactSha512s</a></span></code> +<div class="block">A <a href="https://docs.oracle.com/javase/7/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/7/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=sha512</code>.</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="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 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="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="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> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>private org.apache.maven.project.MavenProject</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#project">project</a></span></code> +<div class="block">The maven project context injection so that we can get a hold of the variables at hand.</div> +</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="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> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.maven.plugin.Mojo"> +<!-- --> +</a> +<h3>Fields inherited from interface org.apache.maven.plugin.Mojo</h3> +<code>ROLE</code></li> +</ul> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html#CommonsDistributionDetachmentMojo--">CommonsDistributionDetachmentMojo</a></span>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" 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#copyRemovedArtifactsToWorkingDirectory--">copyRemovedArtifactsToWorkingDirectory</a></span>()</code> +<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> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<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#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 sha256 map and sha512 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#getSha256FilePath-java.io.File-java.io.File-">getSha256FilePath</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> directory, + <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>sha256</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/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#getSha512FilePath-java.io.File-java.io.File-">getSha512FilePath</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> directory, + <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>sha512</code> signature file from a given file.</div> +</td> +</tr> +<tr id="i5" 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#hashArtifacts--">hashArtifacts</a></span>()</code> +<div class="block">A helper method that creates sha256 and 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="../../../../../../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="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#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="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#putAttachedArtifactInSha512Map-org.apache.maven.artifact.Artifact-">putAttachedArtifactInSha512Map</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#writeAllArtifactsInSha256PropertiesFile--">writeAllArtifactsInSha256PropertiesFile</a></span>()</code> +<div class="block">Writes to ./target/commons-release-plugin/sha256.properties the artifact sha256's.</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#writeAllArtifactsInSha512PropertiesFile--">writeAllArtifactsInSha512PropertiesFile</a></span>()</code> +<div class="block">Writes to ./target/commons-release-plugin/sha512.properties the artifact sha512's.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.maven.plugin.AbstractMojo"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.maven.plugin.AbstractMojo</h3> +<code>getLog, getPluginContext, setLog, setPluginContext</code></li> +</ul> +<ul class="blockList"> +<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> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="ARTIFACT_TYPES_TO_DETACH"> +<!-- --> +</a> +<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>> ARTIFACT_TYPES_TO_DETACH</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, + *-bin.tar.gz, and the corresponding .asc pgp signatures.</div> +</li> +</ul> +<a name="detachedArtifacts"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>detachedArtifacts</h4> +<pre>private final <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> detachedArtifacts</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="artifactSha256s"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>artifactSha256s</h4> +<pre>private final <a href="https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true"; title="class or interface in java.util">Properties</a> artifactSha256s</pre> +<div class="block">A <a href="https://docs.oracle.com/javase/7/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/7/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=sha256</code>.</div> +</li> +</ul> +<a name="artifactSha512s"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>artifactSha512s</h4> +<pre>private final <a href="https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true"; title="class or interface in java.util">Properties</a> artifactSha512s</pre> +<div class="block">A <a href="https://docs.oracle.com/javase/7/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/7/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=sha512</code>.</div> +</li> +</ul> +<a name="project"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>project</h4> +<pre>@Parameter(defaultValue="${project}", + required=true) +private org.apache.maven.project.MavenProject project</pre> +<div class="block">The maven project context injection so that we can get a hold of the variables at hand.</div> +</li> +</ul> +<a name="workingDirectory"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<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> workingDirectory</pre> +<div class="block">The working directory in <code>target</code> that we use as a sandbox for the plugin.</div> +</li> +</ul> +<a name="distSvnStagingUrl"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<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> distSvnStagingUrl</pre> +<div class="block">The subversion staging url to which we upload all of our staged artifacts.</div> +</li> +</ul> +<a name="isDistModule"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<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> isDistModule</pre> +<div class="block">A parameter to generally avoid running unless it is specifically turned on by the consuming module.</div> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="CommonsDistributionDetachmentMojo--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>CommonsDistributionDetachmentMojo</h4> +<pre>public CommonsDistributionDetachmentMojo()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="execute--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>execute</h4> +<pre>public void execute() + throws org.apache.maven.plugin.MojoExecutionException</pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.maven.plugin.MojoExecutionException</code></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 putAttachedArtifactInSha256Map(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/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io"><code>IOException</code></a> occurs when getting the sha256 of the + artifact.</dd> +</dl> +</li> +</ul> +<a name="putAttachedArtifactInSha512Map-org.apache.maven.artifact.Artifact-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>putAttachedArtifactInSha512Map</h4> +<pre>private void putAttachedArtifactInSha512Map(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/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io"><code>IOException</code></a> occurs when getting the sha512 of the + artifact.</dd> +</dl> +</li> +</ul> +<a name="writeAllArtifactsInSha256PropertiesFile--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>writeAllArtifactsInSha256PropertiesFile</h4> +<pre>private void writeAllArtifactsInSha256PropertiesFile() + 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/7/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="writeAllArtifactsInSha512PropertiesFile--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>writeAllArtifactsInSha512PropertiesFile</h4> +<pre>private void writeAllArtifactsInSha512PropertiesFile() + throws org.apache.maven.plugin.MojoExecutionException</pre> +<div class="block">Writes to ./target/commons-release-plugin/sha512.properties the artifact sha512'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/7/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 copyRemovedArtifactsToWorkingDirectory() + 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> +</dl> +</li> +</ul> +<a name="hashArtifacts--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashArtifacts</h4> +<pre>private void hashArtifacts() + throws org.apache.maven.plugin.MojoExecutionException</pre> +<div class="block">A helper method that creates sha256 and 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="../../../../../../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> +</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/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getSha256FilePath(<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> directory, + <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> +<div class="block">A helper method to create a file path for the <code>sha256</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/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>.sha256</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>.sha256</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>.sha256</code> file.</dd> +</dl> +</li> +</ul> +<a name="getSha512FilePath-java.io.File-java.io.File-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSha512FilePath</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> getSha512FilePath(<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> directory, + <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> +<div class="block">A helper method to create a file path for the <code>sha512</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/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>.sha512</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>.sha512</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>.sha512</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/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getArtifactKey(org.apache.maven.artifact.Artifact artifact)</pre> +<div class="block">Generates the unique artifact key for storage in our sha256 map and sha512 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>the generated key</dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">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">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li><a href="../../../../../../org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.html" title="class in org.apache.commons.release.plugin.mojos"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.html" target="_top">Frames</a></li> +<li><a href="CommonsDistributionDetachmentMojo.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<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="subNavList"> +<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> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2018 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
