You are viewing a plain text version of this content. The canonical link for it is here.
Posted to site-commits@maven.apache.org by cs...@apache.org on 2024/03/23 21:59:20 UTC

svn commit: r1916495 [4/8] - in /maven/website/components/plugins-archives/maven-gpg-plugin-LATEST: ./ apidocs/ apidocs/org/apache/maven/plugins/gpg/ apidocs/org/apache/maven/plugins/gpg/class-use/ apidocs/org/apache/maven/plugins/maven_gpg_plugin/ api...

Modified: maven/website/components/plugins-archives/maven-gpg-plugin-LATEST/xref/org/apache/maven/plugins/gpg/AbstractGpgSigner.html
==============================================================================
--- maven/website/components/plugins-archives/maven-gpg-plugin-LATEST/xref/org/apache/maven/plugins/gpg/AbstractGpgSigner.html (original)
+++ maven/website/components/plugins-archives/maven-gpg-plugin-LATEST/xref/org/apache/maven/plugins/gpg/AbstractGpgSigner.html Sat Mar 23 21:59:19 2024
@@ -132,74 +132,88 @@
 <a class="jxr_linenumber" name="L124" href="#L124">124</a> 
 <a class="jxr_linenumber" name="L125" href="#L125">125</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> String signerName();
 <a class="jxr_linenumber" name="L126" href="#L126">126</a> 
