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