| <HTML> |
| <BODY BGCOLOR="white"> |
| <PRE> |
| <FONT color="green">001</FONT> package org.apache.archiva.consumers;<a name="line.1"></a> |
| <FONT color="green">002</FONT> <a name="line.2"></a> |
| <FONT color="green">003</FONT> /*<a name="line.3"></a> |
| <FONT color="green">004</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.4"></a> |
| <FONT color="green">005</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.5"></a> |
| <FONT color="green">006</FONT> * distributed with this work for additional information<a name="line.6"></a> |
| <FONT color="green">007</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.7"></a> |
| <FONT color="green">008</FONT> * to you under the Apache License, Version 2.0 (the<a name="line.8"></a> |
| <FONT color="green">009</FONT> * "License"); you may not use this file except in compliance<a name="line.9"></a> |
| <FONT color="green">010</FONT> * with the License. You may obtain a copy of the License at<a name="line.10"></a> |
| <FONT color="green">011</FONT> *<a name="line.11"></a> |
| <FONT color="green">012</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.12"></a> |
| <FONT color="green">013</FONT> *<a name="line.13"></a> |
| <FONT color="green">014</FONT> * Unless required by applicable law or agreed to in writing,<a name="line.14"></a> |
| <FONT color="green">015</FONT> * software distributed under the License is distributed on an<a name="line.15"></a> |
| <FONT color="green">016</FONT> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.16"></a> |
| <FONT color="green">017</FONT> * KIND, either express or implied. See the License for the<a name="line.17"></a> |
| <FONT color="green">018</FONT> * specific language governing permissions and limitations<a name="line.18"></a> |
| <FONT color="green">019</FONT> * under the License.<a name="line.19"></a> |
| <FONT color="green">020</FONT> */<a name="line.20"></a> |
| <FONT color="green">021</FONT> <a name="line.21"></a> |
| <FONT color="green">022</FONT> import org.apache.archiva.admin.model.beans.ManagedRepository;<a name="line.22"></a> |
| <FONT color="green">023</FONT> <a name="line.23"></a> |
| <FONT color="green">024</FONT> import java.util.Date;<a name="line.24"></a> |
| <FONT color="green">025</FONT> import java.util.List;<a name="line.25"></a> |
| <FONT color="green">026</FONT> <a name="line.26"></a> |
| <FONT color="green">027</FONT> /**<a name="line.27"></a> |
| <FONT color="green">028</FONT> * A consumer of content (files) in the repository.<a name="line.28"></a> |
| <FONT color="green">029</FONT> *<a name="line.29"></a> |
| <FONT color="green">030</FONT> * olamy: TODO/FIXME we must review this api, in the current situation we use prototype beans rather than singletons<a name="line.30"></a> |
| <FONT color="green">031</FONT> * this is a bit memory consuming the better will be to ConsumerContext bean to transport repository context etc...<a name="line.31"></a> |
| <FONT color="green">032</FONT> */<a name="line.32"></a> |
| <FONT color="green">033</FONT> public interface RepositoryContentConsumer<a name="line.33"></a> |
| <FONT color="green">034</FONT> extends Consumer<a name="line.34"></a> |
| <FONT color="green">035</FONT> {<a name="line.35"></a> |
| <FONT color="green">036</FONT> /**<a name="line.36"></a> |
| <FONT color="green">037</FONT> * Get the list of included file patterns for this consumer.<a name="line.37"></a> |
| <FONT color="green">038</FONT> *<a name="line.38"></a> |
| <FONT color="green">039</FONT> * @return the list of {@link String} patterns. (example: <code>"**<span />/*.pom"</code>)<a name="line.39"></a> |
| <FONT color="green">040</FONT> */<a name="line.40"></a> |
| <FONT color="green">041</FONT> List<String> getIncludes();<a name="line.41"></a> |
| <FONT color="green">042</FONT> <a name="line.42"></a> |
| <FONT color="green">043</FONT> /**<a name="line.43"></a> |
| <FONT color="green">044</FONT> * Get the list of excluded file patterns for this consumer.<a name="line.44"></a> |
| <FONT color="green">045</FONT> *<a name="line.45"></a> |
| <FONT color="green">046</FONT> * @return the list of {@link String} patterns. (example: <code>"**<span />/*.pom"</code>) - (can be null for no exclusions)<a name="line.46"></a> |
| <FONT color="green">047</FONT> */<a name="line.47"></a> |
| <FONT color="green">048</FONT> List<String> getExcludes();<a name="line.48"></a> |
| <FONT color="green">049</FONT> <a name="line.49"></a> |
| <FONT color="green">050</FONT> /**<a name="line.50"></a> |
| <FONT color="green">051</FONT> * <p><a name="line.51"></a> |
| <FONT color="green">052</FONT> * Event that triggers at the beginning of a scan.<a name="line.52"></a> |
| <FONT color="green">053</FONT> * </p><a name="line.53"></a> |
| <FONT color="green">054</FONT> * <p/><a name="line.54"></a> |
| <FONT color="green">055</FONT> * <p><a name="line.55"></a> |
| <FONT color="green">056</FONT> * NOTE: This would be a good place to initialize the consumer, to lock any resources, and to<a name="line.56"></a> |
| <FONT color="green">057</FONT> * generally start tracking the scan as a whole.<a name="line.57"></a> |
| <FONT color="green">058</FONT> * </p><a name="line.58"></a> |
| <FONT color="green">059</FONT> *<a name="line.59"></a> |
| <FONT color="green">060</FONT> * @param repository the repository that this consumer is being used for.<a name="line.60"></a> |
| <FONT color="green">061</FONT> * @param whenGathered the start of the repository scan<a name="line.61"></a> |
| <FONT color="green">062</FONT> * @throws ConsumerException if there was a problem with using the provided repository with the consumer.<a name="line.62"></a> |
| <FONT color="green">063</FONT> */<a name="line.63"></a> |
| <FONT color="green">064</FONT> void beginScan( ManagedRepository repository, Date whenGathered )<a name="line.64"></a> |
| <FONT color="green">065</FONT> throws ConsumerException;<a name="line.65"></a> |
| <FONT color="green">066</FONT> <a name="line.66"></a> |
| <FONT color="green">067</FONT> /**<a name="line.67"></a> |
| <FONT color="green">068</FONT> * <p><a name="line.68"></a> |
| <FONT color="green">069</FONT> * Event that triggers at the beginning of a scan, where you can also indicate whether the consumers will be<a name="line.69"></a> |
| <FONT color="green">070</FONT> * executed on an entire repository or on a specific resource.<a name="line.70"></a> |
| <FONT color="green">071</FONT> * </p><a name="line.71"></a> |
| <FONT color="green">072</FONT> *<a name="line.72"></a> |
| <FONT color="green">073</FONT> * @param repository the repository that this consumer is being used for.<a name="line.73"></a> |
| <FONT color="green">074</FONT> * @param whenGathered the start of the repository scan<a name="line.74"></a> |
| <FONT color="green">075</FONT> * @param executeOnEntireRepo flags whether the consumer will be executed on an entire repository or just on a specific resource<a name="line.75"></a> |
| <FONT color="green">076</FONT> * @throws ConsumerException if there was a problem with using the provided repository with the consumer.<a name="line.76"></a> |
| <FONT color="green">077</FONT> * @see RepositoryContentConsumer#beginScan(ManagedRepository, java.util.Date)<a name="line.77"></a> |
| <FONT color="green">078</FONT> */<a name="line.78"></a> |
| <FONT color="green">079</FONT> void beginScan( ManagedRepository repository, Date whenGathered, boolean executeOnEntireRepo )<a name="line.79"></a> |
| <FONT color="green">080</FONT> throws ConsumerException;<a name="line.80"></a> |
| <FONT color="green">081</FONT> <a name="line.81"></a> |
| <FONT color="green">082</FONT> /**<a name="line.82"></a> |
| <FONT color="green">083</FONT> * <p><a name="line.83"></a> |
| <FONT color="green">084</FONT> * Event indicating a file is to be processed by this consumer.<a name="line.84"></a> |
| <FONT color="green">085</FONT> * </p><a name="line.85"></a> |
| <FONT color="green">086</FONT> * <p/><a name="line.86"></a> |
| <FONT color="green">087</FONT> * <p><a name="line.87"></a> |
| <FONT color="green">088</FONT> * NOTE: The consumer does not need to process the file immediately, can can opt to queue and/or track<a name="line.88"></a> |
| <FONT color="green">089</FONT> * the files to be processed in batch. Just be sure to complete the processing by the {@link #completeScan()}<a name="line.89"></a> |
| <FONT color="green">090</FONT> * event.<a name="line.90"></a> |
| <FONT color="green">091</FONT> * </p><a name="line.91"></a> |
| <FONT color="green">092</FONT> *<a name="line.92"></a> |
| <FONT color="green">093</FONT> * @param path the relative file path (in the repository) to process.<a name="line.93"></a> |
| <FONT color="green">094</FONT> * @throws ConsumerException if there was a problem processing this file.<a name="line.94"></a> |
| <FONT color="green">095</FONT> */<a name="line.95"></a> |
| <FONT color="green">096</FONT> void processFile( String path )<a name="line.96"></a> |
| <FONT color="green">097</FONT> throws ConsumerException;<a name="line.97"></a> |
| <FONT color="green">098</FONT> <a name="line.98"></a> |
| <FONT color="green">099</FONT> /**<a name="line.99"></a> |
| <FONT color="green">100</FONT> * @param path<a name="line.100"></a> |
| <FONT color="green">101</FONT> * @param executeOnEntireRepo<a name="line.101"></a> |
| <FONT color="green">102</FONT> * @throws Exception<a name="line.102"></a> |
| <FONT color="green">103</FONT> */<a name="line.103"></a> |
| <FONT color="green">104</FONT> void processFile( String path, boolean executeOnEntireRepo )<a name="line.104"></a> |
| <FONT color="green">105</FONT> throws Exception;<a name="line.105"></a> |
| <FONT color="green">106</FONT> <a name="line.106"></a> |
| <FONT color="green">107</FONT> /**<a name="line.107"></a> |
| <FONT color="green">108</FONT> * <p><a name="line.108"></a> |
| <FONT color="green">109</FONT> * Event that triggers on the completion of a scan.<a name="line.109"></a> |
| <FONT color="green">110</FONT> * </p><a name="line.110"></a> |
| <FONT color="green">111</FONT> * <p/><a name="line.111"></a> |
| <FONT color="green">112</FONT> * <p><a name="line.112"></a> |
| <FONT color="green">113</FONT> * NOTE: If the consumer opted to batch up processing requests in the {@link #processFile(String)} event<a name="line.113"></a> |
| <FONT color="green">114</FONT> * this would be the last opportunity to drain any processing queue's.<a name="line.114"></a> |
| <FONT color="green">115</FONT> * </p><a name="line.115"></a> |
| <FONT color="green">116</FONT> */<a name="line.116"></a> |
| <FONT color="green">117</FONT> void completeScan();<a name="line.117"></a> |
| <FONT color="green">118</FONT> <a name="line.118"></a> |
| <FONT color="green">119</FONT> /**<a name="line.119"></a> |
| <FONT color="green">120</FONT> * @param executeOnEntireRepo<a name="line.120"></a> |
| <FONT color="green">121</FONT> * @throws Exception<a name="line.121"></a> |
| <FONT color="green">122</FONT> */<a name="line.122"></a> |
| <FONT color="green">123</FONT> void completeScan( boolean executeOnEntireRepo );<a name="line.123"></a> |
| <FONT color="green">124</FONT> <a name="line.124"></a> |
| <FONT color="green">125</FONT> /**<a name="line.125"></a> |
| <FONT color="green">126</FONT> * Whether the consumer should process files that have not been modified since the time passed in to the scan<a name="line.126"></a> |
| <FONT color="green">127</FONT> * method.<a name="line.127"></a> |
| <FONT color="green">128</FONT> *<a name="line.128"></a> |
| <FONT color="green">129</FONT> * @return whether to process the unmodified files<a name="line.129"></a> |
| <FONT color="green">130</FONT> */<a name="line.130"></a> |
| <FONT color="green">131</FONT> boolean isProcessUnmodified();<a name="line.131"></a> |
| <FONT color="green">132</FONT> }<a name="line.132"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
