blob: aad9260094b1017bb0e231fc6d5de8f684ff8517 [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=UTF-8" />
<title>DelayingHttpInvoker xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../../../apidocs/org/apache/chemistry/opencmis/client/bindings/spi/http/DelayingHttpInvoker.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="1" href="#1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a class="jxr_linenumber" name="3" href="#3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
<a class="jxr_linenumber" name="4" href="#4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
<a class="jxr_linenumber" name="5" href="#5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
<a class="jxr_linenumber" name="6" href="#6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
<a class="jxr_linenumber" name="7" href="#7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
<a class="jxr_linenumber" name="8" href="#8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="9" href="#9">9</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" 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 class="jxr_linenumber" name="11" href="#11">11</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="12" href="#12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
<a class="jxr_linenumber" name="13" href="#13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
<a class="jxr_linenumber" name="14" href="#14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a class="jxr_linenumber" name="15" href="#15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
<a class="jxr_linenumber" name="16" href="#16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
<a class="jxr_linenumber" name="17" href="#17">17</a> <em class="jxr_comment"> * under the License.</em>
<a class="jxr_linenumber" name="18" href="#18">18</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="19" href="#19">19</a> <strong class="jxr_keyword">package</strong> org.apache.chemistry.opencmis.client.bindings.spi.http;
<a class="jxr_linenumber" name="20" href="#20">20</a>
<a class="jxr_linenumber" name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> java.math.BigInteger;
<a class="jxr_linenumber" name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.util.Map;
<a class="jxr_linenumber" name="23" href="#23">23</a>
<a class="jxr_linenumber" name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.chemistry.opencmis.client.bindings.spi.BindingSession;
<a class="jxr_linenumber" name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.chemistry.opencmis.commons.exceptions.CmisBaseException;
<a class="jxr_linenumber" name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.chemistry.opencmis.commons.exceptions.CmisRuntimeException;
<a class="jxr_linenumber" name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.chemistry.opencmis.commons.impl.ClassLoaderUtil;
<a class="jxr_linenumber" name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.apache.chemistry.opencmis.commons.impl.UrlBuilder;
<a class="jxr_linenumber" name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger;
<a class="jxr_linenumber" name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory;
<a class="jxr_linenumber" name="31" href="#31">31</a>
<a class="jxr_linenumber" name="32" href="#32">32</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * A HTTP Invoker that delays HTTP requests and thereby throttles the client.</em>
<a class="jxr_linenumber" name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * </em>
<a class="jxr_linenumber" name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * This HTTP Invoker is only a wrapper that delegates the work to another HTTP</em>
<a class="jxr_linenumber" name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * Invoker, which is defined with the session parameter</em>
<a class="jxr_linenumber" name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * {@link DELEGTAE_HTTP_INVOKER_CLASS}.</em>
<a class="jxr_linenumber" name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * </em>
<a class="jxr_linenumber" name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * The session parameter {@link DELAY_TIME} defines the delay in milliseconds.</em>
<a class="jxr_linenumber" name="40" href="#40">40</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="41" href="#41">41</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../../../org/apache/chemistry/opencmis/client/bindings/spi/http/DelayingHttpInvoker.html">DelayingHttpInvoker</a> <strong class="jxr_keyword">implements</strong> <a href="../../../../../../../../org/apache/chemistry/opencmis/client/bindings/spi/http/HttpInvoker.html">HttpInvoker</a> {
<a class="jxr_linenumber" name="42" href="#42">42</a>
<a class="jxr_linenumber" name="43" href="#43">43</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger LOG = LoggerFactory.getLogger(DelayingHttpInvoker.<strong class="jxr_keyword">class</strong>);
<a class="jxr_linenumber" name="44" href="#44">44</a>
<a class="jxr_linenumber" name="45" href="#45">45</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * Session parameter: class name of the HTTP Invoker doing the the real</em>
<a class="jxr_linenumber" name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * work. (Optional. Default is the {@link DefaultHttpInvoker}.)</em>
<a class="jxr_linenumber" name="48" href="#48">48</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="49" href="#49">49</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DELEGTAE_HTTP_INVOKER_CLASS = <span class="jxr_string">"org.apache.chemistry.opencmis.binding.httpinvoker.delay.delegate.classname"</span>;
<a class="jxr_linenumber" name="50" href="#50">50</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * Session parameter: Delay time in milliseconds. (Required.)</em>
<a class="jxr_linenumber" name="52" href="#52">52</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="53" href="#53">53</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DELAY_TIME = <span class="jxr_string">"org.apache.chemistry.opencmis.binding.httpinvoker.delay.delaytime"</span>;
<a class="jxr_linenumber" name="54" href="#54">54</a>
<a class="jxr_linenumber" name="55" href="#55">55</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DELEGTAE_HTTP_INVOKER = <span class="jxr_string">"org.apache.chemistry.opencmis.client.bindings.spi.http.limiter.httpInvoker"</span>;
<a class="jxr_linenumber" name="56" href="#56">56</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String LAST_EXECUTION = <span class="jxr_string">"org.apache.chemistry.opencmis.client.bindings.spi.http.limiter.lastExecution"</span>;
<a class="jxr_linenumber" name="57" href="#57">57</a>
<a class="jxr_linenumber" name="58" href="#58">58</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../../../org/apache/chemistry/opencmis/client/bindings/spi/http/DelayingHttpInvoker.html">DelayingHttpInvoker</a>() {
<a class="jxr_linenumber" name="59" href="#59">59</a> }
<a class="jxr_linenumber" name="60" href="#60">60</a>
<a class="jxr_linenumber" name="61" href="#61">61</a> @Override
<a class="jxr_linenumber" name="62" href="#62">62</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../../../org/apache/chemistry/opencmis/client/bindings/spi/http/Response.html">Response</a> invokeGET(<a href="../../../../../../../../org/apache/chemistry/opencmis/commons/impl/UrlBuilder.html">UrlBuilder</a> url, <a href="../../../../../../../../org/apache/chemistry/opencmis/client/bindings/spi/BindingSession.html">BindingSession</a> session) {
<a class="jxr_linenumber" name="63" href="#63">63</a> delay(session);
<a class="jxr_linenumber" name="64" href="#64">64</a> <strong class="jxr_keyword">return</strong> getHttpInvoker(session).invokeGET(url, session);
<a class="jxr_linenumber" name="65" href="#65">65</a> }
<a class="jxr_linenumber" name="66" href="#66">66</a>
<a class="jxr_linenumber" name="67" href="#67">67</a> @Override
<a class="jxr_linenumber" name="68" href="#68">68</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../../../org/apache/chemistry/opencmis/client/bindings/spi/http/Response.html">Response</a> invokeGET(<a href="../../../../../../../../org/apache/chemistry/opencmis/commons/impl/UrlBuilder.html">UrlBuilder</a> url, <a href="../../../../../../../../org/apache/chemistry/opencmis/client/bindings/spi/BindingSession.html">BindingSession</a> session, BigInteger offset, BigInteger length) {
<a class="jxr_linenumber" name="69" href="#69">69</a> delay(session);
<a class="jxr_linenumber" name="70" href="#70">70</a> <strong class="jxr_keyword">return</strong> getHttpInvoker(session).invokeGET(url, session, offset, length);
<a class="jxr_linenumber" name="71" href="#71">71</a> }
<a class="jxr_linenumber" name="72" href="#72">72</a>
<a class="jxr_linenumber" name="73" href="#73">73</a> @Override
<a class="jxr_linenumber" name="74" href="#74">74</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../../../org/apache/chemistry/opencmis/client/bindings/spi/http/Response.html">Response</a> invokePOST(<a href="../../../../../../../../org/apache/chemistry/opencmis/commons/impl/UrlBuilder.html">UrlBuilder</a> url, String contentType, <a href="../../../../../../../../org/apache/chemistry/opencmis/client/bindings/spi/http/Output.html">Output</a> writer, <a href="../../../../../../../../org/apache/chemistry/opencmis/client/bindings/spi/BindingSession.html">BindingSession</a> session) {
<a class="jxr_linenumber" name="75" href="#75">75</a> delay(session);
<a class="jxr_linenumber" name="76" href="#76">76</a> <strong class="jxr_keyword">return</strong> getHttpInvoker(session).invokePOST(url, contentType, writer, session);
<a class="jxr_linenumber" name="77" href="#77">77</a> }
<a class="jxr_linenumber" name="78" href="#78">78</a>
<a class="jxr_linenumber" name="79" href="#79">79</a> @Override
<a class="jxr_linenumber" name="80" href="#80">80</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../../../org/apache/chemistry/opencmis/client/bindings/spi/http/Response.html">Response</a> invokePUT(<a href="../../../../../../../../org/apache/chemistry/opencmis/commons/impl/UrlBuilder.html">UrlBuilder</a> url, String contentType, Map&lt;String, String&gt; headers, <a href="../../../../../../../../org/apache/chemistry/opencmis/client/bindings/spi/http/Output.html">Output</a> writer,
<a class="jxr_linenumber" name="81" href="#81">81</a> <a href="../../../../../../../../org/apache/chemistry/opencmis/client/bindings/spi/BindingSession.html">BindingSession</a> session) {
<a class="jxr_linenumber" name="82" href="#82">82</a> delay(session);
<a class="jxr_linenumber" name="83" href="#83">83</a> <strong class="jxr_keyword">return</strong> getHttpInvoker(session).invokePUT(url, contentType, headers, writer, session);
<a class="jxr_linenumber" name="84" href="#84">84</a> }
<a class="jxr_linenumber" name="85" href="#85">85</a>
<a class="jxr_linenumber" name="86" href="#86">86</a> @Override
<a class="jxr_linenumber" name="87" href="#87">87</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../../../org/apache/chemistry/opencmis/client/bindings/spi/http/Response.html">Response</a> invokeDELETE(<a href="../../../../../../../../org/apache/chemistry/opencmis/commons/impl/UrlBuilder.html">UrlBuilder</a> url, <a href="../../../../../../../../org/apache/chemistry/opencmis/client/bindings/spi/BindingSession.html">BindingSession</a> session) {
<a class="jxr_linenumber" name="88" href="#88">88</a> delay(session);
<a class="jxr_linenumber" name="89" href="#89">89</a> <strong class="jxr_keyword">return</strong> getHttpInvoker(session).invokeDELETE(url, session);
<a class="jxr_linenumber" name="90" href="#90">90</a> }
<a class="jxr_linenumber" name="91" href="#91">91</a>
<a class="jxr_linenumber" name="92" href="#92">92</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> delay(<a href="../../../../../../../../org/apache/chemistry/opencmis/client/bindings/spi/BindingSession.html">BindingSession</a> session) {
<a class="jxr_linenumber" name="93" href="#93">93</a> session.writeLock();
<a class="jxr_linenumber" name="94" href="#94">94</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="95" href="#95">95</a> <strong class="jxr_keyword">int</strong> delayTime = session.get(DELAY_TIME, -1);
<a class="jxr_linenumber" name="96" href="#96">96</a> <strong class="jxr_keyword">if</strong> (delayTime &lt; 0) {
<a class="jxr_linenumber" name="97" href="#97">97</a> <strong class="jxr_keyword">if</strong> (LOG.isInfoEnabled()) {
<a class="jxr_linenumber" name="98" href="#98">98</a> LOG.info(<span class="jxr_string">"No delay time configured."</span>);
<a class="jxr_linenumber" name="99" href="#99">99</a> }
<a class="jxr_linenumber" name="100" href="#100">100</a> <strong class="jxr_keyword">return</strong>;
<a class="jxr_linenumber" name="101" href="#101">101</a> }
<a class="jxr_linenumber" name="102" href="#102">102</a>
<a class="jxr_linenumber" name="103" href="#103">103</a> Object lastExcution = session.get(LAST_EXECUTION);
<a class="jxr_linenumber" name="104" href="#104">104</a> <strong class="jxr_keyword">if</strong> (lastExcution instanceof Long) {
<a class="jxr_linenumber" name="105" href="#105">105</a> <strong class="jxr_keyword">long</strong> lastExcutionLong = (Long) lastExcution;
<a class="jxr_linenumber" name="106" href="#106">106</a> <strong class="jxr_keyword">long</strong> now = System.currentTimeMillis();
<a class="jxr_linenumber" name="107" href="#107">107</a> <strong class="jxr_keyword">if</strong> (now - lastExcutionLong &lt; delayTime) {
<a class="jxr_linenumber" name="108" href="#108">108</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="109" href="#109">109</a> Thread.sleep(delayTime - (now - lastExcutionLong));
<a class="jxr_linenumber" name="110" href="#110">110</a> } <strong class="jxr_keyword">catch</strong> (InterruptedException e) {
<a class="jxr_linenumber" name="111" href="#111">111</a> <strong class="jxr_keyword">if</strong> (LOG.isDebugEnabled()) {
<a class="jxr_linenumber" name="112" href="#112">112</a> LOG.debug(<span class="jxr_string">"Interrupted sleep"</span>, e);
<a class="jxr_linenumber" name="113" href="#113">113</a> }
<a class="jxr_linenumber" name="114" href="#114">114</a> }
<a class="jxr_linenumber" name="115" href="#115">115</a> }
<a class="jxr_linenumber" name="116" href="#116">116</a> }
<a class="jxr_linenumber" name="117" href="#117">117</a>
<a class="jxr_linenumber" name="118" href="#118">118</a> session.put(LAST_EXECUTION, System.currentTimeMillis());
<a class="jxr_linenumber" name="119" href="#119">119</a>
<a class="jxr_linenumber" name="120" href="#120">120</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="121" href="#121">121</a> session.writeUnlock();
<a class="jxr_linenumber" name="122" href="#122">122</a> }
<a class="jxr_linenumber" name="123" href="#123">123</a> }
<a class="jxr_linenumber" name="124" href="#124">124</a>
<a class="jxr_linenumber" name="125" href="#125">125</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../../../../org/apache/chemistry/opencmis/client/bindings/spi/http/HttpInvoker.html">HttpInvoker</a> getHttpInvoker(<a href="../../../../../../../../org/apache/chemistry/opencmis/client/bindings/spi/BindingSession.html">BindingSession</a> session) {
<a class="jxr_linenumber" name="126" href="#126">126</a> <a href="../../../../../../../../org/apache/chemistry/opencmis/client/bindings/spi/http/HttpInvoker.html">HttpInvoker</a> invoker = (HttpInvoker) session.get(DELEGTAE_HTTP_INVOKER);
<a class="jxr_linenumber" name="127" href="#127">127</a>
<a class="jxr_linenumber" name="128" href="#128">128</a> <strong class="jxr_keyword">if</strong> (invoker != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="129" href="#129">129</a> <strong class="jxr_keyword">return</strong> invoker;
<a class="jxr_linenumber" name="130" href="#130">130</a> }
<a class="jxr_linenumber" name="131" href="#131">131</a>
<a class="jxr_linenumber" name="132" href="#132">132</a> session.writeLock();
<a class="jxr_linenumber" name="133" href="#133">133</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="134" href="#134">134</a> <em class="jxr_comment">// try again</em>
<a class="jxr_linenumber" name="135" href="#135">135</a> invoker = (HttpInvoker) session.get(DELEGTAE_HTTP_INVOKER);
<a class="jxr_linenumber" name="136" href="#136">136</a> <strong class="jxr_keyword">if</strong> (invoker != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="137" href="#137">137</a> <strong class="jxr_keyword">return</strong> invoker;
<a class="jxr_linenumber" name="138" href="#138">138</a> }
<a class="jxr_linenumber" name="139" href="#139">139</a>
<a class="jxr_linenumber" name="140" href="#140">140</a> <em class="jxr_comment">// ok, we have to create it...</em>
<a class="jxr_linenumber" name="141" href="#141">141</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="142" href="#142">142</a> String invokerName = (String) session.get(DELEGTAE_HTTP_INVOKER_CLASS);
<a class="jxr_linenumber" name="143" href="#143">143</a> <strong class="jxr_keyword">if</strong> (invokerName == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="144" href="#144">144</a> invoker = <strong class="jxr_keyword">new</strong> <a href="../../../../../../../../org/apache/chemistry/opencmis/client/bindings/spi/http/DefaultHttpInvoker.html">DefaultHttpInvoker</a>();
<a class="jxr_linenumber" name="145" href="#145">145</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="146" href="#146">146</a> invoker = (HttpInvoker) ClassLoaderUtil.loadClass(invokerName).newInstance();
<a class="jxr_linenumber" name="147" href="#147">147</a> }
<a class="jxr_linenumber" name="148" href="#148">148</a> } <strong class="jxr_keyword">catch</strong> (CmisBaseException e) {
<a class="jxr_linenumber" name="149" href="#149">149</a> <strong class="jxr_keyword">throw</strong> e;
<a class="jxr_linenumber" name="150" href="#150">150</a> } <strong class="jxr_keyword">catch</strong> (Exception e) {
<a class="jxr_linenumber" name="151" href="#151">151</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../../../org/apache/chemistry/opencmis/commons/exceptions/CmisRuntimeException.html">CmisRuntimeException</a>(<span class="jxr_string">"Delegate HTTP invoker cannot be initialized: "</span> + e.getMessage(), e);
<a class="jxr_linenumber" name="152" href="#152">152</a> }
<a class="jxr_linenumber" name="153" href="#153">153</a>
<a class="jxr_linenumber" name="154" href="#154">154</a> <em class="jxr_comment">// we have an Invoker object -&gt; put it into the session</em>
<a class="jxr_linenumber" name="155" href="#155">155</a> session.put(DELEGTAE_HTTP_INVOKER, invoker, <strong class="jxr_keyword">true</strong>);
<a class="jxr_linenumber" name="156" href="#156">156</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="157" href="#157">157</a> session.writeUnlock();
<a class="jxr_linenumber" name="158" href="#158">158</a> }
<a class="jxr_linenumber" name="159" href="#159">159</a>
<a class="jxr_linenumber" name="160" href="#160">160</a> <strong class="jxr_keyword">return</strong> invoker;
<a class="jxr_linenumber" name="161" href="#161">161</a> }
<a class="jxr_linenumber" name="162" href="#162">162</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>