blob: d2f1654e5b9a11d62f49f6c2c63c7ff859f1bab5 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Consumer (Archiva :: Modules 2.2.3 API)</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Consumer (Archiva :: Modules 2.2.3 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/Consumer.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/consumers/AbstractMonitoredConsumer.html" title="class in org.apache.archiva.consumers"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/archiva/consumers/ConsumerException.html" title="class in org.apache.archiva.consumers"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/archiva/consumers/Consumer.html" target="_top">Frames</a></li>
<li><a href="Consumer.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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.consumers</div>
<h2 title="Interface Consumer" class="title">Interface Consumer</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../org/apache/archiva/consumers/InvalidRepositoryContentConsumer.html" title="interface in org.apache.archiva.consumers">InvalidRepositoryContentConsumer</a>, <a href="../../../../org/apache/archiva/consumers/KnownRepositoryContentConsumer.html" title="interface in org.apache.archiva.consumers">KnownRepositoryContentConsumer</a>, <a href="../../../../org/apache/archiva/consumers/RepositoryContentConsumer.html" title="interface in org.apache.archiva.consumers">RepositoryContentConsumer</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/apache/archiva/consumers/AbstractMonitoredConsumer.html" title="class in org.apache.archiva.consumers">AbstractMonitoredConsumer</a>, <a href="../../../../org/apache/archiva/consumers/metadata/ArchivaMetadataCreationConsumer.html" title="class in org.apache.archiva.consumers.metadata">ArchivaMetadataCreationConsumer</a>, <a href="../../../../org/apache/archiva/consumers/core/ArtifactMissingChecksumsConsumer.html" title="class in org.apache.archiva.consumers.core">ArtifactMissingChecksumsConsumer</a>, <a href="../../../../org/apache/archiva/consumers/core/AutoRemoveConsumer.html" title="class in org.apache.archiva.consumers.core">AutoRemoveConsumer</a>, <a href="../../../../org/apache/archiva/consumers/core/AutoRenameConsumer.html" title="class in org.apache.archiva.consumers.core">AutoRenameConsumer</a>, <a href="../../../../org/apache/archiva/reports/consumers/DuplicateArtifactsConsumer.html" title="class in org.apache.archiva.reports.consumers">DuplicateArtifactsConsumer</a>, <a href="../../../../org/apache/archiva/converter/legacy/LegacyConverterArtifactConsumer.html" title="class in org.apache.archiva.converter.legacy">LegacyConverterArtifactConsumer</a>, <a href="../../../../org/apache/archiva/consumers/core/MetadataUpdaterConsumer.html" title="class in org.apache.archiva.consumers.core">MetadataUpdaterConsumer</a>, <a href="../../../../org/apache/archiva/web/mocks/MockInvalidRepositoryContentConsumer.html" title="class in org.apache.archiva.web.mocks">MockInvalidRepositoryContentConsumer</a>, <a href="../../../../org/apache/archiva/consumers/lucene/NexusIndexerConsumer.html" title="class in org.apache.archiva.consumers.lucene">NexusIndexerConsumer</a>, <a href="../../../../org/apache/archiva/consumers/core/repository/RepositoryPurgeConsumer.html" title="class in org.apache.archiva.consumers.core.repository">RepositoryPurgeConsumer</a>, <a href="../../../../org/apache/archiva/consumers/core/ValidateChecksumConsumer.html" title="class in org.apache.archiva.consumers.core">ValidateChecksumConsumer</a></dd>
</dl>
<hr>
<br>
<pre>public interface <a href="../../../../src-html/org/apache/archiva/consumers/Consumer.html#line.27">Consumer</a></pre>
<div class="block">Consumer - the base set of methods for a consumer.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/archiva/consumers/Consumer.html#addConsumerMonitor(org.apache.archiva.consumers.ConsumerMonitor)">addConsumerMonitor</a></strong>(<a href="../../../../org/apache/archiva/consumers/ConsumerMonitor.html" title="interface in org.apache.archiva.consumers">ConsumerMonitor</a>&nbsp;monitor)</code>
<div class="block">Add a consumer monitor to the consumer.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/archiva/consumers/Consumer.html#getDescription()">getDescription</a></strong>()</code>
<div class="block">The human readable description for this consumer.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/archiva/consumers/Consumer.html#getId()">getId</a></strong>()</code>
<div class="block">This is the id for the consumer.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/archiva/consumers/Consumer.html#removeConsumerMonitor(org.apache.archiva.consumers.ConsumerMonitor)">removeConsumerMonitor</a></strong>(<a href="../../../../org/apache/archiva/consumers/ConsumerMonitor.html" title="interface in org.apache.archiva.consumers">ConsumerMonitor</a>&nbsp;monitor)</code>
<div class="block">Remove a consumer monitor.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getId()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getId</h4>
<pre><a href="http://java.sun.com/j2se/1.5.0/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/consumers/Consumer.html#line.34">getId</a>()</pre>
<div class="block">This is the id for the consumer.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the consumer id.</dd></dl>
</li>
</ul>
<a name="getDescription()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDescription</h4>
<pre><a href="http://java.sun.com/j2se/1.5.0/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/consumers/Consumer.html#line.41">getDescription</a>()</pre>
<div class="block">The human readable description for this consumer.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the human readable description for this consumer.</dd></dl>
</li>
</ul>
<a name="addConsumerMonitor(org.apache.archiva.consumers.ConsumerMonitor)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addConsumerMonitor</h4>
<pre>void&nbsp;<a href="../../../../src-html/org/apache/archiva/consumers/Consumer.html#line.48">addConsumerMonitor</a>(<a href="../../../../org/apache/archiva/consumers/ConsumerMonitor.html" title="interface in org.apache.archiva.consumers">ConsumerMonitor</a>&nbsp;monitor)</pre>
<div class="block">Add a consumer monitor to the consumer.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>monitor</code> - the monitor to add.</dd></dl>
</li>
</ul>
<a name="removeConsumerMonitor(org.apache.archiva.consumers.ConsumerMonitor)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>removeConsumerMonitor</h4>
<pre>void&nbsp;<a href="../../../../src-html/org/apache/archiva/consumers/Consumer.html#line.55">removeConsumerMonitor</a>(<a href="../../../../org/apache/archiva/consumers/ConsumerMonitor.html" title="interface in org.apache.archiva.consumers">ConsumerMonitor</a>&nbsp;monitor)</pre>
<div class="block">Remove a consumer monitor.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>monitor</code> - the monitor to remove.</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/Consumer.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/consumers/AbstractMonitoredConsumer.html" title="class in org.apache.archiva.consumers"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/archiva/consumers/ConsumerException.html" title="class in org.apache.archiva.consumers"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/archiva/consumers/Consumer.html" target="_top">Frames</a></li>
<li><a href="Consumer.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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;2017 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>