| <HTML> |
| <BODY BGCOLOR="white"> |
| <PRE> |
| <FONT color="green">001</FONT> package org.apache.archiva.repository;<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> import org.apache.archiva.model.ArchivaArtifact;<a name="line.23"></a> |
| <FONT color="green">024</FONT> import org.apache.archiva.model.ArtifactReference;<a name="line.24"></a> |
| <FONT color="green">025</FONT> import org.apache.archiva.model.ProjectReference;<a name="line.25"></a> |
| <FONT color="green">026</FONT> import org.apache.archiva.model.VersionedReference;<a name="line.26"></a> |
| <FONT color="green">027</FONT> import org.apache.archiva.repository.layout.LayoutException;<a name="line.27"></a> |
| <FONT color="green">028</FONT> <a name="line.28"></a> |
| <FONT color="green">029</FONT> import java.io.File;<a name="line.29"></a> |
| <FONT color="green">030</FONT> import java.util.Set;<a name="line.30"></a> |
| <FONT color="green">031</FONT> <a name="line.31"></a> |
| <FONT color="green">032</FONT> /**<a name="line.32"></a> |
| <FONT color="green">033</FONT> * ManagedRepositoryContent interface for interacting with a managed repository in an abstract way,<a name="line.33"></a> |
| <FONT color="green">034</FONT> * without the need for processing based on filesystem paths, or working with the database.<a name="line.34"></a> |
| <FONT color="green">035</FONT> */<a name="line.35"></a> |
| <FONT color="green">036</FONT> public interface ManagedRepositoryContent<a name="line.36"></a> |
| <FONT color="green">037</FONT> {<a name="line.37"></a> |
| <FONT color="green">038</FONT> /**<a name="line.38"></a> |
| <FONT color="green">039</FONT> * Delete from the managed repository all files / directories associated with the<a name="line.39"></a> |
| <FONT color="green">040</FONT> * provided version reference.<a name="line.40"></a> |
| <FONT color="green">041</FONT> *<a name="line.41"></a> |
| <FONT color="green">042</FONT> * @param reference the version reference to delete.<a name="line.42"></a> |
| <FONT color="green">043</FONT> * @throws ContentNotFoundException<a name="line.43"></a> |
| <FONT color="green">044</FONT> */<a name="line.44"></a> |
| <FONT color="green">045</FONT> void deleteVersion( VersionedReference reference )<a name="line.45"></a> |
| <FONT color="green">046</FONT> throws ContentNotFoundException;<a name="line.46"></a> |
| <FONT color="green">047</FONT> <a name="line.47"></a> |
| <FONT color="green">048</FONT> /**<a name="line.48"></a> |
| <FONT color="green">049</FONT> * delete a specified artifact from the repository<a name="line.49"></a> |
| <FONT color="green">050</FONT> *<a name="line.50"></a> |
| <FONT color="green">051</FONT> * @param artifactReference<a name="line.51"></a> |
| <FONT color="green">052</FONT> * @throws ContentNotFoundException<a name="line.52"></a> |
| <FONT color="green">053</FONT> */<a name="line.53"></a> |
| <FONT color="green">054</FONT> void deleteArtifact( ArtifactReference artifactReference )<a name="line.54"></a> |
| <FONT color="green">055</FONT> throws ContentNotFoundException;<a name="line.55"></a> |
| <FONT color="green">056</FONT> <a name="line.56"></a> |
| <FONT color="green">057</FONT> /**<a name="line.57"></a> |
| <FONT color="green">058</FONT> * @param groupId<a name="line.58"></a> |
| <FONT color="green">059</FONT> * @throws ContentNotFoundException<a name="line.59"></a> |
| <FONT color="green">060</FONT> * @since 1.4-M3<a name="line.60"></a> |
| <FONT color="green">061</FONT> */<a name="line.61"></a> |
| <FONT color="green">062</FONT> void deleteGroupId( String groupId )<a name="line.62"></a> |
| <FONT color="green">063</FONT> throws ContentNotFoundException;<a name="line.63"></a> |
| <FONT color="green">064</FONT> <a name="line.64"></a> |
| <FONT color="green">065</FONT> /**<a name="line.65"></a> |
| <FONT color="green">066</FONT> *<a name="line.66"></a> |
| <FONT color="green">067</FONT> * @param namespace groupId for maven<a name="line.67"></a> |
| <FONT color="green">068</FONT> * @param projectId artifactId for maven<a name="line.68"></a> |
| <FONT color="green">069</FONT> * @throws ContentNotFoundException<a name="line.69"></a> |
| <FONT color="green">070</FONT> */<a name="line.70"></a> |
| <FONT color="green">071</FONT> void deleteProject( String namespace, String projectId )<a name="line.71"></a> |
| <FONT color="green">072</FONT> throws RepositoryException;<a name="line.72"></a> |
| <FONT color="green">073</FONT> <a name="line.73"></a> |
| <FONT color="green">074</FONT> /**<a name="line.74"></a> |
| <FONT color="green">075</FONT> * <p><a name="line.75"></a> |
| <FONT color="green">076</FONT> * Convenience method to get the repository id.<a name="line.76"></a> |
| <FONT color="green">077</FONT> * </p><a name="line.77"></a> |
| <FONT color="green">078</FONT> * <p/><a name="line.78"></a> |
| <FONT color="green">079</FONT> * <p><a name="line.79"></a> |
| <FONT color="green">080</FONT> * Equivalent to calling <code>.getRepository().getId()</code><a name="line.80"></a> |
| <FONT color="green">081</FONT> * </p><a name="line.81"></a> |
| <FONT color="green">082</FONT> *<a name="line.82"></a> |
| <FONT color="green">083</FONT> * @return the repository id.<a name="line.83"></a> |
| <FONT color="green">084</FONT> */<a name="line.84"></a> |
| <FONT color="green">085</FONT> String getId();<a name="line.85"></a> |
| <FONT color="green">086</FONT> <a name="line.86"></a> |
| <FONT color="green">087</FONT> /**<a name="line.87"></a> |
| <FONT color="green">088</FONT> * <p><a name="line.88"></a> |
| <FONT color="green">089</FONT> * Gather up the list of related artifacts to the ArtifactReference provided.<a name="line.89"></a> |
| <FONT color="green">090</FONT> * This typically inclues the pom files, and those things with<a name="line.90"></a> |
| <FONT color="green">091</FONT> * classifiers (such as doc, source code, test libs, etc...)<a name="line.91"></a> |
| <FONT color="green">092</FONT> * </p><a name="line.92"></a> |
| <FONT color="green">093</FONT> * <p/><a name="line.93"></a> |
| <FONT color="green">094</FONT> * <p><a name="line.94"></a> |
| <FONT color="green">095</FONT> * <strong>NOTE:</strong> Some layouts (such as maven 1 "legacy") are not compatible with this query.<a name="line.95"></a> |
| <FONT color="green">096</FONT> * </p><a name="line.96"></a> |
| <FONT color="green">097</FONT> *<a name="line.97"></a> |
| <FONT color="green">098</FONT> * @param reference the reference to work off of.<a name="line.98"></a> |
| <FONT color="green">099</FONT> * @return the set of ArtifactReferences for related artifacts.<a name="line.99"></a> |
| <FONT color="green">100</FONT> * @throws ContentNotFoundException if the initial artifact reference does not exist within the repository.<a name="line.100"></a> |
| <FONT color="green">101</FONT> * @throws LayoutException<a name="line.101"></a> |
| <FONT color="green">102</FONT> */<a name="line.102"></a> |
| <FONT color="green">103</FONT> Set<ArtifactReference> getRelatedArtifacts( ArtifactReference reference )<a name="line.103"></a> |
| <FONT color="green">104</FONT> throws ContentNotFoundException;<a name="line.104"></a> |
| <FONT color="green">105</FONT> <a name="line.105"></a> |
| <FONT color="green">106</FONT> /**<a name="line.106"></a> |
| <FONT color="green">107</FONT> * <p><a name="line.107"></a> |
| <FONT color="green">108</FONT> * Convenience method to get the repository (on disk) root directory.<a name="line.108"></a> |
| <FONT color="green">109</FONT> * </p><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> * Equivalent to calling <code>.getRepository().getLocation()</code><a name="line.112"></a> |
| <FONT color="green">113</FONT> * </p><a name="line.113"></a> |
| <FONT color="green">114</FONT> *<a name="line.114"></a> |
| <FONT color="green">115</FONT> * @return the repository (on disk) root directory.<a name="line.115"></a> |
| <FONT color="green">116</FONT> */<a name="line.116"></a> |
| <FONT color="green">117</FONT> String getRepoRoot();<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> * Get the repository configuration associated with this<a name="line.120"></a> |
| <FONT color="green">121</FONT> * repository content.<a name="line.121"></a> |
| <FONT color="green">122</FONT> *<a name="line.122"></a> |
| <FONT color="green">123</FONT> * @return the repository that is associated with this repository content.<a name="line.123"></a> |
| <FONT color="green">124</FONT> */<a name="line.124"></a> |
| <FONT color="green">125</FONT> ManagedRepository getRepository();<a name="line.125"></a> |
| <FONT color="green">126</FONT> <a name="line.126"></a> |
| <FONT color="green">127</FONT> /**<a name="line.127"></a> |
| <FONT color="green">128</FONT> * Given a specific {@link ProjectReference}, return the list of available versions for<a name="line.128"></a> |
| <FONT color="green">129</FONT> * that project reference.<a name="line.129"></a> |
| <FONT color="green">130</FONT> *<a name="line.130"></a> |
| <FONT color="green">131</FONT> * @param reference the project reference to work off of.<a name="line.131"></a> |
| <FONT color="green">132</FONT> * @return the list of versions found for that project reference.<a name="line.132"></a> |
| <FONT color="green">133</FONT> * @throws ContentNotFoundException if the project reference does nto exist within the repository.<a name="line.133"></a> |
| <FONT color="green">134</FONT> * @throws LayoutException<a name="line.134"></a> |
| <FONT color="green">135</FONT> */<a name="line.135"></a> |
| <FONT color="green">136</FONT> Set<String> getVersions( ProjectReference reference )<a name="line.136"></a> |
| <FONT color="green">137</FONT> throws ContentNotFoundException, LayoutException;<a name="line.137"></a> |
| <FONT color="green">138</FONT> <a name="line.138"></a> |
| <FONT color="green">139</FONT> /**<a name="line.139"></a> |
| <FONT color="green">140</FONT> * <p><a name="line.140"></a> |
| <FONT color="green">141</FONT> * Given a specific {@link VersionedReference}, return the list of available versions for that<a name="line.141"></a> |
| <FONT color="green">142</FONT> * versioned reference.<a name="line.142"></a> |
| <FONT color="green">143</FONT> * </p><a name="line.143"></a> |
| <FONT color="green">144</FONT> * <p/><a name="line.144"></a> |
| <FONT color="green">145</FONT> * <p><a name="line.145"></a> |
| <FONT color="green">146</FONT> * <strong>NOTE:</strong> This is really only useful when working with SNAPSHOTs.<a name="line.146"></a> |
| <FONT color="green">147</FONT> * </p><a name="line.147"></a> |
| <FONT color="green">148</FONT> *<a name="line.148"></a> |
| <FONT color="green">149</FONT> * @param reference the versioned reference to work off of.<a name="line.149"></a> |
| <FONT color="green">150</FONT> * @return the set of versions found.<a name="line.150"></a> |
| <FONT color="green">151</FONT> * @throws ContentNotFoundException if the versioned reference does not exist within the repository.<a name="line.151"></a> |
| <FONT color="green">152</FONT> * @throws LayoutException<a name="line.152"></a> |
| <FONT color="green">153</FONT> */<a name="line.153"></a> |
| <FONT color="green">154</FONT> Set<String> getVersions( VersionedReference reference )<a name="line.154"></a> |
| <FONT color="green">155</FONT> throws ContentNotFoundException;<a name="line.155"></a> |
| <FONT color="green">156</FONT> <a name="line.156"></a> |
| <FONT color="green">157</FONT> /**<a name="line.157"></a> |
| <FONT color="green">158</FONT> * Determines if the artifact referenced exists in the repository.<a name="line.158"></a> |
| <FONT color="green">159</FONT> *<a name="line.159"></a> |
| <FONT color="green">160</FONT> * @param reference the artifact reference to check for.<a name="line.160"></a> |
| <FONT color="green">161</FONT> * @return true if the artifact referenced exists.<a name="line.161"></a> |
| <FONT color="green">162</FONT> */<a name="line.162"></a> |
| <FONT color="green">163</FONT> boolean hasContent( ArtifactReference reference );<a name="line.163"></a> |
| <FONT color="green">164</FONT> <a name="line.164"></a> |
| <FONT color="green">165</FONT> /**<a name="line.165"></a> |
| <FONT color="green">166</FONT> * Determines if the project referenced exists in the repository.<a name="line.166"></a> |
| <FONT color="green">167</FONT> *<a name="line.167"></a> |
| <FONT color="green">168</FONT> * @param reference the project reference to check for.<a name="line.168"></a> |
| <FONT color="green">169</FONT> * @return true it the project referenced exists.<a name="line.169"></a> |
| <FONT color="green">170</FONT> */<a name="line.170"></a> |
| <FONT color="green">171</FONT> boolean hasContent( ProjectReference reference );<a name="line.171"></a> |
| <FONT color="green">172</FONT> <a name="line.172"></a> |
| <FONT color="green">173</FONT> /**<a name="line.173"></a> |
| <FONT color="green">174</FONT> * Determines if the version reference exists in the repository.<a name="line.174"></a> |
| <FONT color="green">175</FONT> *<a name="line.175"></a> |
| <FONT color="green">176</FONT> * @param reference the version reference to check for.<a name="line.176"></a> |
| <FONT color="green">177</FONT> * @return true if the version referenced exists.<a name="line.177"></a> |
| <FONT color="green">178</FONT> */<a name="line.178"></a> |
| <FONT color="green">179</FONT> boolean hasContent( VersionedReference reference );<a name="line.179"></a> |
| <FONT color="green">180</FONT> <a name="line.180"></a> |
| <FONT color="green">181</FONT> /**<a name="line.181"></a> |
| <FONT color="green">182</FONT> * Set the repository configuration to associate with this<a name="line.182"></a> |
| <FONT color="green">183</FONT> * repository content.<a name="line.183"></a> |
| <FONT color="green">184</FONT> *<a name="line.184"></a> |
| <FONT color="green">185</FONT> * @param repo the repository to associate with this repository content.<a name="line.185"></a> |
| <FONT color="green">186</FONT> */<a name="line.186"></a> |
| <FONT color="green">187</FONT> void setRepository( ManagedRepository repo );<a name="line.187"></a> |
| <FONT color="green">188</FONT> <a name="line.188"></a> |
| <FONT color="green">189</FONT> /**<a name="line.189"></a> |
| <FONT color="green">190</FONT> * Given a repository relative path to a filename, return the {@link VersionedReference} object suitable for the path.<a name="line.190"></a> |
| <FONT color="green">191</FONT> *<a name="line.191"></a> |
| <FONT color="green">192</FONT> * @param path the path relative to the repository base dir for the artifact.<a name="line.192"></a> |
| <FONT color="green">193</FONT> * @return the {@link ArtifactReference} representing the path. (or null if path cannot be converted to<a name="line.193"></a> |
| <FONT color="green">194</FONT> * a {@link ArtifactReference})<a name="line.194"></a> |
| <FONT color="green">195</FONT> * @throws LayoutException if there was a problem converting the path to an artifact.<a name="line.195"></a> |
| <FONT color="green">196</FONT> */<a name="line.196"></a> |
| <FONT color="green">197</FONT> ArtifactReference toArtifactReference( String path )<a name="line.197"></a> |
| <FONT color="green">198</FONT> throws LayoutException;<a name="line.198"></a> |
| <FONT color="green">199</FONT> <a name="line.199"></a> |
| <FONT color="green">200</FONT> /**<a name="line.200"></a> |
| <FONT color="green">201</FONT> * Given an {@link ArtifactReference}, return the file reference to the artifact.<a name="line.201"></a> |
| <FONT color="green">202</FONT> *<a name="line.202"></a> |
| <FONT color="green">203</FONT> * @param reference the artifact reference to use.<a name="line.203"></a> |
| <FONT color="green">204</FONT> * @return the relative path to the artifact.<a name="line.204"></a> |
| <FONT color="green">205</FONT> */<a name="line.205"></a> |
| <FONT color="green">206</FONT> File toFile( ArtifactReference reference );<a name="line.206"></a> |
| <FONT color="green">207</FONT> <a name="line.207"></a> |
| <FONT color="green">208</FONT> /**<a name="line.208"></a> |
| <FONT color="green">209</FONT> * Given an {@link ArchivaArtifact}, return the file reference to the artifact.<a name="line.209"></a> |
| <FONT color="green">210</FONT> *<a name="line.210"></a> |
| <FONT color="green">211</FONT> * @param reference the archiva artifact to use.<a name="line.211"></a> |
| <FONT color="green">212</FONT> * @return the relative path to the artifact.<a name="line.212"></a> |
| <FONT color="green">213</FONT> */<a name="line.213"></a> |
| <FONT color="green">214</FONT> File toFile( ArchivaArtifact reference );<a name="line.214"></a> |
| <FONT color="green">215</FONT> <a name="line.215"></a> |
| <FONT color="green">216</FONT> /**<a name="line.216"></a> |
| <FONT color="green">217</FONT> * Given a {@link ProjectReference}, return the path to the metadata for<a name="line.217"></a> |
| <FONT color="green">218</FONT> * the project.<a name="line.218"></a> |
| <FONT color="green">219</FONT> *<a name="line.219"></a> |
| <FONT color="green">220</FONT> * @param reference the reference to use.<a name="line.220"></a> |
| <FONT color="green">221</FONT> * @return the path to the metadata file, or null if no metadata is appropriate.<a name="line.221"></a> |
| <FONT color="green">222</FONT> */<a name="line.222"></a> |
| <FONT color="green">223</FONT> String toMetadataPath( ProjectReference reference );<a name="line.223"></a> |
| <FONT color="green">224</FONT> <a name="line.224"></a> |
| <FONT color="green">225</FONT> /**<a name="line.225"></a> |
| <FONT color="green">226</FONT> * Given a {@link VersionedReference}, return the path to the metadata for<a name="line.226"></a> |
| <FONT color="green">227</FONT> * the specific version of the project.<a name="line.227"></a> |
| <FONT color="green">228</FONT> *<a name="line.228"></a> |
| <FONT color="green">229</FONT> * @param reference the reference to use.<a name="line.229"></a> |
| <FONT color="green">230</FONT> * @return the path to the metadata file, or null if no metadata is appropriate.<a name="line.230"></a> |
| <FONT color="green">231</FONT> */<a name="line.231"></a> |
| <FONT color="green">232</FONT> String toMetadataPath( VersionedReference reference );<a name="line.232"></a> |
| <FONT color="green">233</FONT> <a name="line.233"></a> |
| <FONT color="green">234</FONT> /**<a name="line.234"></a> |
| <FONT color="green">235</FONT> * Given an {@link ArtifactReference}, return the relative path to the artifact.<a name="line.235"></a> |
| <FONT color="green">236</FONT> *<a name="line.236"></a> |
| <FONT color="green">237</FONT> * @param reference the artifact reference to use.<a name="line.237"></a> |
| <FONT color="green">238</FONT> * @return the relative path to the artifact.<a name="line.238"></a> |
| <FONT color="green">239</FONT> */<a name="line.239"></a> |
| <FONT color="green">240</FONT> String toPath( ArtifactReference reference );<a name="line.240"></a> |
| <FONT color="green">241</FONT> <a name="line.241"></a> |
| <FONT color="green">242</FONT> /**<a name="line.242"></a> |
| <FONT color="green">243</FONT> * Given an {@link ArchivaArtifact}, return the relative path to the artifact.<a name="line.243"></a> |
| <FONT color="green">244</FONT> *<a name="line.244"></a> |
| <FONT color="green">245</FONT> * @param reference the archiva artifact to use.<a name="line.245"></a> |
| <FONT color="green">246</FONT> * @return the relative path to the artifact.<a name="line.246"></a> |
| <FONT color="green">247</FONT> */<a name="line.247"></a> |
| <FONT color="green">248</FONT> String toPath( ArchivaArtifact reference );<a name="line.248"></a> |
| <FONT color="green">249</FONT> }<a name="line.249"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
