<?xml version="1.0" encoding="ISO-8859-1" ?>
<!--
  ~  Licensed to the Apache Software Foundation (ASF) under one
  ~  or more contributor license agreements.  See the NOTICE file
  ~  distributed with this work for additional information
  ~  regarding copyright ownership.  The ASF licenses this file
  ~  to you under the Apache License, Version 2.0 (the
  ~  "License"); you may not use this file except in compliance
  ~  with the License.  You may obtain a copy of the License at
  ~
  ~   http://www.apache.org/licenses/LICENSE-2.0
  ~
  ~  Unless required by applicable law or agreed to in writing,
  ~  software distributed under the License is distributed on an
  ~   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  ~  KIND, either express or implied.  See the License for the
  ~  specific language governing permissions and limitations
  ~  under the License.
  -->

<document>
    <properties>
        <title>Apache Synapse - Sample 372</title>
    </properties>
    <body>
        <section name="Sample 372: Use of Concurrency Throttling and Request Rate Based Throttling">
            <div class="xmlConf">&lt;definitions xmlns="http://ws.apache.org/ns/synapse"&gt;

    &lt;registry provider="org.apache.synapse.registry.url.SimpleURLRegistry"&gt;
        &lt;!-- the root property of the simple URL registry helps resolve a resource URL as root + key --&gt;
        &lt;parameter name="root"&gt;file:repository/&lt;/parameter&gt;
        &lt;!-- all resources loaded from the URL registry would be cached for this number of milli seconds --&gt;
        &lt;parameter name="cachableDuration"&gt;150000&lt;/parameter&gt;
    &lt;/registry&gt;

    &lt;sequence name="onAcceptSequence"&gt;
        &lt;log level="custom"&gt;
            &lt;property name="text" value="**Access Accept**"/&gt;
        &lt;/log&gt;
        &lt;send&gt;
            &lt;endpoint&gt;
                &lt;address uri="http://localhost:9000/services/SimpleStockQuoteService"/&gt;
            &lt;/endpoint&gt;
        &lt;/send&gt;
    &lt;/sequence&gt;

    &lt;sequence name="onRejectSequence" trace="enable"&gt;
        &lt;log level="custom"&gt;
            &lt;property name="text" value="**Access Denied**"/&gt;
        &lt;/log&gt;
        &lt;makefault response="true"&gt;
            &lt;code xmlns:tns="http://www.w3.org/2003/05/soap-envelope" value="tns:Receiver"/&gt;
            &lt;reason value="**Access Denied**"/&gt;
        &lt;/makefault&gt;
        &lt;send/&gt;
        &lt;drop/&gt;
    &lt;/sequence&gt;

    &lt;proxy name="StockQuoteProxy"&gt;
        &lt;target&gt;
            &lt;inSequence&gt;
                &lt;throttle onReject="onRejectSequence" onAccept="onAcceptSequence" id="A"&gt;
                    &lt;policy key="conf/sample/resources/policy/throttle_policy.xml"/&gt;
                &lt;/throttle&gt;
            &lt;/inSequence&gt;
            &lt;outSequence&gt;
                &lt;throttle id="A"/&gt;
                &lt;send/&gt;
            &lt;/outSequence&gt;
        &lt;/target&gt;
        &lt;publishWSDL uri="file:repository/conf/sample/resources/proxy/sample_proxy_1.wsdl"/&gt;
    &lt;/proxy&gt;

&lt;/definitions&gt;</div>
            <subsection name="Objective">
                <p>
                    Showcase how to use the concurrency throttling in conjunction with request rate
                    throttling
                </p>
            </subsection>
            <subsection name="Pre-requisites">
                <p>
                    <ul>
                        <li>
                            Deploy the SimpleStockQuoteService in the sample Axis2 server and start Axis2
                        </li>
                        <li>
                            Start Synapse using the configuration numbered 372 (repository/conf/sample/synapse_sample_372.xml)
                            <div class="command">
                                Unix/Linux: sh synapse.sh -sample 372<br/>
                                Windows: synapse.bat -sample 372
                            </div>
                        </li>
                    </ul>
                </p>
            </subsection>
            <subsection name="Executing the Client">
                <p>
                    This is a combination of <a href="sample370.html">sample 370</a> and
                    <a href="sample371.html">sample 371</a>. In this case the throttle policy is loaded
                    from the 'throttle_policy.xml' file which is fetched from the registry. To verify
                    the functionality, it requires running a load test. The all enabled request from
                    the concurrency throttling will be controlled by the access rate base throttling
                    according to the policy.
                </p>
                <p>
                    Run the client as follows.
                </p>
                <div class="command">ant stockquote -Daddurl=http://localhost:8280/services/StockQuoteProxy</div>
                <p>
                    You will get same results as in <a href="sample371.html">sample 371</a>. If you
                    run the load test, results will be different due to the effect of concurrency
                    throttling.
                </p>                
            </subsection>
        </section>
        <p><a href="../samples.html">Back to Catalog</a></p>        
    </body>
</document>