| <!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>RepositoryScanner (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="RepositoryScanner (Archiva :: Modules 2.2.8 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/RepositoryScanner.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/repository/scanner/RepositoryContentConsumers.html" title="class in org.apache.archiva.repository.scanner"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/archiva/repository/scanner/RepositoryScannerException.html" title="class in org.apache.archiva.repository.scanner"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/archiva/repository/scanner/RepositoryScanner.html" target="_top">Frames</a></li> |
| <li><a href="RepositoryScanner.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>Constr | </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>Constr | </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.repository.scanner</div> |
| <h2 title="Interface RepositoryScanner" class="title">Interface RepositoryScanner</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../org/apache/archiva/repository/scanner/DefaultRepositoryScanner.html" title="class in org.apache.archiva.repository.scanner">DefaultRepositoryScanner</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <a href="../../../../../src-html/org/apache/archiva/repository/scanner/RepositoryScanner.html#line.34">RepositoryScanner</a></pre> |
| <div class="block">RepositoryScanner</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>static long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/repository/scanner/RepositoryScanner.html#FRESH_SCAN">FRESH_SCAN</a></span></code> |
| <div class="block">The value to pass to <a href="../../../../../org/apache/archiva/repository/scanner/RepositoryScanner.html#scan-org.apache.archiva.admin.model.beans.ManagedRepository-long-"><code>scan(ManagedRepository, long)</code></a> to have the scan |
| operate in a fresh fashion, with no check on changes based on timestamp.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/repository/scanner/RepositoryScanner.html#IGNORABLE_CONTENT">IGNORABLE_CONTENT</a></span></code> |
| <div class="block"> |
| Typical Ignorable Content patterns.</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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../../../../org/apache/archiva/repository/scanner/RepositoryScannerInstance.html" title="class in org.apache.archiva.repository.scanner">RepositoryScannerInstance</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/repository/scanner/RepositoryScanner.html#getInProgressScans--">getInProgressScans</a></span>()</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/archiva/repository/scanner/RepositoryScanStatistics.html" title="class in org.apache.archiva.repository.scanner">RepositoryScanStatistics</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/repository/scanner/RepositoryScanner.html#scan-org.apache.archiva.admin.model.beans.ManagedRepository-java.util.List-java.util.List-java.util.List-long-">scan</a></span>(<a href="../../../../../org/apache/archiva/admin/model/beans/ManagedRepository.html" title="class in org.apache.archiva.admin.model.beans">ManagedRepository</a> repository, |
| <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><<a href="../../../../../org/apache/archiva/consumers/KnownRepositoryContentConsumer.html" title="interface in org.apache.archiva.consumers">KnownRepositoryContentConsumer</a>> knownContentConsumers, |
| <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><<a href="../../../../../org/apache/archiva/consumers/InvalidRepositoryContentConsumer.html" title="interface in org.apache.archiva.consumers">InvalidRepositoryContentConsumer</a>> invalidContentConsumers, |
| <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><<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>> ignoredContentPatterns, |
| long changesSince)</code> |
| <div class="block">Scan the repository for content changes.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/archiva/repository/scanner/RepositoryScanStatistics.html" title="class in org.apache.archiva.repository.scanner">RepositoryScanStatistics</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/archiva/repository/scanner/RepositoryScanner.html#scan-org.apache.archiva.admin.model.beans.ManagedRepository-long-">scan</a></span>(<a href="../../../../../org/apache/archiva/admin/model/beans/ManagedRepository.html" title="class in org.apache.archiva.admin.model.beans">ManagedRepository</a> repository, |
| long changesSince)</code> |
| <div class="block">Scan the repository for content changes.</div> |
| </td> |
| </tr> |
| </table> |
| </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="FRESH_SCAN"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>FRESH_SCAN</h4> |
| <pre>static final long <a href="../../../../../src-html/org/apache/archiva/repository/scanner/RepositoryScanner.html#line.40">FRESH_SCAN</a></pre> |
| <div class="block">The value to pass to <a href="../../../../../org/apache/archiva/repository/scanner/RepositoryScanner.html#scan-org.apache.archiva.admin.model.beans.ManagedRepository-long-"><code>scan(ManagedRepository, long)</code></a> to have the scan |
| operate in a fresh fashion, with no check on changes based on timestamp.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.archiva.repository.scanner.RepositoryScanner.FRESH_SCAN">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="IGNORABLE_CONTENT"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>IGNORABLE_CONTENT</h4> |
| <pre>static final <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/repository/scanner/RepositoryScanner.html#line.53">IGNORABLE_CONTENT</a></pre> |
| <div class="block"><p> |
| Typical Ignorable Content patterns. |
| </p> |
| <p><strong> |
| NOTE: Do not use for normal webapp or task driven repository scanning. |
| </strong></p> |
| <p> |
| These patterns are only valid for archiva-cli and archiva-converter use. |
| </p></div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="scan-org.apache.archiva.admin.model.beans.ManagedRepository-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>scan</h4> |
| <pre><a href="../../../../../org/apache/archiva/repository/scanner/RepositoryScanStatistics.html" title="class in org.apache.archiva.repository.scanner">RepositoryScanStatistics</a> <a href="../../../../../src-html/org/apache/archiva/repository/scanner/RepositoryScanner.html#line.70">scan</a>(<a href="../../../../../org/apache/archiva/admin/model/beans/ManagedRepository.html" title="class in org.apache.archiva.admin.model.beans">ManagedRepository</a> repository, |
| long changesSince) |
| throws <a href="../../../../../org/apache/archiva/repository/scanner/RepositoryScannerException.html" title="class in org.apache.archiva.repository.scanner">RepositoryScannerException</a></pre> |
| <div class="block">Scan the repository for content changes. |
| <p> |
| Internally, this will use the as-configured known and invalid consumer lists.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>repository</code> - the repository to change.</dd> |
| <dd><code>changesSince</code> - the timestamp to use as a threshold on what is considered new or changed. |
| (To have all content be taken into consideration regardless of timestamp, |
| use the <a href="../../../../../org/apache/archiva/repository/scanner/RepositoryScanner.html#FRESH_SCAN"><code>FRESH_SCAN</code></a> constant)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the statistics for this scan.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/archiva/repository/scanner/RepositoryScannerException.html" title="class in org.apache.archiva.repository.scanner">RepositoryScannerException</a></code> - if there was a fundamental problem with getting the discoverer started.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="scan-org.apache.archiva.admin.model.beans.ManagedRepository-java.util.List-java.util.List-java.util.List-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>scan</h4> |
| <pre><a href="../../../../../org/apache/archiva/repository/scanner/RepositoryScanStatistics.html" title="class in org.apache.archiva.repository.scanner">RepositoryScanStatistics</a> <a href="../../../../../src-html/org/apache/archiva/repository/scanner/RepositoryScanner.html#line.90">scan</a>(<a href="../../../../../org/apache/archiva/admin/model/beans/ManagedRepository.html" title="class in org.apache.archiva.admin.model.beans">ManagedRepository</a> repository, |
| <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><<a href="../../../../../org/apache/archiva/consumers/KnownRepositoryContentConsumer.html" title="interface in org.apache.archiva.consumers">KnownRepositoryContentConsumer</a>> knownContentConsumers, |
| <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><<a href="../../../../../org/apache/archiva/consumers/InvalidRepositoryContentConsumer.html" title="interface in org.apache.archiva.consumers">InvalidRepositoryContentConsumer</a>> invalidContentConsumers, |
| <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><<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>> ignoredContentPatterns, |
| long changesSince) |
| throws <a href="../../../../../org/apache/archiva/repository/scanner/RepositoryScannerException.html" title="class in org.apache.archiva.repository.scanner">RepositoryScannerException</a></pre> |
| <div class="block">Scan the repository for content changes. |
| <p> |
| Internally, this will use the as-configured known and invalid consumer lists.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>repository</code> - the repository to change.</dd> |
| <dd><code>knownContentConsumers</code> - the list of consumers that follow the <a href="../../../../../org/apache/archiva/consumers/KnownRepositoryContentConsumer.html" title="interface in org.apache.archiva.consumers"><code>KnownRepositoryContentConsumer</code></a> |
| interface that should be used for this scan.</dd> |
| <dd><code>invalidContentConsumers</code> - the list of consumers that follow the <a href="../../../../../org/apache/archiva/consumers/InvalidRepositoryContentConsumer.html" title="interface in org.apache.archiva.consumers"><code>InvalidRepositoryContentConsumer</code></a> |
| interface that should be used for this scan.</dd> |
| <dd><code>ignoredContentPatterns</code> - list of patterns that should be ignored and not sent to any consumer.</dd> |
| <dd><code>changesSince</code> - the timestamp to use as a threshold on what is considered new or changed. |
| (To have all content be taken into consideration regardless of timestamp, |
| use the <a href="../../../../../org/apache/archiva/repository/scanner/RepositoryScanner.html#FRESH_SCAN"><code>FRESH_SCAN</code></a> constant)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the statistics for this scan.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/archiva/repository/scanner/RepositoryScannerException.html" title="class in org.apache.archiva.repository.scanner">RepositoryScannerException</a></code> - if there was a fundamental problem with getting the discoverer started.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getInProgressScans--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getInProgressScans</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../../../../org/apache/archiva/repository/scanner/RepositoryScannerInstance.html" title="class in org.apache.archiva.repository.scanner">RepositoryScannerInstance</a>> <a href="../../../../../src-html/org/apache/archiva/repository/scanner/RepositoryScanner.html#line.96">getInProgressScans</a>()</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/RepositoryScanner.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/repository/scanner/RepositoryContentConsumers.html" title="class in org.apache.archiva.repository.scanner"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/archiva/repository/scanner/RepositoryScannerException.html" title="class in org.apache.archiva.repository.scanner"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/archiva/repository/scanner/RepositoryScanner.html" target="_top">Frames</a></li> |
| <li><a href="RepositoryScanner.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>Constr | </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>Constr | </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> |
