| <!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;<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.model.ArtifactReference;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.archiva.repository.features.RepositoryFeature;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span><a name="line.24"></a> |
| <span class="sourceLineNo">025</span>/**<a name="line.25"></a> |
| <span class="sourceLineNo">026</span> * This interface is for mapping web request paths to artifacts.<a name="line.26"></a> |
| <span class="sourceLineNo">027</span> * The file system storage may differ from the paths used for web access.<a name="line.27"></a> |
| <span class="sourceLineNo">028</span> *<a name="line.28"></a> |
| <span class="sourceLineNo">029</span> * @author Martin Stockhammer <martin_s@apache.org><a name="line.29"></a> |
| <span class="sourceLineNo">030</span> */<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>public interface RepositoryRequestInfo<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>{<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> * Returns the artifact reference for a given path.<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * Takes an incoming requested path (in "/" format) and gleans the layout<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * and ArtifactReference appropriate for that content.<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> *<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * @param requestPath The path of the web request<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * @return The artifact reference<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * @throws LayoutException<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> */<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> ArtifactReference toArtifactReference( String requestPath ) throws LayoutException;<a name="line.43"></a> |
| <span class="sourceLineNo">044</span><a name="line.44"></a> |
| <span class="sourceLineNo">045</span> /**<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * <p><a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * Tests the path to see if it conforms to the expectations of a metadata request.<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * </p><a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * <p><a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * NOTE: The implementation may do only a cursory check on the path's extension. A result of true<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * from this method is not a guarantee that the support resource is in a valid format, or<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * that it even contains data.<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * </p><a name="line.53"></a> |
| <span class="sourceLineNo">054</span> *<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * @param requestPath the path to test.<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * @return true if the requestedPath is likely a metadata request.<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> */<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> boolean isMetadata( String requestPath );<a name="line.58"></a> |
| <span class="sourceLineNo">059</span><a name="line.59"></a> |
| <span class="sourceLineNo">060</span> /**<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * Returns true, if the given request points to a archetype catalog.<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> *<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * @param requestPath<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * @return true if the requestedPath is likely an archetype catalog request.<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> */<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> boolean isArchetypeCatalog( String requestPath );<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> * <p><a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * Tests the path to see if it conforms to the expectations of a support file request. Support files are used<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * for signing and validating the artifact files.<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * </p><a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * <p><a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * May test for certain extensions like <code>.sha1</code>, <code>.md5</code>, <code>.asc</code>, and <code>.php</code>.<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * </p><a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * <p><a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * NOTE: The implementation may do only a cursory check on the path's extension. A result of true<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * from this method is not a guarantee that the support resource is in a valid format, or<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * that it even contains data.<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * </p><a name="line.80"></a> |
| <span class="sourceLineNo">081</span> *<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * @param requestPath the path to test.<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * @return true if the requestedPath is likely that of a support file request.<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> */<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> boolean isSupportFile( String requestPath );<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> * <p><a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * Tests the path to see if it conforms to the expectations of a support file request of the metadata file.<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * </p><a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * <p><a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * May test for certain extensions like <code>.sha1</code>, <code>.md5</code>, <code>.asc</code>, and <code>.php</code>.<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * </p><a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * <p><a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * NOTE: The implementation may do only a cursory check on the path's extension. A result of true<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> * from this method is not a guarantee that the support resource is in a valid format, or<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * that it even contains data.<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * </p><a name="line.98"></a> |
| <span class="sourceLineNo">099</span> *<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * @param requestPath the path to test.<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * @return true if the requestedPath is likely that of a support file request.<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> */<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> boolean isMetadataSupportFile( String requestPath );<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> * Returns the likely layout type for the given request.<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * Implementations may only check the path elements for this. To make sure, the path is valid,<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * you should call {@link #toArtifactReference(String)}<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> *<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * @return<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> */<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> String getLayout( String requestPath );<a name="line.112"></a> |
| <span class="sourceLineNo">113</span><a name="line.113"></a> |
| <span class="sourceLineNo">114</span> /**<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> * Adjust the requestedPath to conform to the native layout of the provided {@link org.apache.archiva.repository.ManagedRepositoryContent}.<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> *<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> * @param requestPath the incoming requested path.<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> * @return the adjusted (to native) path.<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> * @throws LayoutException if the path cannot be parsed.<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> */<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> String toNativePath( String requestPath) throws LayoutException;<a name="line.121"></a> |
| <span class="sourceLineNo">122</span><a name="line.122"></a> |
| <span class="sourceLineNo">123</span> /**<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> * Extension method that allows to provide different features that are not supported by all<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> * repository types.<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> *<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> * @param clazz The feature class that is requested<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> * @param <T> This is the class of the feature<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> * @return The feature implementation for this repository instance, if it is supported<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> * @throws UnsupportedFeatureException if the feature is not supported by this repository type<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> */<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> <T extends RepositoryFeature<T>> RepositoryFeature<T> getFeature( Class<T> clazz ) throws UnsupportedFeatureException;<a name="line.132"></a> |
| <span class="sourceLineNo">133</span><a name="line.133"></a> |
| <span class="sourceLineNo">134</span><a name="line.134"></a> |
| <span class="sourceLineNo">135</span> /**<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> * Returns true, if the requested feature is supported by this repository.<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> *<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> * @param clazz The requested feature class<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> * @param <T> The requested feature class<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> * @return True, if the feature is supported, otherwise false.<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> */<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> <T extends RepositoryFeature<T>> boolean supportsFeature( Class<T> clazz );<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>}<a name="line.145"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
