| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="de"> |
| <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.indexer;<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.repository.Repository;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.archiva.repository.RepositoryType;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span><a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import java.net.URI;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import java.util.Collection;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import java.util.List;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span><a name="line.28"></a> |
| <span class="sourceLineNo">029</span>public interface ArchivaIndexManager {<a name="line.29"></a> |
| <span class="sourceLineNo">030</span><a name="line.30"></a> |
| <span class="sourceLineNo">031</span> String DEFAULT_INDEX_PATH=".indexer";<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> String DEFAULT_PACKED_INDEX_PATH=".index";<a name="line.32"></a> |
| <span class="sourceLineNo">033</span><a name="line.33"></a> |
| <span class="sourceLineNo">034</span> /**<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * Compresses the index to a more dense packed format.<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * @param context<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> */<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> void pack(ArchivaIndexingContext context) throws IndexUpdateFailedException;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span><a name="line.39"></a> |
| <span class="sourceLineNo">040</span> /**<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * Rescans the whole repository, this index is associated to.<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * @param context<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> *<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> */<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> void scan(ArchivaIndexingContext context) throws IndexUpdateFailedException;<a name="line.45"></a> |
| <span class="sourceLineNo">046</span><a name="line.46"></a> |
| <span class="sourceLineNo">047</span> /**<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * Updates the index from the remote url.<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * @param context<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * @param fullUpdate<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> */<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> void update(ArchivaIndexingContext context, boolean fullUpdate) throws IndexUpdateFailedException;<a name="line.52"></a> |
| <span class="sourceLineNo">053</span><a name="line.53"></a> |
| <span class="sourceLineNo">054</span> /**<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * Adds a list of artifacts to the index.<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * @param context<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * @param artifactReference<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> */<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> void addArtifactsToIndex(ArchivaIndexingContext context, Collection<URI> artifactReference) throws IndexUpdateFailedException;<a name="line.59"></a> |
| <span class="sourceLineNo">060</span><a name="line.60"></a> |
| <span class="sourceLineNo">061</span> /**<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * Removes a list of artifacts from the index.<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * @param context<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * @param artifactReference<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> */<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> void removeArtifactsFromIndex(ArchivaIndexingContext context, Collection<URI> artifactReference) throws IndexUpdateFailedException;<a name="line.66"></a> |
| <span class="sourceLineNo">067</span><a name="line.67"></a> |
| <span class="sourceLineNo">068</span><a name="line.68"></a> |
| <span class="sourceLineNo">069</span> /**<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * Returns true, if this manager is able to apply the index actions for the given repository type.<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * @param type<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * @return<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> */<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> boolean supportsRepository(RepositoryType type);<a name="line.74"></a> |
| <span class="sourceLineNo">075</span><a name="line.75"></a> |
| <span class="sourceLineNo">076</span> /**<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * Creates the indexing context for the given repository.<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * @param repository the repository for which the index context should be created<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * @return the index context<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> */<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> ArchivaIndexingContext createContext(Repository repository) throws IndexCreationFailedException;<a name="line.81"></a> |
| <span class="sourceLineNo">082</span><a name="line.82"></a> |
| <span class="sourceLineNo">083</span> /**<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * Reinitializes the index. E.g. remove the files and create a new empty index.<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> *<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * @param context<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * @return the new created index<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> */<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> ArchivaIndexingContext reset(ArchivaIndexingContext context) throws IndexUpdateFailedException;<a name="line.89"></a> |
| <span class="sourceLineNo">090</span><a name="line.90"></a> |
| <span class="sourceLineNo">091</span> /**<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * Moves the context to a new directory. It's up to the implementation, if a new context is created<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * or the context is moved only.<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> *<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * @param context The current context<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> * @param repo The repository<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * @return The new context<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * @throws IndexCreationFailedException<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> */<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> ArchivaIndexingContext move(ArchivaIndexingContext context, Repository repo) throws IndexCreationFailedException;<a name="line.100"></a> |
| <span class="sourceLineNo">101</span><a name="line.101"></a> |
| <span class="sourceLineNo">102</span> /**<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> * Updates the local path where the index is stored using the repository information.<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> * @return<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> */<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> void updateLocalIndexPath(Repository repo);<a name="line.106"></a> |
| <span class="sourceLineNo">107</span><a name="line.107"></a> |
| <span class="sourceLineNo">108</span><a name="line.108"></a> |
| <span class="sourceLineNo">109</span> /**<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * Merges a list of contexts into a single one.<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> *<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> * @param destinationRepo The destination repository<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> * @param contexts The contexts of the indexes that should be merged.<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> * @param packIndex True, if the merged index should be packed, otherwise false.<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> * @return The merged context<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> * @throws UnsupportedOperationException if the underlying implementation does not allow to merge indexing contexts<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> */<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> ArchivaIndexingContext mergeContexts(Repository destinationRepo, List<ArchivaIndexingContext> contexts,<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> boolean packIndex) throws UnsupportedOperationException,<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> IndexCreationFailedException;<a name="line.120"></a> |
| <span class="sourceLineNo">121</span>}<a name="line.121"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |