| <!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.repository.storage;<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 java.io.IOException;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.io.InputStream;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.io.OutputStream;<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.nio.channels.ReadableByteChannel;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import java.nio.channels.WritableByteChannel;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import java.nio.file.CopyOption;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import java.util.function.Consumer;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span><a name="line.30"></a> |
| <span class="sourceLineNo">031</span>/**<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> *<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * This is the low level API to access artifacts in a repository. Each artifact is represented<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * by one storage asset. Each asset can be accessed by a path that is independent on the underlying storage<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * implementation. Paths always use '/' as path separator. The path is local to the repository and<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * is unique for each asset.<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * The storage API knows nothing about the repository layout or repository specific metadata.<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * If you use this API you must either have knowledge about the specific repository layout or use the structure<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * as it is, e.g. for browsing.<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> *<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * The base implementation for the storage uses a directory structure on the local filesystem.<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> * It is the decision of the repository type specific implementation, if this API provides access to all elements, that<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * is really stored or just a selected view.<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> *<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * Checking access is not part of this API.<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> */<a name="line.48"></a> |
| <span class="sourceLineNo">049</span>public interface RepositoryStorage {<a name="line.49"></a> |
| <span class="sourceLineNo">050</span><a name="line.50"></a> |
| <span class="sourceLineNo">051</span> /**<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * Returns a URI representation of the storage location.<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> *<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * @return The URI that is pointing to the storage.<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> */<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> URI getLocation();<a name="line.56"></a> |
| <span class="sourceLineNo">057</span><a name="line.57"></a> |
| <span class="sourceLineNo">058</span> /**<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * Updates the base location of the repository storage. The method does not move any data.<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * It just points to the new location. Artifacts may not be accessible anymore if the data has<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * not been moved or copied. Assets retrieved before the relocation may still be pointing to the<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * old location.<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> *<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * @param newLocation The URI to the new location<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> *<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * @throws IOException If the repository cannot be relocated<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> */<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> void updateLocation(URI newLocation) throws IOException;<a name="line.68"></a> |
| <span class="sourceLineNo">069</span><a name="line.69"></a> |
| <span class="sourceLineNo">070</span> /**<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * Returns information about a specific storage asset.<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * @param path<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * @return<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> */<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> StorageAsset getAsset(String path);<a name="line.75"></a> |
| <span class="sourceLineNo">076</span><a name="line.76"></a> |
| <span class="sourceLineNo">077</span> /**<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * Consumes the data and sets a lock for the file during the operation.<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> *<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * @param asset The asset from which the data is consumed.<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * @param consumerFunction The consumer that reads the data<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * @param readLock If true, a read lock is acquired on the asset.<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * @throws IOException<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> */<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> void consumeData(StorageAsset asset, Consumer<InputStream> consumerFunction, boolean readLock) throws IOException;<a name="line.85"></a> |
| <span class="sourceLineNo">086</span><a name="line.86"></a> |
| <span class="sourceLineNo">087</span> /**<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * Consumes the data and sets a lock for the file during the operation.<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> *<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * @param asset The asset from which the data is consumed.<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * @param consumerFunction The consumer that reads the data<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * @param readLock If true, a read lock is acquired on the asset.<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * @throws IOException<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> */<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> void consumeDataFromChannel( StorageAsset asset, Consumer<ReadableByteChannel> consumerFunction, boolean readLock) throws IOException;<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> * Writes data to the asset using a write lock.<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> *<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * @param asset The asset to which the data is written.<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * @param consumerFunction The function that provides the data.<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * @param writeLock If true, a write lock is acquired on the destination.<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> */<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> void writeData( StorageAsset asset, Consumer<OutputStream> consumerFunction, boolean writeLock) throws IOException;;<a name="line.104"></a> |
| <span class="sourceLineNo">105</span><a name="line.105"></a> |
| <span class="sourceLineNo">106</span> /**<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * Writes data and sets a lock during the operation.<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> *<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> * @param asset The asset to which the data is written.<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * @param consumerFunction The function that provides the data.<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * @param writeLock If true, a write lock is acquired on the destination.<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> * @throws IOException<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> */<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> void writeDataToChannel( StorageAsset asset, Consumer<WritableByteChannel> consumerFunction, boolean writeLock) throws IOException;<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> * Adds a new asset to the underlying storage.<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> * @param path The path to the asset.<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> * @param container True, if the asset should be a container, false, if it is a file.<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> * @return<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> */<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> StorageAsset addAsset(String path, boolean container);<a name="line.122"></a> |
| <span class="sourceLineNo">123</span><a name="line.123"></a> |
| <span class="sourceLineNo">124</span> /**<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> * Removes the given asset from the storage.<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> *<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> * @param asset<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> * @throws IOException<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> */<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> void removeAsset(StorageAsset asset) throws IOException;<a name="line.130"></a> |
| <span class="sourceLineNo">131</span><a name="line.131"></a> |
| <span class="sourceLineNo">132</span> /**<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> * Moves the asset to the given location and returns the asset object for the destination. Moves only assets that<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> * belong to the same storage instance. It will throw a IOException if the assets are from differents storage<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> * instances.<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> *<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> * @param origin The original asset<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> * @param destination The destination path pointing to the new asset.<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> * @param copyOptions The copy options.<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> * @return The asset representation of the moved object.<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> */<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> StorageAsset moveAsset(StorageAsset origin, String destination, CopyOption... copyOptions) throws IOException;<a name="line.142"></a> |
| <span class="sourceLineNo">143</span><a name="line.143"></a> |
| <span class="sourceLineNo">144</span> /**<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> * Moves the asset to the given location and returns the asset object for the destination. Moves only assets that<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> * belong to the same storage instance. It will throw a IOException if the assets are from differents storage<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> * instances.<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> * *<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> * @param origin The original asset<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> * @param destination The destination path.<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> * @param copyOptions The copy options (e.g. {@link java.nio.file.StandardCopyOption#REPLACE_EXISTING}<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> * @throws IOException If it was not possible to copy the asset.<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> */<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> void moveAsset(StorageAsset origin, StorageAsset destination, CopyOption... copyOptions) throws IOException;<a name="line.154"></a> |
| <span class="sourceLineNo">155</span><a name="line.155"></a> |
| <span class="sourceLineNo">156</span> /**<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> * Copies the given asset to the new destination. Copies only assets that belong to the same storage instance.<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> * It will throw a IOException if the assets are from differents storage instances.<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> *<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> * @param origin The original asset<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> * @param destination The path to the new asset<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> * @param copyOptions The copy options, e.g. (e.g. {@link java.nio.file.StandardCopyOption#REPLACE_EXISTING}<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> * @return The asset representation of the copied object<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> * @throws IOException If it was not possible to copy the asset<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> */<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> StorageAsset copyAsset(StorageAsset origin, String destination, CopyOption... copyOptions) throws IOException;<a name="line.166"></a> |
| <span class="sourceLineNo">167</span><a name="line.167"></a> |
| <span class="sourceLineNo">168</span> /**<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> * Copies the given asset to the new destination. Copies only assets that belong to the same storage instance.<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> * It will throw a IOException if the assets are from differents storage instances.<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> *<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> * @param origin The original asset<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> * @param destination The path to the new asset<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> * @param copyOptions The copy options, e.g. (e.g. {@link java.nio.file.StandardCopyOption#REPLACE_EXISTING}<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> * @throws IOException If it was not possible to copy the asset<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> */<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> void copyAsset( StorageAsset origin, StorageAsset destination, CopyOption... copyOptions) throws IOException;<a name="line.177"></a> |
| <span class="sourceLineNo">178</span><a name="line.178"></a> |
| <span class="sourceLineNo">179</span><a name="line.179"></a> |
| <span class="sourceLineNo">180</span>}<a name="line.180"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
