blob: 8dee04c50f8bd6d892aba88675ff8e53a032dfb6 [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>UrlBuilder 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.commons.impl;
<a name="20" href="#20">20</a>
<a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> java.io.UnsupportedEncodingException;
<a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.net.URI;
<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.net.URLEncoder;
<a name="24" href="#24">24</a>
<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.chemistry.opencmis.commons.enums.AclPropagation;
<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.chemistry.opencmis.commons.enums.IncludeRelationships;
<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.chemistry.opencmis.commons.enums.RelationshipDirection;
<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.apache.chemistry.opencmis.commons.enums.UnfileObject;
<a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.apache.chemistry.opencmis.commons.enums.VersioningState;
<a name="30" href="#30">30</a>
<a name="31" href="#31">31</a> <em class="jxr_javadoccomment">/**</em>
<a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * Utility class that helps building URLs.</em>
<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> */</em>
<a name="34" href="#34">34</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/chemistry/opencmis/commons/impl/UrlBuilder.html">UrlBuilder</a> {
<a name="35" href="#35">35</a>
<a name="36" href="#36">36</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> StringBuilder urlPart;
<a name="37" href="#37">37</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> StringBuilder queryPart;
<a name="38" href="#38">38</a>
<a name="39" href="#39">39</a> <em class="jxr_javadoccomment">/**</em>
<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * Constructor.</em>
<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * </em>
<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * @param url</em>
<a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * initial URL</em>
<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> */</em>
<a name="45" href="#45">45</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/chemistry/opencmis/commons/impl/UrlBuilder.html">UrlBuilder</a>(String url) {
<a name="46" href="#46">46</a> <strong class="jxr_keyword">if</strong> (url == <strong class="jxr_keyword">null</strong>) {
<a name="47" href="#47">47</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"URL must be set"</span>);
<a name="48" href="#48">48</a> }
<a name="49" href="#49">49</a>
<a name="50" href="#50">50</a> urlPart = <strong class="jxr_keyword">new</strong> StringBuilder();
<a name="51" href="#51">51</a> queryPart = <strong class="jxr_keyword">new</strong> StringBuilder();
<a name="52" href="#52">52</a>
<a name="53" href="#53">53</a> <strong class="jxr_keyword">int</strong> qm = url.indexOf('?');
<a name="54" href="#54">54</a> <strong class="jxr_keyword">if</strong> (qm == -1) {
<a name="55" href="#55">55</a> urlPart.append(url);
<a name="56" href="#56">56</a> } <strong class="jxr_keyword">else</strong> {
<a name="57" href="#57">57</a> urlPart.append(url.substring(0, qm));
<a name="58" href="#58">58</a> <strong class="jxr_keyword">if</strong> (qm &lt; url.length()) {
<a name="59" href="#59">59</a> queryPart.append(url.substring(qm + 1));
<a name="60" href="#60">60</a> }
<a name="61" href="#61">61</a> }
<a name="62" href="#62">62</a> }
<a name="63" href="#63">63</a>
<a name="64" href="#64">64</a> <em class="jxr_javadoccomment">/**</em>
<a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * Constructor.</em>
<a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * </em>
<a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * @param scheme</em>
<a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * scheme</em>
<a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * @param host</em>
<a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * host</em>
<a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * @param port</em>
<a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * port</em>
<a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * @param path</em>
<a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * path</em>
<a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> */</em>
<a name="76" href="#76">76</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/chemistry/opencmis/commons/impl/UrlBuilder.html">UrlBuilder</a>(String scheme, String host, <strong class="jxr_keyword">int</strong> port, String path) {
<a name="77" href="#77">77</a>
<a name="78" href="#78">78</a> <strong class="jxr_keyword">if</strong> (<span class="jxr_string">"http"</span>.equalsIgnoreCase(scheme) &amp;&amp; (port == 80)) {
<a name="79" href="#79">79</a> port = -1;
<a name="80" href="#80">80</a> }
<a name="81" href="#81">81</a> <strong class="jxr_keyword">if</strong> (<span class="jxr_string">"https"</span>.equalsIgnoreCase(scheme) &amp;&amp; (port == 443)) {
<a name="82" href="#82">82</a> port = -1;
<a name="83" href="#83">83</a> }
<a name="84" href="#84">84</a>
<a name="85" href="#85">85</a> urlPart = <strong class="jxr_keyword">new</strong> StringBuilder();
<a name="86" href="#86">86</a> queryPart = <strong class="jxr_keyword">new</strong> StringBuilder();
<a name="87" href="#87">87</a>
<a name="88" href="#88">88</a> urlPart.append(scheme);
<a name="89" href="#89">89</a> urlPart.append(<span class="jxr_string">"://"</span>);
<a name="90" href="#90">90</a> urlPart.append(host);
<a name="91" href="#91">91</a> <strong class="jxr_keyword">if</strong> (port &gt; 0) {
<a name="92" href="#92">92</a> urlPart.append(<span class="jxr_string">":"</span>).append(port);
<a name="93" href="#93">93</a> }
<a name="94" href="#94">94</a> <strong class="jxr_keyword">if</strong> (path != <strong class="jxr_keyword">null</strong>) {
<a name="95" href="#95">95</a> urlPart.append(path);
<a name="96" href="#96">96</a> }
<a name="97" href="#97">97</a> }
<a name="98" href="#98">98</a>
<a name="99" href="#99">99</a> <em class="jxr_javadoccomment">/**</em>
<a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> * Copy constructor.</em>
<a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> */</em>
<a name="102" href="#102">102</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/chemistry/opencmis/commons/impl/UrlBuilder.html">UrlBuilder</a>(<a href="../../../../../../org/apache/chemistry/opencmis/commons/impl/UrlBuilder.html">UrlBuilder</a> urlBuilder) {
<a name="103" href="#103">103</a> urlPart = <strong class="jxr_keyword">new</strong> StringBuilder(urlBuilder.urlPart);
<a name="104" href="#104">104</a> queryPart = <strong class="jxr_keyword">new</strong> StringBuilder(urlBuilder.queryPart);
<a name="105" href="#105">105</a> }
<a name="106" href="#106">106</a>
<a name="107" href="#107">107</a> <em class="jxr_javadoccomment">/**</em>
<a name="108" href="#108">108</a> <em class="jxr_javadoccomment"> * Adds a parameter to the URL.</em>
<a name="109" href="#109">109</a> <em class="jxr_javadoccomment"> * </em>
<a name="110" href="#110">110</a> <em class="jxr_javadoccomment"> * @param name</em>
<a name="111" href="#111">111</a> <em class="jxr_javadoccomment"> * parameter name</em>
<a name="112" href="#112">112</a> <em class="jxr_javadoccomment"> * @param value</em>
<a name="113" href="#113">113</a> <em class="jxr_javadoccomment"> * parameter value</em>
<a name="114" href="#114">114</a> <em class="jxr_javadoccomment"> */</em>
<a name="115" href="#115">115</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/chemistry/opencmis/commons/impl/UrlBuilder.html">UrlBuilder</a> addParameter(String name, Object value) {
<a name="116" href="#116">116</a> <strong class="jxr_keyword">if</strong> ((name == <strong class="jxr_keyword">null</strong>) || (value == <strong class="jxr_keyword">null</strong>)) {
<a name="117" href="#117">117</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
<a name="118" href="#118">118</a> }
<a name="119" href="#119">119</a>
<a name="120" href="#120">120</a> String valueStr = normalizeParameter(value);
<a name="121" href="#121">121</a>
<a name="122" href="#122">122</a> <strong class="jxr_keyword">if</strong> (queryPart.length() &gt; 0) {
<a name="123" href="#123">123</a> queryPart.append('&amp;');
<a name="124" href="#124">124</a> }
<a name="125" href="#125">125</a> queryPart.append(name);
<a name="126" href="#126">126</a> queryPart.append('=');
<a name="127" href="#127">127</a> <strong class="jxr_keyword">try</strong> {
<a name="128" href="#128">128</a> queryPart.append(URLEncoder.encode(valueStr, <span class="jxr_string">"UTF-8"</span>));
<a name="129" href="#129">129</a> } <strong class="jxr_keyword">catch</strong> (UnsupportedEncodingException e) {
<a name="130" href="#130">130</a> }
<a name="131" href="#131">131</a>
<a name="132" href="#132">132</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
<a name="133" href="#133">133</a> }
<a name="134" href="#134">134</a>
<a name="135" href="#135">135</a> <em class="jxr_javadoccomment">/**</em>
<a name="136" href="#136">136</a> <em class="jxr_javadoccomment"> * Adds a path segment to the URL.</em>
<a name="137" href="#137">137</a> <em class="jxr_javadoccomment"> * </em>
<a name="138" href="#138">138</a> <em class="jxr_javadoccomment"> * @param pathSegment</em>
<a name="139" href="#139">139</a> <em class="jxr_javadoccomment"> * the path segment.</em>
<a name="140" href="#140">140</a> <em class="jxr_javadoccomment"> */</em>
<a name="141" href="#141">141</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/chemistry/opencmis/commons/impl/UrlBuilder.html">UrlBuilder</a> addPathSegment(String pathSegment) {
<a name="142" href="#142">142</a> <strong class="jxr_keyword">return</strong> addPathPart(pathSegment, <strong class="jxr_keyword">true</strong>);
<a name="143" href="#143">143</a> }
<a name="144" href="#144">144</a>
<a name="145" href="#145">145</a> <em class="jxr_javadoccomment">/**</em>
<a name="146" href="#146">146</a> <em class="jxr_javadoccomment"> * Adds a path to the URL.</em>
<a name="147" href="#147">147</a> <em class="jxr_javadoccomment"> * </em>
<a name="148" href="#148">148</a> <em class="jxr_javadoccomment"> * @param path</em>
<a name="149" href="#149">149</a> <em class="jxr_javadoccomment"> * the path</em>
<a name="150" href="#150">150</a> <em class="jxr_javadoccomment"> */</em>
<a name="151" href="#151">151</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/chemistry/opencmis/commons/impl/UrlBuilder.html">UrlBuilder</a> addPath(String path) {
<a name="152" href="#152">152</a> <strong class="jxr_keyword">return</strong> addPathPart(path, false);
<a name="153" href="#153">153</a> }
<a name="154" href="#154">154</a>
<a name="155" href="#155">155</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../../org/apache/chemistry/opencmis/commons/impl/UrlBuilder.html">UrlBuilder</a> addPathPart(String part, <strong class="jxr_keyword">boolean</strong> quoteSlash) {
<a name="156" href="#156">156</a> <strong class="jxr_keyword">if</strong> (part == <strong class="jxr_keyword">null</strong> || part.length() == 0) {
<a name="157" href="#157">157</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
<a name="158" href="#158">158</a> }
<a name="159" href="#159">159</a> <strong class="jxr_keyword">if</strong> (urlPart.charAt(urlPart.length() - 1) != '/') {
<a name="160" href="#160">160</a> urlPart.append('/');
<a name="161" href="#161">161</a> }
<a name="162" href="#162">162</a> <strong class="jxr_keyword">if</strong> (part.charAt(0) == '/') {
<a name="163" href="#163">163</a> part = part.substring(1);
<a name="164" href="#164">164</a> }
<a name="165" href="#165">165</a> urlPart.append(quoteURIPathComponent(part, quoteSlash));
<a name="166" href="#166">166</a>
<a name="167" href="#167">167</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>;
<a name="168" href="#168">168</a> }
<a name="169" href="#169">169</a>
<a name="170" href="#170">170</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">char</strong>[] RFC7232_RESERVED = <span class="jxr_string">";?:@&amp;=+$,[]"</span>.toCharArray();
<a name="171" href="#171">171</a>
<a name="172" href="#172">172</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String quoteURIPathComponent(String s, <strong class="jxr_keyword">boolean</strong> quoteSlash) {
<a name="173" href="#173">173</a> <strong class="jxr_keyword">if</strong> (s.length() == 0) {
<a name="174" href="#174">174</a> <strong class="jxr_keyword">return</strong> s;
<a name="175" href="#175">175</a> }
<a name="176" href="#176">176</a> <em class="jxr_comment">// reuse the URI class which knows a lot about escaping</em>
<a name="177" href="#177">177</a> URI uri;
<a name="178" href="#178">178</a> <strong class="jxr_keyword">try</strong> {
<a name="179" href="#179">179</a> <em class="jxr_comment">// fake scheme so that a colon is not mistaken as a scheme</em>
<a name="180" href="#180">180</a> uri = <strong class="jxr_keyword">new</strong> URI(<span class="jxr_string">"x"</span>, s, <strong class="jxr_keyword">null</strong>);
<a name="181" href="#181">181</a> } <strong class="jxr_keyword">catch</strong> (Exception e) {
<a name="182" href="#182">182</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"Illegal characters in: "</span> + s, e);
<a name="183" href="#183">183</a> }
<a name="184" href="#184">184</a> String r = uri.toASCIIString().substring(2); <em class="jxr_comment">// remove x:</em>
<a name="185" href="#185">185</a> <em class="jxr_comment">// quote some additional reserved characters to be safe</em>
<a name="186" href="#186">186</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">char</strong> c : RFC7232_RESERVED) {
<a name="187" href="#187">187</a> <strong class="jxr_keyword">if</strong> (r.indexOf(c) &gt;= 0) {
<a name="188" href="#188">188</a> r = r.replace(<span class="jxr_string">""</span> + c, <span class="jxr_string">"%"</span> + Integer.toHexString(c));
<a name="189" href="#189">189</a> }
<a name="190" href="#190">190</a> }
<a name="191" href="#191">191</a> <strong class="jxr_keyword">if</strong> (quoteSlash &amp;&amp; r.indexOf('/') &gt;= 0) {
<a name="192" href="#192">192</a> r = r.replace(<span class="jxr_string">"/"</span>, <span class="jxr_string">"%2F"</span>);
<a name="193" href="#193">193</a> }
<a name="194" href="#194">194</a> <strong class="jxr_keyword">return</strong> r;
<a name="195" href="#195">195</a> }
<a name="196" href="#196">196</a>
<a name="197" href="#197">197</a> <em class="jxr_javadoccomment">/**</em>
<a name="198" href="#198">198</a> <em class="jxr_javadoccomment"> * Converts an object to a String that can be used as a parameter value.</em>
<a name="199" href="#199">199</a> <em class="jxr_javadoccomment"> */</em>
<a name="200" href="#200">200</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String normalizeParameter(Object value) {
<a name="201" href="#201">201</a> <strong class="jxr_keyword">if</strong> (value == <strong class="jxr_keyword">null</strong>) {
<a name="202" href="#202">202</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a name="203" href="#203">203</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (value instanceof IncludeRelationships) {
<a name="204" href="#204">204</a> <strong class="jxr_keyword">return</strong> ((IncludeRelationships) value).value();
<a name="205" href="#205">205</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (value instanceof VersioningState) {
<a name="206" href="#206">206</a> <strong class="jxr_keyword">return</strong> ((VersioningState) value).value();
<a name="207" href="#207">207</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (value instanceof UnfileObject) {
<a name="208" href="#208">208</a> <strong class="jxr_keyword">return</strong> ((UnfileObject) value).value();
<a name="209" href="#209">209</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (value instanceof RelationshipDirection) {
<a name="210" href="#210">210</a> <strong class="jxr_keyword">return</strong> ((RelationshipDirection) value).value();
<a name="211" href="#211">211</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (value instanceof ReturnVersion) {
<a name="212" href="#212">212</a> <strong class="jxr_keyword">return</strong> ((ReturnVersion) value).value();
<a name="213" href="#213">213</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (value instanceof AclPropagation) {
<a name="214" href="#214">214</a> <strong class="jxr_keyword">return</strong> ((AclPropagation) value).value();
<a name="215" href="#215">215</a> }
<a name="216" href="#216">216</a>
<a name="217" href="#217">217</a> <strong class="jxr_keyword">return</strong> value.toString();
<a name="218" href="#218">218</a> }
<a name="219" href="#219">219</a>
<a name="220" href="#220">220</a> @Override
<a name="221" href="#221">221</a> <strong class="jxr_keyword">public</strong> String toString() {
<a name="222" href="#222">222</a> <strong class="jxr_keyword">return</strong> urlPart.toString() + (queryPart.length() == 0 ? <span class="jxr_string">""</span> : <span class="jxr_string">"?"</span> + queryPart.toString());
<a name="223" href="#223">223</a> }
<a name="224" href="#224">224</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>