| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <TITLE> |
| RepositoryContentConsumer (Archiva :: Modules 1.4-M4 API) |
| </TITLE> |
| |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="RepositoryContentConsumer (Archiva :: Modules 1.4-M4 API)"; |
| } |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| <HR> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/RepositoryContentConsumer.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/apache/archiva/consumers/KnownRepositoryContentConsumer.html" title="interface in org.apache.archiva.consumers"><B>PREV CLASS</B></A> |
| NEXT CLASS</FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/archiva/consumers/RepositoryContentConsumer.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="RepositoryContentConsumer.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.apache.archiva.consumers</FONT> |
| <BR> |
| Interface RepositoryContentConsumer</H2> |
| <DL> |
| <DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../org/apache/archiva/consumers/Consumer.html" title="interface in org.apache.archiva.consumers">Consumer</A></DD> |
| </DL> |
| <DL> |
| <DT><B>All Known Subinterfaces:</B> <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></DD> |
| </DL> |
| <DL> |
| <DT><B>All Known Implementing Classes:</B> <DD><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> |
| <DL> |
| <DT><PRE>public interface <A HREF="../../../../src-html/org/apache/archiva/consumers/RepositoryContentConsumer.html#line.33"><B>RepositoryContentConsumer</B></A><DT>extends <A HREF="../../../../org/apache/archiva/consumers/Consumer.html" title="interface in org.apache.archiva.consumers">Consumer</A></DL> |
| </PRE> |
| |
| <P> |
| A consumer of content (files) in the repository. |
| |
| olamy: TODO/FIXME we must review this api, in the current situation we use prototype beans rather than singletons |
| this is a bit memory consuming the better will be to ConsumerContext bean to transport repository context etc... |
| <P> |
| |
| <P> |
| <HR> |
| |
| <P> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/archiva/consumers/RepositoryContentConsumer.html#beginScan(org.apache.archiva.admin.model.beans.ManagedRepository, java.util.Date)">beginScan</A></B>(<A HREF="../../../../org/apache/archiva/admin/model/beans/ManagedRepository.html" title="class in org.apache.archiva.admin.model.beans">ManagedRepository</A> repository, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</A> whenGathered)</CODE> |
| |
| <BR> |
| |
| Event that triggers at the beginning of a scan.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/archiva/consumers/RepositoryContentConsumer.html#beginScan(org.apache.archiva.admin.model.beans.ManagedRepository, java.util.Date, boolean)">beginScan</A></B>(<A HREF="../../../../org/apache/archiva/admin/model/beans/ManagedRepository.html" title="class in org.apache.archiva.admin.model.beans">ManagedRepository</A> repository, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</A> whenGathered, |
| boolean executeOnEntireRepo)</CODE> |
| |
| <BR> |
| |
| Event that triggers at the beginning of a scan, where you can also indicate whether the consumers will be |
| executed on an entire repository or on a specific resource.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/archiva/consumers/RepositoryContentConsumer.html#completeScan()">completeScan</A></B>()</CODE> |
| |
| <BR> |
| |
| Event that triggers on the completion of a scan.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/archiva/consumers/RepositoryContentConsumer.html#completeScan(boolean)">completeScan</A></B>(boolean executeOnEntireRepo)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<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></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/archiva/consumers/RepositoryContentConsumer.html#getExcludes()">getExcludes</A></B>()</CODE> |
| |
| <BR> |
| Get the list of excluded file patterns for this consumer.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<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></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/archiva/consumers/RepositoryContentConsumer.html#getIncludes()">getIncludes</A></B>()</CODE> |
| |
| <BR> |
| Get the list of included file patterns for this consumer.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/archiva/consumers/RepositoryContentConsumer.html#isProcessUnmodified()">isProcessUnmodified</A></B>()</CODE> |
| |
| <BR> |
| Whether the consumer should process files that have not been modified since the time passed in to the scan |
| method.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/archiva/consumers/RepositoryContentConsumer.html#processFile(java.lang.String)">processFile</A></B>(<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> path)</CODE> |
| |
| <BR> |
| |
| Event indicating a file is to be processed by this consumer.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/archiva/consumers/RepositoryContentConsumer.html#processFile(java.lang.String, boolean)">processFile</A></B>(<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> path, |
| boolean executeOnEntireRepo)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.apache.archiva.consumers.Consumer"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from interface org.apache.archiva.consumers.<A HREF="../../../../org/apache/archiva/consumers/Consumer.html" title="interface in org.apache.archiva.consumers">Consumer</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/apache/archiva/consumers/Consumer.html#addConsumerMonitor(org.apache.archiva.consumers.ConsumerMonitor)">addConsumerMonitor</A>, <A HREF="../../../../org/apache/archiva/consumers/Consumer.html#getDescription()">getDescription</A>, <A HREF="../../../../org/apache/archiva/consumers/Consumer.html#getId()">getId</A>, <A HREF="../../../../org/apache/archiva/consumers/Consumer.html#isPermanent()">isPermanent</A>, <A HREF="../../../../org/apache/archiva/consumers/Consumer.html#removeConsumerMonitor(org.apache.archiva.consumers.ConsumerMonitor)">removeConsumerMonitor</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="getIncludes()"><!-- --></A><H3> |
| getIncludes</H3> |
| <PRE> |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<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>> <A HREF="../../../../src-html/org/apache/archiva/consumers/RepositoryContentConsumer.html#line.41"><B>getIncludes</B></A>()</PRE> |
| <DL> |
| <DD>Get the list of included file patterns for this consumer. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the list of <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"><CODE>String</CODE></A> patterns. (example: <code>"**<span />/*.pom"</code>)</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getExcludes()"><!-- --></A><H3> |
| getExcludes</H3> |
| <PRE> |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<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>> <A HREF="../../../../src-html/org/apache/archiva/consumers/RepositoryContentConsumer.html#line.48"><B>getExcludes</B></A>()</PRE> |
| <DL> |
| <DD>Get the list of excluded file patterns for this consumer. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the list of <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"><CODE>String</CODE></A> patterns. (example: <code>"**<span />/*.pom"</code>) - (can be null for no exclusions)</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="beginScan(org.apache.archiva.admin.model.beans.ManagedRepository, java.util.Date)"><!-- --></A><H3> |
| beginScan</H3> |
| <PRE> |
| void <A HREF="../../../../src-html/org/apache/archiva/consumers/RepositoryContentConsumer.html#line.64"><B>beginScan</B></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="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</A> whenGathered) |
| throws <A HREF="../../../../org/apache/archiva/consumers/ConsumerException.html" title="class in org.apache.archiva.consumers">ConsumerException</A></PRE> |
| <DL> |
| <DD><p> |
| Event that triggers at the beginning of a scan. |
| </p> |
| <p/> |
| <p> |
| NOTE: This would be a good place to initialize the consumer, to lock any resources, and to |
| generally start tracking the scan as a whole. |
| </p> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>repository</CODE> - the repository that this consumer is being used for.<DD><CODE>whenGathered</CODE> - the start of the repository scan |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../org/apache/archiva/consumers/ConsumerException.html" title="class in org.apache.archiva.consumers">ConsumerException</A></CODE> - if there was a problem with using the provided repository with the consumer.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="beginScan(org.apache.archiva.admin.model.beans.ManagedRepository, java.util.Date, boolean)"><!-- --></A><H3> |
| beginScan</H3> |
| <PRE> |
| void <A HREF="../../../../src-html/org/apache/archiva/consumers/RepositoryContentConsumer.html#line.79"><B>beginScan</B></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="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</A> whenGathered, |
| boolean executeOnEntireRepo) |
| throws <A HREF="../../../../org/apache/archiva/consumers/ConsumerException.html" title="class in org.apache.archiva.consumers">ConsumerException</A></PRE> |
| <DL> |
| <DD><p> |
| Event that triggers at the beginning of a scan, where you can also indicate whether the consumers will be |
| executed on an entire repository or on a specific resource. |
| </p> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>repository</CODE> - the repository that this consumer is being used for.<DD><CODE>whenGathered</CODE> - the start of the repository scan<DD><CODE>executeOnEntireRepo</CODE> - flags whether the consumer will be executed on an entire repository or just on a specific resource |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../org/apache/archiva/consumers/ConsumerException.html" title="class in org.apache.archiva.consumers">ConsumerException</A></CODE> - if there was a problem with using the provided repository with the consumer.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/archiva/consumers/RepositoryContentConsumer.html#beginScan(org.apache.archiva.admin.model.beans.ManagedRepository, java.util.Date)"><CODE>beginScan(ManagedRepository, java.util.Date)</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="processFile(java.lang.String)"><!-- --></A><H3> |
| processFile</H3> |
| <PRE> |
| void <A HREF="../../../../src-html/org/apache/archiva/consumers/RepositoryContentConsumer.html#line.96"><B>processFile</B></A>(<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> path) |
| throws <A HREF="../../../../org/apache/archiva/consumers/ConsumerException.html" title="class in org.apache.archiva.consumers">ConsumerException</A></PRE> |
| <DL> |
| <DD><p> |
| Event indicating a file is to be processed by this consumer. |
| </p> |
| <p/> |
| <p> |
| NOTE: The consumer does not need to process the file immediately, can can opt to queue and/or track |
| the files to be processed in batch. Just be sure to complete the processing by the <A HREF="../../../../org/apache/archiva/consumers/RepositoryContentConsumer.html#completeScan()"><CODE>completeScan()</CODE></A> |
| event. |
| </p> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>path</CODE> - the relative file path (in the repository) to process. |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../org/apache/archiva/consumers/ConsumerException.html" title="class in org.apache.archiva.consumers">ConsumerException</A></CODE> - if there was a problem processing this file.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="processFile(java.lang.String, boolean)"><!-- --></A><H3> |
| processFile</H3> |
| <PRE> |
| void <A HREF="../../../../src-html/org/apache/archiva/consumers/RepositoryContentConsumer.html#line.104"><B>processFile</B></A>(<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> path, |
| boolean executeOnEntireRepo) |
| throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>path</CODE> - <DD><CODE>executeOnEntireRepo</CODE> - |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="completeScan()"><!-- --></A><H3> |
| completeScan</H3> |
| <PRE> |
| void <A HREF="../../../../src-html/org/apache/archiva/consumers/RepositoryContentConsumer.html#line.117"><B>completeScan</B></A>()</PRE> |
| <DL> |
| <DD><p> |
| Event that triggers on the completion of a scan. |
| </p> |
| <p/> |
| <p> |
| NOTE: If the consumer opted to batch up processing requests in the <A HREF="../../../../org/apache/archiva/consumers/RepositoryContentConsumer.html#processFile(java.lang.String)"><CODE>processFile(String)</CODE></A> event |
| this would be the last opportunity to drain any processing queue's. |
| </p> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="completeScan(boolean)"><!-- --></A><H3> |
| completeScan</H3> |
| <PRE> |
| void <A HREF="../../../../src-html/org/apache/archiva/consumers/RepositoryContentConsumer.html#line.123"><B>completeScan</B></A>(boolean executeOnEntireRepo)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>executeOnEntireRepo</CODE> - |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isProcessUnmodified()"><!-- --></A><H3> |
| isProcessUnmodified</H3> |
| <PRE> |
| boolean <A HREF="../../../../src-html/org/apache/archiva/consumers/RepositoryContentConsumer.html#line.131"><B>isProcessUnmodified</B></A>()</PRE> |
| <DL> |
| <DD>Whether the consumer should process files that have not been modified since the time passed in to the scan |
| method. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>whether to process the unmodified files</DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/RepositoryContentConsumer.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/apache/archiva/consumers/KnownRepositoryContentConsumer.html" title="interface in org.apache.archiva.consumers"><B>PREV CLASS</B></A> |
| NEXT CLASS</FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/archiva/consumers/RepositoryContentConsumer.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="RepositoryContentConsumer.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 2006-2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved. |
| </BODY> |
| </HTML> |