1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
3 <head><meta http-equiv="content-type" content="text/html; charset=UTF-8" />
4 <title>HttpResources xref</title>
5 <link type="text/css" rel="stylesheet" href="../../../stylesheet.css" />
8 <div id="overview"><a href="../../../../apidocs/de/juplo/httpresources/HttpResources.html">View Javadoc</a></div><pre>
9 <a class="jxr_linenumber" name="L1" href="#L1">1</a> <strong class="jxr_keyword">package</strong> de.juplo.httpresources;
10 <a class="jxr_linenumber" name="L2" href="#L2">2</a>
11 <a class="jxr_linenumber" name="L3" href="#L3">3</a>
12 <a class="jxr_linenumber" name="L4" href="#L4">4</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger;
13 <a class="jxr_linenumber" name="L5" href="#L5">5</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory;
14 <a class="jxr_linenumber" name="L6" href="#L6">6</a> <strong class="jxr_keyword">import</strong> org.springframework.core.io.Resource;
15 <a class="jxr_linenumber" name="L7" href="#L7">7</a> <strong class="jxr_keyword">import</strong> org.springframework.util.Assert;
16 <a class="jxr_linenumber" name="L8" href="#L8">8</a>
17 <a class="jxr_linenumber" name="L9" href="#L9">9</a> <strong class="jxr_keyword">import</strong> java.io.*;
18 <a class="jxr_linenumber" name="L10" href="#L10">10</a> <strong class="jxr_keyword">import</strong> java.net.URI;
19 <a class="jxr_linenumber" name="L11" href="#L11">11</a> <strong class="jxr_keyword">import</strong> java.net.URISyntaxException;
20 <a class="jxr_linenumber" name="L12" href="#L12">12</a> <strong class="jxr_keyword">import</strong> java.time.Clock;
21 <a class="jxr_linenumber" name="L13" href="#L13">13</a> <strong class="jxr_keyword">import</strong> java.util.regex.Pattern;
22 <a class="jxr_linenumber" name="L14" href="#L14">14</a>
23 <a class="jxr_linenumber" name="L15" href="#L15">15</a>
24 <a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_javadoccomment">/**</em>
25 <a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_javadoccomment"> *</em>
26 <a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_javadoccomment"> * @author Kai Moritz</em>
27 <a class="jxr_linenumber" name="L19" href="#L19">19</a> <em class="jxr_javadoccomment"> */</em>
28 <a class="jxr_linenumber" name="L20" href="#L20">20</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="HttpResources" href="../../../de/juplo/httpresources/HttpResources.html#HttpResources">HttpResources</a>
29 <a class="jxr_linenumber" name="L21" href="#L21">21</a> {
30 <a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">static</strong> Logger LOG =
31 <a class="jxr_linenumber" name="L23" href="#L23">23</a> LoggerFactory.getLogger(HttpResources.<strong class="jxr_keyword">class</strong>);
32 <a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">static</strong> Pattern RESOURCE_PATH_PATTERN =
33 <a class="jxr_linenumber" name="L25" href="#L25">25</a> Pattern.compile(<span class="jxr_string">"^http"</span>, Pattern.CASE_INSENSITIVE);
34 <a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">static</strong> URI ABSOLUTE_PATH = URI.create(<span class="jxr_string">"/"</span>);
35 <a class="jxr_linenumber" name="L27" href="#L27">27</a>
36 <a class="jxr_linenumber" name="L28" href="#L28">28</a>
37 <a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a name="HttpResourceFetcher" href="../../../de/juplo/httpresources/HttpResourceFetcher.html#HttpResourceFetcher">HttpResourceFetcher</a> fetcher;
38 <a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Clock clock;
39 <a class="jxr_linenumber" name="L31" href="#L31">31</a>
40 <a class="jxr_linenumber" name="L32" href="#L32">32</a>
41 <a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">public</strong> <a name="HttpResources" href="../../../de/juplo/httpresources/HttpResources.html#HttpResources">HttpResources</a>(<a name="HttpResourceFetcher" href="../../../de/juplo/httpresources/HttpResourceFetcher.html#HttpResourceFetcher">HttpResourceFetcher</a> fetcher, Clock clock)
42 <a class="jxr_linenumber" name="L34" href="#L34">34</a> {
43 <a class="jxr_linenumber" name="L35" href="#L35">35</a> Assert.notNull(fetcher, <span class="jxr_string">"The HttpResourceFetcher must not be null"</span>);
44 <a class="jxr_linenumber" name="L36" href="#L36">36</a> Assert.notNull(clock, <span class="jxr_string">"The Clock must not be null"</span>);
45 <a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">this</strong>.fetcher = fetcher;
46 <a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">this</strong>.clock = clock;
47 <a class="jxr_linenumber" name="L39" href="#L39">39</a> }
48 <a class="jxr_linenumber" name="L40" href="#L40">40</a>
49 <a class="jxr_linenumber" name="L41" href="#L41">41</a>
50 <a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment">/**</em>
51 <a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * @param uri the resource location (must be a valid <code>URI</code>)</em>
52 <a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * @return the corresponding Resource handle (never {@code null})</em>
53 <a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * @see {@link HttpResources#getResource(String)}</em>
54 <a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> */</em>
55 <a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">public</strong> <a name="HttpResource" href="../../../de/juplo/httpresources/HttpResource.html#HttpResource">HttpResource</a> getResource(String uri)
56 <a class="jxr_linenumber" name="L48" href="#L48">48</a> {
57 <a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">return</strong> getResource(HttpResources.convert(uri));
58 <a class="jxr_linenumber" name="L50" href="#L50">50</a> }
59 <a class="jxr_linenumber" name="L51" href="#L51">51</a>
60 <a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment">/**</em>
61 <a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * Returns the {@link HttpResource}, that represents the given {@link URI}.</em>
62 <a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * <p>Note that a Resource handle does not imply an existing resource;</em>
63 <a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * you need to invoke {@link Resource#exists} to check for existence.</em>
64 <a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * @param uri the resource location, represented as an {@link URI}</em>
65 <a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * @return the corresponding Resource handle (never {@code null})</em>
66 <a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> */</em>
67 <a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong class="jxr_keyword">public</strong> <a name="HttpResource" href="../../../de/juplo/httpresources/HttpResource.html#HttpResource">HttpResource</a> getResource(URI uri)
68 <a class="jxr_linenumber" name="L60" href="#L60">60</a> {
69 <a class="jxr_linenumber" name="L61" href="#L61">61</a> <a name="HttpData" href="../../../de/juplo/httpresources/HttpData.html#HttpData">HttpData</a> data = fetcher.fetch(uri, HttpData.NOT_FETCHED);
70 <a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a name="HttpResource" href="../../../de/juplo/httpresources/HttpResource.html#HttpResource">HttpResource</a>(<strong class="jxr_keyword">this</strong>, fetcher, clock, uri, data);
71 <a class="jxr_linenumber" name="L63" href="#L63">63</a> }
72 <a class="jxr_linenumber" name="L64" href="#L64">64</a>
73 <a class="jxr_linenumber" name="L65" href="#L65">65</a>
74 <a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> URI convert(String url)
75 <a class="jxr_linenumber" name="L67" href="#L67">67</a> {
76 <a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">return</strong> HttpResources.normalize(URI.create(url));
77 <a class="jxr_linenumber" name="L69" href="#L69">69</a> }
78 <a class="jxr_linenumber" name="L70" href="#L70">70</a>
79 <a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> URI normalize(URI uri)
80 <a class="jxr_linenumber" name="L72" href="#L72">72</a> {
81 <a class="jxr_linenumber" name="L73" href="#L73">73</a> uri = uri.normalize();
82 <a class="jxr_linenumber" name="L74" href="#L74">74</a>
83 <a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_comment">// An URI is opaque, if it is absolute and the scheme-specific part does</em>
84 <a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_comment">// not start with a slash. A HTTP-URL cannot be opaque in this meaning!</em>
85 <a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">if</strong> (uri.isOpaque())
86 <a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"An opaque URI is no valid HTTP-URL: "</span> + uri);
87 <a class="jxr_linenumber" name="L79" href="#L79">79</a>
88 <a class="jxr_linenumber" name="L80" href="#L80">80</a> String scheme = <strong class="jxr_keyword">null</strong>;
89 <a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">if</strong> (uri.isAbsolute())
90 <a class="jxr_linenumber" name="L82" href="#L82">82</a> {
91 <a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_comment">// Enforce scheme "HTTP" or "HTTPS"</em>
92 <a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">switch</strong> (uri.getScheme().toLowerCase())
93 <a class="jxr_linenumber" name="L85" href="#L85">85</a> {
94 <a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong class="jxr_keyword">case</strong> <span class="jxr_string">"http"</span>:
95 <a class="jxr_linenumber" name="L87" href="#L87">87</a> scheme = <span class="jxr_string">"http"</span>;
96 <a class="jxr_linenumber" name="L88" href="#L88">88</a> <strong class="jxr_keyword">break</strong>;
97 <a class="jxr_linenumber" name="L89" href="#L89">89</a> <strong class="jxr_keyword">case</strong> <span class="jxr_string">"https"</span>:
98 <a class="jxr_linenumber" name="L90" href="#L90">90</a> scheme = <span class="jxr_string">"https"</span>;
99 <a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">break</strong>;
100 <a class="jxr_linenumber" name="L92" href="#L92">92</a> <strong class="jxr_keyword">default</strong>:
101 <a class="jxr_linenumber" name="L93" href="#L93">93</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"Unallowed scheme: "</span> + uri);
102 <a class="jxr_linenumber" name="L94" href="#L94">94</a> }
103 <a class="jxr_linenumber" name="L95" href="#L95">95</a> }
104 <a class="jxr_linenumber" name="L96" href="#L96">96</a>
105 <a class="jxr_linenumber" name="L97" href="#L97">97</a> String host = uri.getHost();
106 <a class="jxr_linenumber" name="L98" href="#L98">98</a> String path = uri.getRawPath();
107 <a class="jxr_linenumber" name="L99" href="#L99">99</a>
108 <a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong class="jxr_keyword">if</strong> (host == <strong class="jxr_keyword">null</strong>)
109 <a class="jxr_linenumber" name="L101" href="#L101">101</a> {
110 <a class="jxr_linenumber" name="L102" href="#L102">102</a> <strong class="jxr_keyword">if</strong> (scheme != <strong class="jxr_keyword">null</strong>)
111 <a class="jxr_linenumber" name="L103" href="#L103">103</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"Host is missing, although scheme is not empty: "</span> + scheme);
112 <a class="jxr_linenumber" name="L104" href="#L104">104</a> }
113 <a class="jxr_linenumber" name="L105" href="#L105">105</a> <strong class="jxr_keyword">else</strong>
114 <a class="jxr_linenumber" name="L106" href="#L106">106</a> {
115 <a class="jxr_linenumber" name="L107" href="#L107">107</a> host = host.toLowerCase();
116 <a class="jxr_linenumber" name="L108" href="#L108">108</a> path = path == <strong class="jxr_keyword">null</strong> || path.isEmpty() ? <span class="jxr_string">"/"</span> : path;
117 <a class="jxr_linenumber" name="L109" href="#L109">109</a> }
118 <a class="jxr_linenumber" name="L110" href="#L110">110</a>
119 <a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong class="jxr_keyword">try</strong>
120 <a class="jxr_linenumber" name="L112" href="#L112">112</a> {
121 <a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> URI(
122 <a class="jxr_linenumber" name="L114" href="#L114">114</a> scheme,
123 <a class="jxr_linenumber" name="L115" href="#L115">115</a> uri.getUserInfo(),
124 <a class="jxr_linenumber" name="L116" href="#L116">116</a> host,
125 <a class="jxr_linenumber" name="L117" href="#L117">117</a> uri.getPort(),
126 <a class="jxr_linenumber" name="L118" href="#L118">118</a> path,
127 <a class="jxr_linenumber" name="L119" href="#L119">119</a> uri.getQuery(),
128 <a class="jxr_linenumber" name="L120" href="#L120">120</a> uri.getFragment()
129 <a class="jxr_linenumber" name="L121" href="#L121">121</a> );
130 <a class="jxr_linenumber" name="L122" href="#L122">122</a> }
131 <a class="jxr_linenumber" name="L123" href="#L123">123</a> <strong class="jxr_keyword">catch</strong> (URISyntaxException e)
132 <a class="jxr_linenumber" name="L124" href="#L124">124</a> {
133 <a class="jxr_linenumber" name="L125" href="#L125">125</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"Invalid HTTP-URL: "</span>, e);
134 <a class="jxr_linenumber" name="L126" href="#L126">126</a> }
135 <a class="jxr_linenumber" name="L127" href="#L127">127</a> }
136 <a class="jxr_linenumber" name="L128" href="#L128">128</a>
137 <a class="jxr_linenumber" name="L129" href="#L129">129</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> URI resolve(URI relative, URI uri) <strong class="jxr_keyword">throws</strong> IOException
138 <a class="jxr_linenumber" name="L130" href="#L130">130</a> {
139 <a class="jxr_linenumber" name="L131" href="#L131">131</a> <strong class="jxr_keyword">if</strong> (relative.getAuthority() != <strong class="jxr_keyword">null</strong>)
140 <a class="jxr_linenumber" name="L132" href="#L132">132</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IOException(<span class="jxr_string">"URI is not relative: "</span> + relative);
141 <a class="jxr_linenumber" name="L133" href="#L133">133</a>
142 <a class="jxr_linenumber" name="L134" href="#L134">134</a> URI cleaned;
143 <a class="jxr_linenumber" name="L135" href="#L135">135</a> <strong class="jxr_keyword">try</strong>
144 <a class="jxr_linenumber" name="L136" href="#L136">136</a> {
145 <a class="jxr_linenumber" name="L137" href="#L137">137</a> String path = relative.getRawPath();
146 <a class="jxr_linenumber" name="L138" href="#L138">138</a> <strong class="jxr_keyword">int</strong> length = path == <strong class="jxr_keyword">null</strong> ? -1 : path.length();
147 <a class="jxr_linenumber" name="L139" href="#L139">139</a> <strong class="jxr_keyword">int</strong> i = 0;
148 <a class="jxr_linenumber" name="L140" href="#L140">140</a>
149 <a class="jxr_linenumber" name="L141" href="#L141">141</a> <strong class="jxr_keyword">while</strong> (i < length)
150 <a class="jxr_linenumber" name="L142" href="#L142">142</a> {
151 <a class="jxr_linenumber" name="L143" href="#L143">143</a> <strong class="jxr_keyword">switch</strong> (path.charAt(i))
152 <a class="jxr_linenumber" name="L144" href="#L144">144</a> {
153 <a class="jxr_linenumber" name="L145" href="#L145">145</a> <strong class="jxr_keyword">case</strong> '.':
154 <a class="jxr_linenumber" name="L146" href="#L146">146</a> <strong class="jxr_keyword">case</strong> '/':
155 <a class="jxr_linenumber" name="L147" href="#L147">147</a> i++;
156 <a class="jxr_linenumber" name="L148" href="#L148">148</a> <strong class="jxr_keyword">break</strong>;
157 <a class="jxr_linenumber" name="L149" href="#L149">149</a> <strong class="jxr_keyword">default</strong>:
158 <a class="jxr_linenumber" name="L150" href="#L150">150</a> length = -1;
159 <a class="jxr_linenumber" name="L151" href="#L151">151</a> }
160 <a class="jxr_linenumber" name="L152" href="#L152">152</a> }
161 <a class="jxr_linenumber" name="L153" href="#L153">153</a>
162 <a class="jxr_linenumber" name="L154" href="#L154">154</a> cleaned = i > 0
163 <a class="jxr_linenumber" name="L155" href="#L155">155</a> ? <strong class="jxr_keyword">new</strong> URI(
164 <a class="jxr_linenumber" name="L156" href="#L156">156</a> <strong class="jxr_keyword">null</strong>,
165 <a class="jxr_linenumber" name="L157" href="#L157">157</a> <strong class="jxr_keyword">null</strong>,
166 <a class="jxr_linenumber" name="L158" href="#L158">158</a> <strong class="jxr_keyword">null</strong>,
167 <a class="jxr_linenumber" name="L159" href="#L159">159</a> 0,
168 <a class="jxr_linenumber" name="L160" href="#L160">160</a> i == path.length() ? <strong class="jxr_keyword">null</strong> : path.substring(i),
169 <a class="jxr_linenumber" name="L161" href="#L161">161</a> relative.getQuery(),
170 <a class="jxr_linenumber" name="L162" href="#L162">162</a> relative.getFragment()
171 <a class="jxr_linenumber" name="L163" href="#L163">163</a> )
172 <a class="jxr_linenumber" name="L164" href="#L164">164</a> : relative;
173 <a class="jxr_linenumber" name="L165" href="#L165">165</a>
174 <a class="jxr_linenumber" name="L166" href="#L166">166</a> path = uri.getPath();
175 <a class="jxr_linenumber" name="L167" href="#L167">167</a> <strong class="jxr_keyword">if</strong> (path == <strong class="jxr_keyword">null</strong> || path.length() == 0)
176 <a class="jxr_linenumber" name="L168" href="#L168">168</a> uri = uri.resolve(ABSOLUTE_PATH);
177 <a class="jxr_linenumber" name="L169" href="#L169">169</a> }
178 <a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong class="jxr_keyword">catch</strong> (URISyntaxException e)
179 <a class="jxr_linenumber" name="L171" href="#L171">171</a> {
180 <a class="jxr_linenumber" name="L172" href="#L172">172</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IOException(<span class="jxr_string">"Invalid relative path: "</span> + relative, e);
181 <a class="jxr_linenumber" name="L173" href="#L173">173</a> }
182 <a class="jxr_linenumber" name="L174" href="#L174">174</a>
183 <a class="jxr_linenumber" name="L175" href="#L175">175</a> URI resolved = uri.resolve(cleaned);
184 <a class="jxr_linenumber" name="L176" href="#L176">176</a> LOG.trace(<span class="jxr_string">"resolved {} as {} in context {}"</span>, relative, resolved, uri);
185 <a class="jxr_linenumber" name="L177" href="#L177">177</a> <strong class="jxr_keyword">return</strong> resolved;
186 <a class="jxr_linenumber" name="L178" href="#L178">178</a> }
187 <a class="jxr_linenumber" name="L179" href="#L179">179</a>
188 <a class="jxr_linenumber" name="L180" href="#L180">180</a>
189 <a class="jxr_linenumber" name="L181" href="#L181">181</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> isHttpResource(String resourcePath)
190 <a class="jxr_linenumber" name="L182" href="#L182">182</a> {
191 <a class="jxr_linenumber" name="L183" href="#L183">183</a> <strong class="jxr_keyword">return</strong> RESOURCE_PATH_PATTERN.matcher(resourcePath).find();
192 <a class="jxr_linenumber" name="L184" href="#L184">184</a> }
193 <a class="jxr_linenumber" name="L185" href="#L185">185</a> }
196 <div id="footer">Copyright © 2020–2021 <a href="https://juplo.de">juplo</a>. All rights reserved.</div>
projects / website / blob