| <!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=UTF-8"> |
| <title>ChecksummedFile (Archiva :: Modules 2.2.8 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="ChecksummedFile (Archiva :: Modules 2.2.8 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":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/ChecksummedFile.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><a href="../../../../org/apache/archiva/checksum/ChecksumAlgorithm.html" title="enum in org.apache.archiva.checksum"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/archiva/checksum/Hex.html" title="class in org.apache.archiva.checksum"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/archiva/checksum/ChecksummedFile.html" target="_top">Frames</a></li> |
| <li><a href="ChecksummedFile.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.archiva.checksum</div> |
| <h2 title="Class ChecksummedFile" class="title">Class ChecksummedFile</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <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.archiva.checksum.ChecksummedFile</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <a href="../../../../src-html/org/apache/archiva/checksum/ChecksummedFile.html#line.50">ChecksummedFile</a> |
| extends <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></pre> |
| <div class="block">ChecksummedFile |
| <p>Terminology:</p> |
| <dl> |
| <dt>Checksum File</dt> |
| <dd>The file that contains the previously calculated checksum value for the reference file. |
| This is a text file with the extension ".sha1" or ".md5", and contains a single entry |
| consisting of an optional reference filename, and a checksum string. |
| </dd> |
| <dt>Reference File</dt> |
| <dd>The file that is being referenced in the checksum file.</dd> |
| </dl></div> |
| </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 org.slf4j.Logger</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/archiva/checksum/ChecksummedFile.html#log">log</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>private static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html?is-external=true" title="class or interface in java.util.regex">Pattern</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/archiva/checksum/ChecksummedFile.html#METADATA_PATTERN">METADATA_PATTERN</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <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/archiva/checksum/ChecksummedFile.html#referenceFile">referenceFile</a></span></code> </td> |
| </tr> |
| </table> |
| </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/archiva/checksum/ChecksummedFile.html#ChecksummedFile-java.io.File-">ChecksummedFile</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> referenceFile)</code> |
| <div class="block">Construct a ChecksummedFile object.</div> |
| </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><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/archiva/checksum/ChecksummedFile.html#calculateChecksum-org.apache.archiva.checksum.ChecksumAlgorithm-">calculateChecksum</a></span>(<a href="../../../../org/apache/archiva/checksum/ChecksumAlgorithm.html" title="enum in org.apache.archiva.checksum">ChecksumAlgorithm</a> checksumAlgorithm)</code> |
| <div class="block">Calculate the checksum based on a given checksum.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><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/archiva/checksum/ChecksummedFile.html#createChecksum-org.apache.archiva.checksum.ChecksumAlgorithm-">createChecksum</a></span>(<a href="../../../../org/apache/archiva/checksum/ChecksumAlgorithm.html" title="enum in org.apache.archiva.checksum">ChecksumAlgorithm</a> checksumAlgorithm)</code> |
| <div class="block">Creates a checksum file of the provided referenceFile.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/archiva/checksum/ChecksummedFile.html#fixChecksums-org.apache.archiva.checksum.ChecksumAlgorithm:A-">fixChecksums</a></span>(<a href="../../../../org/apache/archiva/checksum/ChecksumAlgorithm.html" title="enum in org.apache.archiva.checksum">ChecksumAlgorithm</a>[] algorithms)</code> |
| <div class="block">Fix or create checksum files for the reference file.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><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/archiva/checksum/ChecksummedFile.html#getChecksumFile-org.apache.archiva.checksum.ChecksumAlgorithm-">getChecksumFile</a></span>(<a href="../../../../org/apache/archiva/checksum/ChecksumAlgorithm.html" title="enum in org.apache.archiva.checksum">ChecksumAlgorithm</a> checksumAlgorithm)</code> |
| <div class="block">Get the checksum file for the reference file and hash.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/archiva/checksum/ChecksummedFile.html#isValidChecksum-org.apache.archiva.checksum.ChecksumAlgorithm-">isValidChecksum</a></span>(<a href="../../../../org/apache/archiva/checksum/ChecksumAlgorithm.html" title="enum in org.apache.archiva.checksum">ChecksumAlgorithm</a> algorithm)</code> |
| <div class="block"> |
| Given a checksum file, check to see if the file it represents is valid according to the checksum.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>private boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/archiva/checksum/ChecksummedFile.html#isValidChecksumPattern-java.lang.String-java.lang.String-">isValidChecksumPattern</a></span>(<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> filename, |
| <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> path)</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/archiva/checksum/ChecksummedFile.html#isValidChecksums-org.apache.archiva.checksum.ChecksumAlgorithm:A-">isValidChecksums</a></span>(<a href="../../../../org/apache/archiva/checksum/ChecksumAlgorithm.html" title="enum in org.apache.archiva.checksum">ChecksumAlgorithm</a>[] algorithms)</code> |
| <div class="block">Of any checksum files present, validate that the reference file conforms |
| the to the checksum.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><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">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/archiva/checksum/ChecksummedFile.html#parseChecksum-java.lang.String-org.apache.archiva.checksum.ChecksumAlgorithm-java.lang.String-">parseChecksum</a></span>(<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> rawChecksumString, |
| <a href="../../../../org/apache/archiva/checksum/ChecksumAlgorithm.html" title="enum in org.apache.archiva.checksum">ChecksumAlgorithm</a> expectedHash, |
| <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> expectedPath)</code> |
| <div class="block">Parse a checksum string.</div> |
| </td> |
| </tr> |
| </table> |
| <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/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/java/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> |
| </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="log"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>log</h4> |
| <pre>private final org.slf4j.Logger <a href="../../../../src-html/org/apache/archiva/checksum/ChecksummedFile.html#line.52">log</a></pre> |
| </li> |
| </ul> |
| <a name="METADATA_PATTERN"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>METADATA_PATTERN</h4> |
| <pre>private static final <a href="https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html?is-external=true" title="class or interface in java.util.regex">Pattern</a> <a href="../../../../src-html/org/apache/archiva/checksum/ChecksummedFile.html#line.54">METADATA_PATTERN</a></pre> |
| </li> |
| </ul> |
| <a name="referenceFile"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>referenceFile</h4> |
| <pre>private final <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/archiva/checksum/ChecksummedFile.html#line.56">referenceFile</a></pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="ChecksummedFile-java.io.File-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ChecksummedFile</h4> |
| <pre>public <a href="../../../../src-html/org/apache/archiva/checksum/ChecksummedFile.html#line.63">ChecksummedFile</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> referenceFile)</pre> |
| <div class="block">Construct a ChecksummedFile object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>referenceFile</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="calculateChecksum-org.apache.archiva.checksum.ChecksumAlgorithm-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>calculateChecksum</h4> |
| <pre>public <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/archiva/checksum/ChecksummedFile.html#line.75">calculateChecksum</a>(<a href="../../../../org/apache/archiva/checksum/ChecksumAlgorithm.html" title="enum in org.apache.archiva.checksum">ChecksumAlgorithm</a> checksumAlgorithm) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Calculate the checksum based on a given checksum.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>checksumAlgorithm</code> - the algorithm to use.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the checksum string for the file.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if unable to calculate the checksum.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createChecksum-org.apache.archiva.checksum.ChecksumAlgorithm-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createChecksum</h4> |
| <pre>public <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/archiva/checksum/ChecksummedFile.html#line.94">createChecksum</a>(<a href="../../../../org/apache/archiva/checksum/ChecksumAlgorithm.html" title="enum in org.apache.archiva.checksum">ChecksumAlgorithm</a> checksumAlgorithm) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Creates a checksum file of the provided referenceFile.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>checksumAlgorithm</code> - the hash to use.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the checksum File that was created.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if there was a problem either reading the referenceFile, or writing the checksum file.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getChecksumFile-org.apache.archiva.checksum.ChecksumAlgorithm-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getChecksumFile</h4> |
| <pre>public <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/archiva/checksum/ChecksummedFile.html#line.112">getChecksumFile</a>(<a href="../../../../org/apache/archiva/checksum/ChecksumAlgorithm.html" title="enum in org.apache.archiva.checksum">ChecksumAlgorithm</a> checksumAlgorithm)</pre> |
| <div class="block">Get the checksum file for the reference file and hash.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>checksumAlgorithm</code> - the hash that we are interested in.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the checksum file to return</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isValidChecksum-org.apache.archiva.checksum.ChecksumAlgorithm-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isValidChecksum</h4> |
| <pre>public boolean <a href="../../../../src-html/org/apache/archiva/checksum/ChecksummedFile.html#line.129">isValidChecksum</a>(<a href="../../../../org/apache/archiva/checksum/ChecksumAlgorithm.html" title="enum in org.apache.archiva.checksum">ChecksumAlgorithm</a> algorithm) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block"><p> |
| Given a checksum file, check to see if the file it represents is valid according to the checksum. |
| </p> |
| <p> |
| NOTE: Only supports single file checksums of type MD5 or SHA1. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>algorithm</code> - the algorithms to check for.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the checksum is valid for the file it represents. or if the checksum file does not exist.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if the reading of the checksumFile or the file it refers to fails.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isValidChecksums-org.apache.archiva.checksum.ChecksumAlgorithm:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isValidChecksums</h4> |
| <pre>public boolean <a href="../../../../src-html/org/apache/archiva/checksum/ChecksummedFile.html#line.142">isValidChecksums</a>(<a href="../../../../org/apache/archiva/checksum/ChecksumAlgorithm.html" title="enum in org.apache.archiva.checksum">ChecksumAlgorithm</a>[] algorithms)</pre> |
| <div class="block">Of any checksum files present, validate that the reference file conforms |
| the to the checksum.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>algorithms</code> - the algorithms to check for.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the checksums report that the the reference file is valid, false if invalid.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="fixChecksums-org.apache.archiva.checksum.ChecksumAlgorithm:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fixChecksums</h4> |
| <pre>public boolean <a href="../../../../src-html/org/apache/archiva/checksum/ChecksummedFile.html#line.218">fixChecksums</a>(<a href="../../../../org/apache/archiva/checksum/ChecksumAlgorithm.html" title="enum in org.apache.archiva.checksum">ChecksumAlgorithm</a>[] algorithms)</pre> |
| <div class="block">Fix or create checksum files for the reference file.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>algorithms</code> - the hashes to check for.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if checksums were created successfully.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isValidChecksumPattern-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isValidChecksumPattern</h4> |
| <pre>private boolean <a href="../../../../src-html/org/apache/archiva/checksum/ChecksummedFile.html#line.283">isValidChecksumPattern</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> filename, |
| <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> path)</pre> |
| </li> |
| </ul> |
| <a name="parseChecksum-java.lang.String-org.apache.archiva.checksum.ChecksumAlgorithm-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>parseChecksum</h4> |
| <pre>public <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/archiva/checksum/ChecksummedFile.html#line.309">parseChecksum</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> rawChecksumString, |
| <a href="../../../../org/apache/archiva/checksum/ChecksumAlgorithm.html" title="enum in org.apache.archiva.checksum">ChecksumAlgorithm</a> expectedHash, |
| <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> expectedPath) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Parse a checksum string. |
| <p> |
| Validate the expected path, and expected checksum algorithm, then return |
| the trimmed checksum hex string. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rawChecksumString</code> - </dd> |
| <dd><code>expectedHash</code> - </dd> |
| <dd><code>expectedPath</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></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/ChecksummedFile.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><a href="../../../../org/apache/archiva/checksum/ChecksumAlgorithm.html" title="enum in org.apache.archiva.checksum"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/archiva/checksum/Hex.html" title="class in org.apache.archiva.checksum"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/archiva/checksum/ChecksummedFile.html" target="_top">Frames</a></li> |
| <li><a href="ChecksummedFile.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 © 2006–2022 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