-<a class="jxr_linenumber" name="L127" href="#L127">127</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> prepare() <strong class="jxr_keyword">throws</strong> MojoFailureException {}
-<a class="jxr_linenumber" name="L128" href="#L128">128</a> 
-<a class="jxr_linenumber" name="L129" href="#L129">129</a>     <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment">     * Create a detached signature file for the provided file.</em>
-<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment">     *</em>
-<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment">     * @param file The file to sign</em>
-<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment">     * @return A reference to the generated signature file</em>
-<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment">     * @throws MojoExecutionException if signature generation fails</em>
-<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment">     */</em>
-<a class="jxr_linenumber" name="L136" href="#L136">136</a>     <strong class="jxr_keyword">public</strong> File generateSignatureForArtifact(File file) <strong class="jxr_keyword">throws</strong> MojoExecutionException {
-<a class="jxr_linenumber" name="L137" href="#L137">137</a>         <em class="jxr_comment">// ----------------------------------------------------------------------------</em>
-<a class="jxr_linenumber" name="L138" href="#L138">138</a>         <em class="jxr_comment">// Set up the file and directory for the signature file</em>
-<a class="jxr_linenumber" name="L139" href="#L139">139</a>         <em class="jxr_comment">// ----------------------------------------------------------------------------</em>
-<a class="jxr_linenumber" name="L140" href="#L140">140</a> 
-<a class="jxr_linenumber" name="L141" href="#L141">141</a>         File signature = <strong class="jxr_keyword">new</strong> File(file + SIGNATURE_EXTENSION);
-<a class="jxr_linenumber" name="L142" href="#L142">142</a> 
-<a class="jxr_linenumber" name="L143" href="#L143">143</a>         <strong class="jxr_keyword">boolean</strong> isInBuildDir = false;
-<a class="jxr_linenumber" name="L144" href="#L144">144</a>         <strong class="jxr_keyword">if</strong> (buildDir != <strong class="jxr_keyword">null</strong>) {
-<a class="jxr_linenumber" name="L145" href="#L145">145</a>             File parent = signature.getParentFile();
-<a class="jxr_linenumber" name="L146" href="#L146">146</a>             <strong class="jxr_keyword">if</strong> (buildDir.equals(parent)) {
-<a class="jxr_linenumber" name="L147" href="#L147">147</a>                 isInBuildDir = <strong class="jxr_keyword">true</strong>;
-<a class="jxr_linenumber" name="L148" href="#L148">148</a>             }
-<a class="jxr_linenumber" name="L149" href="#L149">149</a>         }
-<a class="jxr_linenumber" name="L150" href="#L150">150</a>         <strong class="jxr_keyword">if</strong> (!isInBuildDir &amp;&amp; outputDir != <strong class="jxr_keyword">null</strong>) {
-<a class="jxr_linenumber" name="L151" href="#L151">151</a>             String fileDirectory = <span class="jxr_string">""</span>;
-<a class="jxr_linenumber" name="L152" href="#L152">152</a>             File signatureDirectory = signature;
-<a class="jxr_linenumber" name="L153" href="#L153">153</a> 
-<a class="jxr_linenumber" name="L154" href="#L154">154</a>             <strong class="jxr_keyword">while</strong> ((signatureDirectory = signatureDirectory.getParentFile()) != <strong class="jxr_keyword">null</strong>) {
-<a class="jxr_linenumber" name="L155" href="#L155">155</a>                 <strong class="jxr_keyword">if</strong> (isPossibleRootOfArtifact(signatureDirectory)) {
-<a class="jxr_linenumber" name="L156" href="#L156">156</a>                     <strong class="jxr_keyword">break</strong>;
-<a class="jxr_linenumber" name="L157" href="#L157">157</a>                 }
-<a class="jxr_linenumber" name="L158" href="#L158">158</a>                 fileDirectory = signatureDirectory.getName() + File.separatorChar + fileDirectory;
-<a class="jxr_linenumber" name="L159" href="#L159">159</a>             }
-<a class="jxr_linenumber" name="L160" href="#L160">160</a>             signatureDirectory = <strong class="jxr_keyword">new</strong> File(outputDir, fileDirectory);
-<a class="jxr_linenumber" name="L161" href="#L161">161</a>             <strong class="jxr_keyword">if</strong> (!signatureDirectory.exists()) {
-<a class="jxr_linenumber" name="L162" href="#L162">162</a>                 signatureDirectory.mkdirs();
-<a class="jxr_linenumber" name="L163" href="#L163">163</a>             }
-<a class="jxr_linenumber" name="L164" href="#L164">164</a>             signature = <strong class="jxr_keyword">new</strong> File(signatureDirectory, file.getName() + SIGNATURE_EXTENSION);
-<a class="jxr_linenumber" name="L165" href="#L165">165</a>         }
-<a class="jxr_linenumber" name="L166" href="#L166">166</a> 
-<a class="jxr_linenumber" name="L167" href="#L167">167</a>         <strong class="jxr_keyword">if</strong> (signature.exists()) {
-<a class="jxr_linenumber" name="L168" href="#L168">168</a>             signature.delete();
-<a class="jxr_linenumber" name="L169" href="#L169">169</a>         }
-<a class="jxr_linenumber" name="L170" href="#L170">170</a> 
-<a class="jxr_linenumber" name="L171" href="#L171">171</a>         <em class="jxr_comment">// ----------------------------------------------------------------------------</em>
-<a class="jxr_linenumber" name="L172" href="#L172">172</a>         <em class="jxr_comment">// Generate the signature file</em>
-<a class="jxr_linenumber" name="L173" href="#L173">173</a>         <em class="jxr_comment">// ----------------------------------------------------------------------------</em>
-<a class="jxr_linenumber" name="L174" href="#L174">174</a> 
-<a class="jxr_linenumber" name="L175" href="#L175">175</a>         generateSignatureForFile(file, signature);
-<a class="jxr_linenumber" name="L176" href="#L176">176</a> 
-<a class="jxr_linenumber" name="L177" href="#L177">177</a>         <strong class="jxr_keyword">return</strong> signature;
-<a class="jxr_linenumber" name="L178" href="#L178">178</a>     }
-<a class="jxr_linenumber" name="L179" href="#L179">179</a> 
-<a class="jxr_linenumber" name="L180" href="#L180">180</a>     <em class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L181" href="#L181">181</a> <em class="jxr_javadoccomment">     * Generate the detached signature file for the provided file.</em>
-<a class="jxr_linenumber" name="L182" href="#L182">182</a> <em class="jxr_javadoccomment">     *</em>
-<a class="jxr_linenumber" name="L183" href="#L183">183</a> <em class="jxr_javadoccomment">     * @param file The file to sign</em>
-<a class="jxr_linenumber" name="L184" href="#L184">184</a> <em class="jxr_javadoccomment">     * @param signature The file in which the generate signature will be put</em>
-<a class="jxr_linenumber" name="L185" href="#L185">185</a> <em class="jxr_javadoccomment">     * @throws MojoExecutionException if signature generation fails</em>
-<a class="jxr_linenumber" name="L186" href="#L186">186</a> <em class="jxr_javadoccomment">     */</em>
-<a class="jxr_linenumber" name="L187" href="#L187">187</a>     <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">void</strong> generateSignatureForFile(File file, File signature) <strong class="jxr_keyword">throws</strong> MojoExecutionException;
+<a class="jxr_linenumber" name="L127" href="#L127">127</a>     <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment">     * Must be invoked BEFORE signing!</em>
+<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment">     *</em>
+<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment">     * @since 3.2.0</em>
+<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment">     */</em>
+<a class="jxr_linenumber" name="L132" href="#L132">132</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> prepare() <strong class="jxr_keyword">throws</strong> MojoFailureException {}
+<a class="jxr_linenumber" name="L133" href="#L133">133</a> 
+<a class="jxr_linenumber" name="L134" href="#L134">134</a>     <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment">     * Should return some identification about the used key for logging purposes.</em>
+<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment">     * Can be invoked only AFTER {@link #prepare()} was invoked.</em>
+<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment">     *</em>
+<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment">     * @since 3.2.2</em>
+<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_javadoccomment">     */</em>
+<a class="jxr_linenumber" name="L140" href="#L140">140</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> String getKeyInfo();
+<a class="jxr_linenumber" name="L141" href="#L141">141</a> 
+<a class="jxr_linenumber" name="L142" href="#L142">142</a>     <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_javadoccomment">     * Create a detached signature file for the provided file.</em>
+<a class="jxr_linenumber" name="L144" href="#L144">144</a> <em class="jxr_javadoccomment">     * Can be invoked only AFTER {@link #prepare()} was invoked.</em>
+<a class="jxr_linenumber" name="L145" href="#L145">145</a> <em class="jxr_javadoccomment">     *</em>
+<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment">     * @param file The file to sign</em>
+<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment">     * @return A reference to the generated signature file</em>
+<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment">     * @throws MojoExecutionException if signature generation fails</em>
+<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment">     */</em>
+<a class="jxr_linenumber" name="L150" href="#L150">150</a>     <strong class="jxr_keyword">public</strong> File generateSignatureForArtifact(File file) <strong class="jxr_keyword">throws</strong> MojoExecutionException {
+<a class="jxr_linenumber" name="L151" href="#L151">151</a>         <em class="jxr_comment">// ----------------------------------------------------------------------------</em>
+<a class="jxr_linenumber" name="L152" href="#L152">152</a>         <em class="jxr_comment">// Set up the file and directory for the signature file</em>
+<a class="jxr_linenumber" name="L153" href="#L153">153</a>         <em class="jxr_comment">// ----------------------------------------------------------------------------</em>
+<a class="jxr_linenumber" name="L154" href="#L154">154</a> 
+<a class="jxr_linenumber" name="L155" href="#L155">155</a>         File signature = <strong class="jxr_keyword">new</strong> File(file + SIGNATURE_EXTENSION);
+<a class="jxr_linenumber" name="L156" href="#L156">156</a> 
+<a class="jxr_linenumber" name="L157" href="#L157">157</a>         <strong class="jxr_keyword">boolean</strong> isInBuildDir = false;
+<a class="jxr_linenumber" name="L158" href="#L158">158</a>         <strong class="jxr_keyword">if</strong> (buildDir != <strong class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="L159" href="#L159">159</a>             File parent = signature.getParentFile();
+<a class="jxr_linenumber" name="L160" href="#L160">160</a>             <strong class="jxr_keyword">if</strong> (buildDir.equals(parent)) {
+<a class="jxr_linenumber" name="L161" href="#L161">161</a>                 isInBuildDir = <strong class="jxr_keyword">true</strong>;
+<a class="jxr_linenumber" name="L162" href="#L162">162</a>             }
+<a class="jxr_linenumber" name="L163" href="#L163">163</a>         }
+<a class="jxr_linenumber" name="L164" href="#L164">164</a>         <strong class="jxr_keyword">if</strong> (!isInBuildDir &amp;&amp; outputDir != <strong class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="L165" href="#L165">165</a>             String fileDirectory = <span class="jxr_string">""</span>;
+<a class="jxr_linenumber" name="L166" href="#L166">166</a>             File signatureDirectory = signature;
+<a class="jxr_linenumber" name="L167" href="#L167">167</a> 
+<a class="jxr_linenumber" name="L168" href="#L168">168</a>             <strong class="jxr_keyword">while</strong> ((signatureDirectory = signatureDirectory.getParentFile()) != <strong class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="L169" href="#L169">169</a>                 <strong class="jxr_keyword">if</strong> (isPossibleRootOfArtifact(signatureDirectory)) {
+<a class="jxr_linenumber" name="L170" href="#L170">170</a>                     <strong class="jxr_keyword">break</strong>;
+<a class="jxr_linenumber" name="L171" href="#L171">171</a>                 }
+<a class="jxr_linenumber" name="L172" href="#L172">172</a>                 fileDirectory = signatureDirectory.getName() + File.separatorChar + fileDirectory;
+<a class="jxr_linenumber" name="L173" href="#L173">173</a>             }
+<a class="jxr_linenumber" name="L174" href="#L174">174</a>             signatureDirectory = <strong class="jxr_keyword">new</strong> File(outputDir, fileDirectory);
+<a class="jxr_linenumber" name="L175" href="#L175">175</a>             <strong class="jxr_keyword">if</strong> (!signatureDirectory.exists()) {
+<a class="jxr_linenumber" name="L176" href="#L176">176</a>                 signatureDirectory.mkdirs();
+<a class="jxr_linenumber" name="L177" href="#L177">177</a>             }
+<a class="jxr_linenumber" name="L178" href="#L178">178</a>             signature = <strong class="jxr_keyword">new</strong> File(signatureDirectory, file.getName() + SIGNATURE_EXTENSION);
+<a class="jxr_linenumber" name="L179" href="#L179">179</a>         }
+<a class="jxr_linenumber" name="L180" href="#L180">180</a> 
+<a class="jxr_linenumber" name="L181" href="#L181">181</a>         <strong class="jxr_keyword">if</strong> (signature.exists()) {
+<a class="jxr_linenumber" name="L182" href="#L182">182</a>             signature.delete();
+<a class="jxr_linenumber" name="L183" href="#L183">183</a>         }
+<a class="jxr_linenumber" name="L184" href="#L184">184</a> 
+<a class="jxr_linenumber" name="L185" href="#L185">185</a>         <em class="jxr_comment">// ----------------------------------------------------------------------------</em>
+<a class="jxr_linenumber" name="L186" href="#L186">186</a>         <em class="jxr_comment">// Generate the signature file</em>
+<a class="jxr_linenumber" name="L187" href="#L187">187</a>         <em class="jxr_comment">// ----------------------------------------------------------------------------</em>
 <a class="jxr_linenumber" name="L188" href="#L188">188</a> 
-<a class="jxr_linenumber" name="L189" href="#L189">189</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> isPossibleRootOfArtifact(File signatureDirectory) {
-<a class="jxr_linenumber" name="L190" href="#L190">190</a>         <strong class="jxr_keyword">return</strong> signatureDirectory.equals(outputDir)
-<a class="jxr_linenumber" name="L191" href="#L191">191</a>                 || signatureDirectory.equals(buildDir)
-<a class="jxr_linenumber" name="L192" href="#L192">192</a>                 || signatureDirectory.equals(baseDir);
-<a class="jxr_linenumber" name="L193" href="#L193">193</a>     }
-<a class="jxr_linenumber" name="L194" href="#L194">194</a> }
+<a class="jxr_linenumber" name="L189" href="#L189">189</a>         generateSignatureForFile(file, signature);
+<a class="jxr_linenumber" name="L190" href="#L190">190</a> 
+<a class="jxr_linenumber" name="L191" href="#L191">191</a>         <strong class="jxr_keyword">return</strong> signature;
+<a class="jxr_linenumber" name="L192" href="#L192">192</a>     }
+<a class="jxr_linenumber" name="L193" href="#L193">193</a> 
+<a class="jxr_linenumber" name="L194" href="#L194">194</a>     <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L195" href="#L195">195</a> <em class="jxr_javadoccomment">     * Generate the detached signature file for the provided file.</em>
+<a class="jxr_linenumber" name="L196" href="#L196">196</a> <em class="jxr_javadoccomment">     *</em>
+<a class="jxr_linenumber" name="L197" href="#L197">197</a> <em class="jxr_javadoccomment">     * @param file The file to sign</em>
+<a class="jxr_linenumber" name="L198" href="#L198">198</a> <em class="jxr_javadoccomment">     * @param signature The file in which the generate signature will be put</em>
+<a class="jxr_linenumber" name="L199" href="#L199">199</a> <em class="jxr_javadoccomment">     * @throws MojoExecutionException if signature generation fails</em>
+<a class="jxr_linenumber" name="L200" href="#L200">200</a> <em class="jxr_javadoccomment">     */</em>
+<a class="jxr_linenumber" name="L201" href="#L201">201</a>     <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">void</strong> generateSignatureForFile(File file, File signature) <strong class="jxr_keyword">throws</strong> MojoExecutionException;
+<a class="jxr_linenumber" name="L202" href="#L202">202</a> 
+<a class="jxr_linenumber" name="L203" href="#L203">203</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> isPossibleRootOfArtifact(File signatureDirectory) {
+<a class="jxr_linenumber" name="L204" href="#L204">204</a>         <strong class="jxr_keyword">return</strong> signatureDirectory.equals(outputDir)
+<a class="jxr_linenumber" name="L205" href="#L205">205</a>                 || signatureDirectory.equals(buildDir)
+<a class="jxr_linenumber" name="L206" href="#L206">206</a>                 || signatureDirectory.equals(baseDir);
+<a class="jxr_linenumber" name="L207" href="#L207">207</a>     }
+<a class="jxr_linenumber" name="L208" href="#L208">208</a> }
 </pre>
 <hr/>
 <div id="footer">Copyright &#169; 2002&#x2013;2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>