blob: e4d0851d1b9897c57b42c35b26fea2f6c7c0f655 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>HttpUtils xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
</head>
<body>
<pre>
<a name="1" href="#1">1</a> <em class="jxr_comment">/*</em>
<a name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a name="3" href="#3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
<a name="4" href="#4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
<a name="5" href="#5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
<a name="6" href="#6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
<a name="7" href="#7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
<a name="8" href="#8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
<a name="9" href="#9">9</a> <em class="jxr_comment"> *</em>
<a name="10" href="#10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="11" href="#11">11</a> <em class="jxr_comment"> *</em>
<a name="12" href="#12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
<a name="13" href="#13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
<a name="14" href="#14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a name="15" href="#15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
<a name="16" href="#16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
<a name="17" href="#17">17</a> <em class="jxr_comment"> * under the License.</em>
<a name="18" href="#18">18</a> <em class="jxr_comment"> */</em>
<a name="19" href="#19">19</a> <strong class="jxr_keyword">package</strong> org.apache.chemistry.opencmis.server.shared;
<a name="20" href="#20">20</a>
<a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> java.io.File;
<a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.lang.reflect.Method;
<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.math.BigInteger;
<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.util.Map;
<a name="25" href="#25">25</a>
<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletContext;
<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletRequest;
<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletResponse;
<a name="29" href="#29">29</a>
<a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> org.apache.chemistry.opencmis.commons.exceptions.CmisInvalidArgumentException;
<a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> org.apache.chemistry.opencmis.commons.exceptions.CmisRuntimeException;
<a name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> org.apache.chemistry.opencmis.commons.server.CallContext;
<a name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> org.apache.chemistry.opencmis.server.impl.CallContextImpl;
<a name="34" href="#34">34</a>
<a name="35" href="#35">35</a> <em class="jxr_javadoccomment">/**</em>
<a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * Utility methods that are used by the AtomPub and Browser binding.</em>
<a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> */</em>
<a name="38" href="#38">38</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/chemistry/opencmis/server/shared/HttpUtils.html">HttpUtils</a> {
<a name="39" href="#39">39</a>
<a name="40" href="#40">40</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../org/apache/chemistry/opencmis/server/shared/HttpUtils.html">HttpUtils</a>() {
<a name="41" href="#41">41</a> }
<a name="42" href="#42">42</a>
<a name="43" href="#43">43</a> <em class="jxr_javadoccomment">/**</em>
<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * Creates a {@link CallContext} object from a servlet request.</em>
<a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> */</em>
<a name="46" href="#46">46</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> CallContext createContext(HttpServletRequest request, HttpServletResponse response,
<a name="47" href="#47">47</a> ServletContext servletContext, String binding, <a href="../../../../../../org/apache/chemistry/opencmis/server/shared/CallContextHandler.html">CallContextHandler</a> callContextHandler, File tempDir,
<a name="48" href="#48">48</a> <strong class="jxr_keyword">int</strong> memoryThreshold) {
<a name="49" href="#49">49</a> String[] pathFragments = splitPath(request);
<a name="50" href="#50">50</a>
<a name="51" href="#51">51</a> String repositoryId = <strong class="jxr_keyword">null</strong>;
<a name="52" href="#52">52</a> <strong class="jxr_keyword">if</strong> (pathFragments.length &gt; 0) {
<a name="53" href="#53">53</a> repositoryId = pathFragments[0];
<a name="54" href="#54">54</a> }
<a name="55" href="#55">55</a>
<a name="56" href="#56">56</a> <a href="../../../../../../org/apache/chemistry/opencmis/server/impl/CallContextImpl.html">CallContextImpl</a> context = <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/chemistry/opencmis/server/impl/CallContextImpl.html">CallContextImpl</a>(binding, repositoryId, <strong class="jxr_keyword">true</strong>);
<a name="57" href="#57">57</a>
<a name="58" href="#58">58</a> <em class="jxr_comment">// call call context handler</em>
<a name="59" href="#59">59</a> <strong class="jxr_keyword">if</strong> (callContextHandler != <strong class="jxr_keyword">null</strong>) {
<a name="60" href="#60">60</a> Map&lt;String, String&gt; callContextMap = callContextHandler.getCallContextMap(request);
<a name="61" href="#61">61</a> <strong class="jxr_keyword">if</strong> (callContextMap != <strong class="jxr_keyword">null</strong>) {
<a name="62" href="#62">62</a> <strong class="jxr_keyword">for</strong> (Map.Entry&lt;String, String&gt; e : callContextMap.entrySet()) {
<a name="63" href="#63">63</a> context.put(e.getKey(), e.getValue());
<a name="64" href="#64">64</a> }
<a name="65" href="#65">65</a> }
<a name="66" href="#66">66</a> }
<a name="67" href="#67">67</a>
<a name="68" href="#68">68</a> <em class="jxr_comment">// servlet context and HTTP servlet request and response</em>
<a name="69" href="#69">69</a> context.put(CallContext.SERVLET_CONTEXT, servletContext);
<a name="70" href="#70">70</a> context.put(CallContext.HTTP_SERVLET_REQUEST, request);
<a name="71" href="#71">71</a> context.put(CallContext.HTTP_SERVLET_RESPONSE, response);
<a name="72" href="#72">72</a>
<a name="73" href="#73">73</a> <em class="jxr_comment">// temp files</em>
<a name="74" href="#74">74</a> context.put(CallContext.TEMP_DIR, tempDir);
<a name="75" href="#75">75</a> context.put(CallContext.MEMORY_THRESHOLD, memoryThreshold);
<a name="76" href="#76">76</a>
<a name="77" href="#77">77</a> <em class="jxr_comment">// decode range</em>
<a name="78" href="#78">78</a> String rangeHeader = request.getHeader(<span class="jxr_string">"Range"</span>);
<a name="79" href="#79">79</a> <strong class="jxr_keyword">if</strong> (rangeHeader != <strong class="jxr_keyword">null</strong>) {
<a name="80" href="#80">80</a> rangeHeader = rangeHeader.trim();
<a name="81" href="#81">81</a> BigInteger offset = <strong class="jxr_keyword">null</strong>;
<a name="82" href="#82">82</a> BigInteger length = <strong class="jxr_keyword">null</strong>;
<a name="83" href="#83">83</a>
<a name="84" href="#84">84</a> <strong class="jxr_keyword">int</strong> eq = rangeHeader.indexOf('=');
<a name="85" href="#85">85</a> <strong class="jxr_keyword">int</strong> ds = rangeHeader.indexOf('-');
<a name="86" href="#86">86</a> <strong class="jxr_keyword">if</strong> ((eq &gt; 0) &amp;&amp; (ds &gt; eq)) {
<a name="87" href="#87">87</a> String offsetStr = rangeHeader.substring(eq + 1, ds).trim();
<a name="88" href="#88">88</a> <strong class="jxr_keyword">if</strong> (offsetStr.length() &gt; 0) {
<a name="89" href="#89">89</a> offset = <strong class="jxr_keyword">new</strong> BigInteger(offsetStr);
<a name="90" href="#90">90</a> }
<a name="91" href="#91">91</a>
<a name="92" href="#92">92</a> <strong class="jxr_keyword">if</strong> (ds &lt; rangeHeader.length()) {
<a name="93" href="#93">93</a> String lengthStr = rangeHeader.substring(ds + 1).trim();
<a name="94" href="#94">94</a> <strong class="jxr_keyword">if</strong> (lengthStr.length() &gt; 0) {
<a name="95" href="#95">95</a> <strong class="jxr_keyword">if</strong> (offset == <strong class="jxr_keyword">null</strong>) {
<a name="96" href="#96">96</a> length = <strong class="jxr_keyword">new</strong> BigInteger(lengthStr);
<a name="97" href="#97">97</a> } <strong class="jxr_keyword">else</strong> {
<a name="98" href="#98">98</a> length = (<strong class="jxr_keyword">new</strong> BigInteger(lengthStr)).subtract(offset);
<a name="99" href="#99">99</a> }
<a name="100" href="#100">100</a> }
<a name="101" href="#101">101</a>
<a name="102" href="#102">102</a> <strong class="jxr_keyword">if</strong> (offset != <strong class="jxr_keyword">null</strong>) {
<a name="103" href="#103">103</a> context.put(CallContext.OFFSET, offset);
<a name="104" href="#104">104</a> }
<a name="105" href="#105">105</a> <strong class="jxr_keyword">if</strong> (length != <strong class="jxr_keyword">null</strong>) {
<a name="106" href="#106">106</a> context.put(CallContext.LENGTH, length);
<a name="107" href="#107">107</a> }
<a name="108" href="#108">108</a> }
<a name="109" href="#109">109</a> }
<a name="110" href="#110">110</a> }
<a name="111" href="#111">111</a>
<a name="112" href="#112">112</a> <em class="jxr_comment">// get locale</em>
<a name="113" href="#113">113</a> String acceptLanguage = request.getHeader(<span class="jxr_string">"Accept-Language"</span>);
<a name="114" href="#114">114</a> <strong class="jxr_keyword">if</strong> (acceptLanguage != <strong class="jxr_keyword">null</strong>) {
<a name="115" href="#115">115</a> String[] locale = acceptLanguage.split(<span class="jxr_string">"-"</span>);
<a name="116" href="#116">116</a> context.put(CallContext.LOCALE_ISO639_LANGUAGE, locale[0].trim());
<a name="117" href="#117">117</a> <strong class="jxr_keyword">if</strong> (locale.length &gt; 1) {
<a name="118" href="#118">118</a> <strong class="jxr_keyword">int</strong> x = locale[1].indexOf(',');
<a name="119" href="#119">119</a> <strong class="jxr_keyword">if</strong> (x == -1) {
<a name="120" href="#120">120</a> context.put(CallContext.LOCALE_ISO3166_COUNTRY, locale[1].trim());
<a name="121" href="#121">121</a> } <strong class="jxr_keyword">else</strong> {
<a name="122" href="#122">122</a> context.put(CallContext.LOCALE_ISO3166_COUNTRY, locale[1].substring(0, x).trim());
<a name="123" href="#123">123</a> }
<a name="124" href="#124">124</a> }
<a name="125" href="#125">125</a> }
<a name="126" href="#126">126</a>
<a name="127" href="#127">127</a> <strong class="jxr_keyword">return</strong> context;
<a name="128" href="#128">128</a> }
<a name="129" href="#129">129</a>
<a name="130" href="#130">130</a> <em class="jxr_javadoccomment">/**</em>
<a name="131" href="#131">131</a> <em class="jxr_javadoccomment"> * Splits the path into its fragments.</em>
<a name="132" href="#132">132</a> <em class="jxr_javadoccomment"> */</em>
<a name="133" href="#133">133</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String[] splitPath(HttpServletRequest request) {
<a name="134" href="#134">134</a> String p = request.getPathInfo();
<a name="135" href="#135">135</a> <strong class="jxr_keyword">if</strong> (p == <strong class="jxr_keyword">null</strong>) {
<a name="136" href="#136">136</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> String[0];
<a name="137" href="#137">137</a> }
<a name="138" href="#138">138</a>
<a name="139" href="#139">139</a> <strong class="jxr_keyword">return</strong> p.substring(1).split(<span class="jxr_string">"/"</span>);
<a name="140" href="#140">140</a> }
<a name="141" href="#141">141</a>
<a name="142" href="#142">142</a> <em class="jxr_comment">// -------------------------------------------------------------------------</em>
<a name="143" href="#143">143</a> <em class="jxr_comment">// --- parameters ---</em>
<a name="144" href="#144">144</a> <em class="jxr_comment">// -------------------------------------------------------------------------</em>
<a name="145" href="#145">145</a>
<a name="146" href="#146">146</a> <em class="jxr_javadoccomment">/**</em>
<a name="147" href="#147">147</a> <em class="jxr_javadoccomment"> * Extracts a string parameter.</em>
<a name="148" href="#148">148</a> <em class="jxr_javadoccomment"> */</em>
<a name="149" href="#149">149</a> @SuppressWarnings(<span class="jxr_string">"unchecked"</span>)
<a name="150" href="#150">150</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String getStringParameter(HttpServletRequest request, String name) {
<a name="151" href="#151">151</a> <strong class="jxr_keyword">if</strong> (name == <strong class="jxr_keyword">null</strong>) {
<a name="152" href="#152">152</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a name="153" href="#153">153</a> }
<a name="154" href="#154">154</a>
<a name="155" href="#155">155</a> Map&lt;String, String[]&gt; parameters = (Map&lt;String, String[]&gt;) request.getParameterMap();
<a name="156" href="#156">156</a> <strong class="jxr_keyword">for</strong> (Map.Entry&lt;String, String[]&gt; parameter : parameters.entrySet()) {
<a name="157" href="#157">157</a> <strong class="jxr_keyword">if</strong> (name.equalsIgnoreCase(parameter.getKey())) {
<a name="158" href="#158">158</a> <strong class="jxr_keyword">if</strong> (parameter.getValue() == <strong class="jxr_keyword">null</strong>) {
<a name="159" href="#159">159</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a name="160" href="#160">160</a> }
<a name="161" href="#161">161</a> <strong class="jxr_keyword">return</strong> parameter.getValue()[0];
<a name="162" href="#162">162</a> }
<a name="163" href="#163">163</a> }
<a name="164" href="#164">164</a>
<a name="165" href="#165">165</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a name="166" href="#166">166</a> }
<a name="167" href="#167">167</a>
<a name="168" href="#168">168</a> <em class="jxr_javadoccomment">/**</em>
<a name="169" href="#169">169</a> <em class="jxr_javadoccomment"> * Extracts a boolean parameter (with default).</em>
<a name="170" href="#170">170</a> <em class="jxr_javadoccomment"> */</em>
<a name="171" href="#171">171</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> getBooleanParameter(HttpServletRequest request, String name, <strong class="jxr_keyword">boolean</strong> def) {
<a name="172" href="#172">172</a> String value = getStringParameter(request, name);
<a name="173" href="#173">173</a> <strong class="jxr_keyword">if</strong> ((value == <strong class="jxr_keyword">null</strong>) || (value.length() == 0)) {
<a name="174" href="#174">174</a> <strong class="jxr_keyword">return</strong> def;
<a name="175" href="#175">175</a> }
<a name="176" href="#176">176</a>
<a name="177" href="#177">177</a> <strong class="jxr_keyword">return</strong> Boolean.valueOf(value);
<a name="178" href="#178">178</a> }
<a name="179" href="#179">179</a>
<a name="180" href="#180">180</a> <em class="jxr_javadoccomment">/**</em>
<a name="181" href="#181">181</a> <em class="jxr_javadoccomment"> * Extracts a boolean parameter.</em>
<a name="182" href="#182">182</a> <em class="jxr_javadoccomment"> */</em>
<a name="183" href="#183">183</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> Boolean getBooleanParameter(HttpServletRequest request, String name) {
<a name="184" href="#184">184</a> String value = getStringParameter(request, name);
<a name="185" href="#185">185</a> <strong class="jxr_keyword">if</strong> ((value == <strong class="jxr_keyword">null</strong>) || (value.length() == 0)) {
<a name="186" href="#186">186</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a name="187" href="#187">187</a> }
<a name="188" href="#188">188</a>
<a name="189" href="#189">189</a> <strong class="jxr_keyword">return</strong> Boolean.valueOf(value);
<a name="190" href="#190">190</a> }
<a name="191" href="#191">191</a>
<a name="192" href="#192">192</a> <em class="jxr_javadoccomment">/**</em>
<a name="193" href="#193">193</a> <em class="jxr_javadoccomment"> * Extracts an integer parameter (with default).</em>
<a name="194" href="#194">194</a> <em class="jxr_javadoccomment"> */</em>
<a name="195" href="#195">195</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> BigInteger getBigIntegerParameter(HttpServletRequest request, String name, <strong class="jxr_keyword">long</strong> def) {
<a name="196" href="#196">196</a> BigInteger result = getBigIntegerParameter(request, name);
<a name="197" href="#197">197</a> <strong class="jxr_keyword">if</strong> (result == <strong class="jxr_keyword">null</strong>) {
<a name="198" href="#198">198</a> result = BigInteger.valueOf(def);
<a name="199" href="#199">199</a> }
<a name="200" href="#200">200</a>
<a name="201" href="#201">201</a> <strong class="jxr_keyword">return</strong> result;
<a name="202" href="#202">202</a> }
<a name="203" href="#203">203</a>
<a name="204" href="#204">204</a> <em class="jxr_javadoccomment">/**</em>
<a name="205" href="#205">205</a> <em class="jxr_javadoccomment"> * Extracts an integer parameter.</em>
<a name="206" href="#206">206</a> <em class="jxr_javadoccomment"> */</em>
<a name="207" href="#207">207</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> BigInteger getBigIntegerParameter(HttpServletRequest request, String name) {
<a name="208" href="#208">208</a> String value = getStringParameter(request, name);
<a name="209" href="#209">209</a> <strong class="jxr_keyword">if</strong> ((value == <strong class="jxr_keyword">null</strong>) || (value.length() == 0)) {
<a name="210" href="#210">210</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a name="211" href="#211">211</a> }
<a name="212" href="#212">212</a>
<a name="213" href="#213">213</a> <strong class="jxr_keyword">try</strong> {
<a name="214" href="#214">214</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> BigInteger(value);
<a name="215" href="#215">215</a> } <strong class="jxr_keyword">catch</strong> (Exception e) {
<a name="216" href="#216">216</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> CmisInvalidArgumentException(<span class="jxr_string">"Invalid parameter '"</span> + name + <span class="jxr_string">"'!"</span>);
<a name="217" href="#217">217</a> }
<a name="218" href="#218">218</a> }
<a name="219" href="#219">219</a>
<a name="220" href="#220">220</a> <em class="jxr_javadoccomment">/**</em>
<a name="221" href="#221">221</a> <em class="jxr_javadoccomment"> * Extracts an enum parameter.</em>
<a name="222" href="#222">222</a> <em class="jxr_javadoccomment"> */</em>
<a name="223" href="#223">223</a> @SuppressWarnings(<span class="jxr_string">"unchecked"</span>)
<a name="224" href="#224">224</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> &lt;T&gt; T getEnumParameter(HttpServletRequest request, String name, Class&lt;T&gt; clazz) {
<a name="225" href="#225">225</a> String value = getStringParameter(request, name);
<a name="226" href="#226">226</a> <strong class="jxr_keyword">if</strong> ((value == <strong class="jxr_keyword">null</strong>) || (value.length() == 0)) {
<a name="227" href="#227">227</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a name="228" href="#228">228</a> }
<a name="229" href="#229">229</a>
<a name="230" href="#230">230</a> <strong class="jxr_keyword">try</strong> {
<a name="231" href="#231">231</a> Method m = clazz.getMethod(<span class="jxr_string">"fromValue"</span>, <strong class="jxr_keyword">new</strong> Class[] { String.<strong class="jxr_keyword">class</strong> });
<a name="232" href="#232">232</a> <strong class="jxr_keyword">return</strong> (T) m.invoke(<strong class="jxr_keyword">null</strong>, <strong class="jxr_keyword">new</strong> Object[] { value });
<a name="233" href="#233">233</a> } <strong class="jxr_keyword">catch</strong> (Exception e) {
<a name="234" href="#234">234</a> <strong class="jxr_keyword">if</strong> (e instanceof IllegalArgumentException) {
<a name="235" href="#235">235</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> CmisInvalidArgumentException(<span class="jxr_string">"Invalid parameter '"</span> + name + <span class="jxr_string">"'!"</span>);
<a name="236" href="#236">236</a> }
<a name="237" href="#237">237</a>
<a name="238" href="#238">238</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> CmisRuntimeException(e.getMessage(), e);
<a name="239" href="#239">239</a> }
<a name="240" href="#240">240</a> }
<a name="241" href="#241">241</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>