blob: 079256460c3206a6519dfaaa360601978140f5b7 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ChecksummedFile (Archiva :: Modules 3.0.0-SNAPSHOT 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 3.0.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":9,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/ChecksumFileContent.html" title="class in org.apache.archiva.checksum"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/archiva/checksum/ChecksumReference.html" title="class in org.apache.archiva.checksum"><span class="typeNameLink">Next&nbsp;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&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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.54">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">
<!-- ======== 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">&nbsp;</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.nio.file.Path-">ChecksummedFile</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html?is-external=true" title="class or interface in java.nio.file">Path</a>&nbsp;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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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>&nbsp;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="../../../../org/apache/archiva/checksum/UpdateStatusList.html" title="class in org.apache.archiva.checksum">UpdateStatusList</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/archiva/checksum/ChecksummedFile.html#fixChecksum-org.apache.archiva.checksum.ChecksumAlgorithm-">fixChecksum</a></span>(<a href="../../../../org/apache/archiva/checksum/ChecksumAlgorithm.html" title="enum in org.apache.archiva.checksum">ChecksumAlgorithm</a>&nbsp;algorithm)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/archiva/checksum/UpdateStatusList.html" title="class in org.apache.archiva.checksum">UpdateStatusList</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/archiva/checksum/ChecksummedFile.html#fixChecksums-java.util.List-">fixChecksums</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/archiva/checksum/ChecksumAlgorithm.html" title="enum in org.apache.archiva.checksum">ChecksumAlgorithm</a>&gt;&nbsp;algorithms)</code>
<div class="block">Writes a checksum file, if it does not exist or if it exists and has a different
checksum value.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html?is-external=true" title="class or interface in java.nio.file">Path</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>&nbsp;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>static <a href="../../../../org/apache/archiva/checksum/ChecksumReference.html" title="class in org.apache.archiva.checksum">ChecksumReference</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/archiva/checksum/ChecksummedFile.html#getFromChecksumFile-java.nio.file.Path-">getFromChecksumFile</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html?is-external=true" title="class or interface in java.nio.file">Path</a>&nbsp;checksumFile)</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html?is-external=true" title="class or interface in java.nio.file">Path</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/archiva/checksum/ChecksummedFile.html#getReferenceFile--">getReferenceFile</a></span>()</code>&nbsp;</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#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>&nbsp;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="i7" class="rowColor">
<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-boolean-">isValidChecksum</a></span>(<a href="../../../../org/apache/archiva/checksum/ChecksumAlgorithm.html" title="enum in org.apache.archiva.checksum">ChecksumAlgorithm</a>&nbsp;algorithm,
boolean&nbsp;throwExceptions)</code>&nbsp;</td>
</tr>
<tr id="i8" 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-java.util.List-">isValidChecksums</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/archiva/checksum/ChecksumAlgorithm.html" title="enum in org.apache.archiva.checksum">ChecksumAlgorithm</a>&gt;&nbsp;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="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/archiva/checksum/ChecksummedFile.html#isValidChecksums-java.util.List-boolean-">isValidChecksums</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/archiva/checksum/ChecksumAlgorithm.html" title="enum in org.apache.archiva.checksum">ChecksumAlgorithm</a>&gt;&nbsp;algorithms,
boolean&nbsp;throwExceptions)</code>
<div class="block">Checks if the checksum files are valid for the referenced file.</div>
</td>
</tr>
<tr id="i10" 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#parseChecksum-java.nio.file.Path-org.apache.archiva.checksum.ChecksumAlgorithm-java.lang.String-java.nio.charset.Charset-">parseChecksum</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html?is-external=true" title="class or interface in java.nio.file">Path</a>&nbsp;checksumFile,
<a href="../../../../org/apache/archiva/checksum/ChecksumAlgorithm.html" title="enum in org.apache.archiva.checksum">ChecksumAlgorithm</a>&nbsp;checksumAlgorithm,
<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>&nbsp;fileName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a>&nbsp;encoding)</code>
<div class="block">Parse a checksum string.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/archiva/checksum/ChecksumFileContent.html" title="class in org.apache.archiva.checksum">ChecksumFileContent</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/archiva/checksum/ChecksummedFile.html#parseChecksumFile-java.nio.file.Path-org.apache.archiva.checksum.ChecksumAlgorithm-java.nio.charset.Charset-">parseChecksumFile</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html?is-external=true" title="class or interface in java.nio.file">Path</a>&nbsp;checksumFile,
<a href="../../../../org/apache/archiva/checksum/ChecksumAlgorithm.html" title="enum in org.apache.archiva.checksum">ChecksumAlgorithm</a>&nbsp;checksumAlgorithm,
<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a>&nbsp;encoding)</code>&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html?is-external=true" title="class or interface in java.nio.file">Path</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/archiva/checksum/ChecksummedFile.html#writeFile-org.apache.archiva.checksum.ChecksumAlgorithm-">writeFile</a></span>(<a href="../../../../org/apache/archiva/checksum/ChecksumAlgorithm.html" title="enum in org.apache.archiva.checksum">ChecksumAlgorithm</a>&nbsp;checksumAlgorithm)</code>
<div class="block">Writes a checksum file for the referenceFile.</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&nbsp;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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ChecksummedFile-java.nio.file.Path-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ChecksummedFile</h4>
<pre>public&nbsp;<a href="../../../../src-html/org/apache/archiva/checksum/ChecksummedFile.html#line.70">ChecksummedFile</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html?is-external=true" title="class or interface in java.nio.file">Path</a>&nbsp;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="getFromChecksumFile-java.nio.file.Path-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFromChecksumFile</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/archiva/checksum/ChecksumReference.html" title="class in org.apache.archiva.checksum">ChecksumReference</a>&nbsp;<a href="../../../../src-html/org/apache/archiva/checksum/ChecksummedFile.html#line.76">getFromChecksumFile</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html?is-external=true" title="class or interface in java.nio.file">Path</a>&nbsp;checksumFile)</pre>
</li>
</ul>
<a name="calculateChecksum-org.apache.archiva.checksum.ChecksumAlgorithm-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>calculateChecksum</h4>
<pre>public&nbsp;<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>&nbsp;<a href="../../../../src-html/org/apache/archiva/checksum/ChecksummedFile.html#line.96">calculateChecksum</a>(<a href="../../../../org/apache/archiva/checksum/ChecksumAlgorithm.html" title="enum in org.apache.archiva.checksum">ChecksumAlgorithm</a>&nbsp;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="writeFile-org.apache.archiva.checksum.ChecksumAlgorithm-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeFile</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html?is-external=true" title="class or interface in java.nio.file">Path</a>&nbsp;<a href="../../../../src-html/org/apache/archiva/checksum/ChecksummedFile.html#line.112">writeFile</a>(<a href="../../../../org/apache/archiva/checksum/ChecksumAlgorithm.html" title="enum in org.apache.archiva.checksum">ChecksumAlgorithm</a>&nbsp;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">Writes a checksum file for the 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&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html?is-external=true" title="class or interface in java.nio.file">Path</a>&nbsp;<a href="../../../../src-html/org/apache/archiva/checksum/ChecksummedFile.html#line.132">getChecksumFile</a>(<a href="../../../../org/apache/archiva/checksum/ChecksumAlgorithm.html" title="enum in org.apache.archiva.checksum">ChecksumAlgorithm</a>&nbsp;checksumAlgorithm)</pre>
<div class="block">Get the checksum file for the reference file and hash.
It returns a file for the given checksum, if one exists with one of the possible extensions.
If it does not exist, a default path will be returned.</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&nbsp;boolean&nbsp;<a href="../../../../src-html/org/apache/archiva/checksum/ChecksummedFile.html#line.157">isValidChecksum</a>(<a href="../../../../org/apache/archiva/checksum/ChecksumAlgorithm.html" title="enum in org.apache.archiva.checksum">ChecksumAlgorithm</a>&nbsp;algorithm)
throws <a href="../../../../org/apache/archiva/checksum/ChecksumValidationException.html" title="class in org.apache.archiva.checksum">ChecksumValidationException</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>
<dd><code><a href="../../../../org/apache/archiva/checksum/ChecksumValidationException.html" title="class in org.apache.archiva.checksum">ChecksumValidationException</a></code></dd>
</dl>
</li>
</ul>
<a name="isValidChecksum-org.apache.archiva.checksum.ChecksumAlgorithm-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isValidChecksum</h4>
<pre>public&nbsp;boolean&nbsp;<a href="../../../../src-html/org/apache/archiva/checksum/ChecksummedFile.html#line.161">isValidChecksum</a>(<a href="../../../../org/apache/archiva/checksum/ChecksumAlgorithm.html" title="enum in org.apache.archiva.checksum">ChecksumAlgorithm</a>&nbsp;algorithm,
boolean&nbsp;throwExceptions)
throws <a href="../../../../org/apache/archiva/checksum/ChecksumValidationException.html" title="class in org.apache.archiva.checksum">ChecksumValidationException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/archiva/checksum/ChecksumValidationException.html" title="class in org.apache.archiva.checksum">ChecksumValidationException</a></code></dd>
</dl>
</li>
</ul>
<a name="isValidChecksums-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isValidChecksums</h4>
<pre>public&nbsp;boolean&nbsp;<a href="../../../../src-html/org/apache/archiva/checksum/ChecksummedFile.html#line.174">isValidChecksums</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/archiva/checksum/ChecksumAlgorithm.html" title="enum in org.apache.archiva.checksum">ChecksumAlgorithm</a>&gt;&nbsp;algorithms)
throws <a href="../../../../org/apache/archiva/checksum/ChecksumValidationException.html" title="class in org.apache.archiva.checksum">ChecksumValidationException</a></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>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/archiva/checksum/ChecksumValidationException.html" title="class in org.apache.archiva.checksum">ChecksumValidationException</a></code></dd>
</dl>
</li>
</ul>
<a name="isValidChecksums-java.util.List-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isValidChecksums</h4>
<pre>public&nbsp;boolean&nbsp;<a href="../../../../src-html/org/apache/archiva/checksum/ChecksummedFile.html#line.195">isValidChecksums</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/archiva/checksum/ChecksumAlgorithm.html" title="enum in org.apache.archiva.checksum">ChecksumAlgorithm</a>&gt;&nbsp;algorithms,
boolean&nbsp;throwExceptions)
throws <a href="../../../../org/apache/archiva/checksum/ChecksumValidationException.html" title="class in org.apache.archiva.checksum">ChecksumValidationException</a></pre>
<div class="block">Checks if the checksum files are valid for the referenced file.
It tries to find a checksum file for each algorithm in the same directory as the referenceFile.
The method returns true, if at least one checksum file exists for one of the given algorithms
and all existing checksum files are valid.
This method throws only exceptions, if throwExceptions is true. Otherwise false will be returned instead.
It verifies only the existing checksum files. If the checksum file for a particular algorithm does not exist,
but others exist and are valid, it will return true.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>algorithms</code> - The algorithms to verify</dd>
<dd><code>throwExceptions</code> - If true, exceptions will be thrown, otherwise false will be returned, if a exception occurred.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True, if it is valid for all existing checksum files, otherwise false.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/archiva/checksum/ChecksumValidationException.html" title="class in org.apache.archiva.checksum">ChecksumValidationException</a></code></dd>
</dl>
</li>
</ul>
<a name="getReferenceFile--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReferenceFile</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html?is-external=true" title="class or interface in java.nio.file">Path</a>&nbsp;<a href="../../../../src-html/org/apache/archiva/checksum/ChecksummedFile.html#line.256">getReferenceFile</a>()</pre>
</li>
</ul>
<a name="fixChecksum-org.apache.archiva.checksum.ChecksumAlgorithm-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fixChecksum</h4>
<pre>public&nbsp;<a href="../../../../org/apache/archiva/checksum/UpdateStatusList.html" title="class in org.apache.archiva.checksum">UpdateStatusList</a>&nbsp;<a href="../../../../src-html/org/apache/archiva/checksum/ChecksummedFile.html#line.263">fixChecksum</a>(<a href="../../../../org/apache/archiva/checksum/ChecksumAlgorithm.html" title="enum in org.apache.archiva.checksum">ChecksumAlgorithm</a>&nbsp;algorithm)</pre>
</li>
</ul>
<a name="fixChecksums-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fixChecksums</h4>
<pre>public&nbsp;<a href="../../../../org/apache/archiva/checksum/UpdateStatusList.html" title="class in org.apache.archiva.checksum">UpdateStatusList</a>&nbsp;<a href="../../../../src-html/org/apache/archiva/checksum/ChecksummedFile.html#line.274">fixChecksums</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/archiva/checksum/ChecksumAlgorithm.html" title="enum in org.apache.archiva.checksum">ChecksumAlgorithm</a>&gt;&nbsp;algorithms)</pre>
<div class="block">Writes a checksum file, if it does not exist or if it exists and has a different
checksum value.</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="parseChecksum-java.nio.file.Path-org.apache.archiva.checksum.ChecksumAlgorithm-java.lang.String-java.nio.charset.Charset-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parseChecksum</h4>
<pre>public&nbsp;<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>&nbsp;<a href="../../../../src-html/org/apache/archiva/checksum/ChecksummedFile.html#line.372">parseChecksum</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html?is-external=true" title="class or interface in java.nio.file">Path</a>&nbsp;checksumFile,
<a href="../../../../org/apache/archiva/checksum/ChecksumAlgorithm.html" title="enum in org.apache.archiva.checksum">ChecksumAlgorithm</a>&nbsp;checksumAlgorithm,
<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>&nbsp;fileName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a>&nbsp;encoding)
throws <a href="../../../../org/apache/archiva/checksum/ChecksumValidationException.html" title="class in org.apache.archiva.checksum">ChecksumValidationException</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>checksumFile</code> - The file where the checksum is stored</dd>
<dd><code>checksumAlgorithm</code> - The checksum algorithm to check</dd>
<dd><code>fileName</code> - The filename of the reference file</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>
<dd><code><a href="../../../../org/apache/archiva/checksum/ChecksumValidationException.html" title="class in org.apache.archiva.checksum">ChecksumValidationException</a></code></dd>
</dl>
</li>
</ul>
<a name="parseChecksumFile-java.nio.file.Path-org.apache.archiva.checksum.ChecksumAlgorithm-java.nio.charset.Charset-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>parseChecksumFile</h4>
<pre>public&nbsp;<a href="../../../../org/apache/archiva/checksum/ChecksumFileContent.html" title="class in org.apache.archiva.checksum">ChecksumFileContent</a>&nbsp;<a href="../../../../src-html/org/apache/archiva/checksum/ChecksummedFile.html#line.386">parseChecksumFile</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html?is-external=true" title="class or interface in java.nio.file">Path</a>&nbsp;checksumFile,
<a href="../../../../org/apache/archiva/checksum/ChecksumAlgorithm.html" title="enum in org.apache.archiva.checksum">ChecksumAlgorithm</a>&nbsp;checksumAlgorithm,
<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset">Charset</a>&nbsp;encoding)</pre>
</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/ChecksumFileContent.html" title="class in org.apache.archiva.checksum"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/archiva/checksum/ChecksumReference.html" title="class in org.apache.archiva.checksum"><span class="typeNameLink">Next&nbsp;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&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 &#169; 2006&#x2013;2019 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>