| <?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 371</title> |
| </properties> |
| <body> |
| <section name="Sample 371: Restricting Requests Based on Policies"> |
| <div class="xmlConf"><definitions xmlns="http://ws.apache.org/ns/synapse"> |
| |
| <sequence name="main"> |
| <in> |
| <throttle id="A"> |
| <policy> |
| <!-- define throttle policy --> |
| <wsp:Policy xmlns:wsp="http://schemas.xmlsoap.org/ws/2004/09/policy" |
| xmlns:throttle="http://www.wso2.org/products/wso2commons/throttle"> |
| <throttle:ThrottleAssertion> |
| <wsp:All> |
| <throttle:ID throttle:type="IP">other</throttle:ID> |
| <wsp:ExactlyOne> |
| <wsp:All> |
| <throttle:MaximumCount>4</throttle:MaximumCount> |
| <throttle:UnitTime>800000</throttle:UnitTime> |
| <throttle:ProhibitTimePeriod wsp:Optional="true">10000 |
| </throttle:ProhibitTimePeriod> |
| </wsp:All> |
| <throttle:IsAllow>true</throttle:IsAllow> |
| </wsp:ExactlyOne> |
| </wsp:All> |
| <wsp:All> |
| <throttle:ID throttle:type="IP">192.168.8.200-192.168.8.222 |
| </throttle:ID> |
| <wsp:ExactlyOne> |
| <wsp:All> |
| <throttle:MaximumCount>8</throttle:MaximumCount> |
| <throttle:UnitTime>800000</throttle:UnitTime> |
| <throttle:ProhibitTimePeriod wsp:Optional="true">10 |
| </throttle:ProhibitTimePeriod> |
| </wsp:All> |
| <throttle:IsAllow>true</throttle:IsAllow> |
| </wsp:ExactlyOne> |
| </wsp:All> |
| <wsp:All> |
| <throttle:ID throttle:type="IP">192.168.8.201</throttle:ID> |
| <wsp:ExactlyOne> |
| <wsp:All> |
| <throttle:MaximumCount>200</throttle:MaximumCount> |
| <throttle:UnitTime>600000</throttle:UnitTime> |
| <throttle:ProhibitTimePeriod wsp:Optional="true"/> |
| </wsp:All> |
| <throttle:IsAllow>true</throttle:IsAllow> |
| </wsp:ExactlyOne> |
| </wsp:All> |
| <wsp:All> |
| <throttle:ID throttle:type="IP">192.168.8.198</throttle:ID> |
| <wsp:ExactlyOne> |
| <wsp:All> |
| <throttle:MaximumCount>50</throttle:MaximumCount> |
| <throttle:UnitTime>500000</throttle:UnitTime> |
| <throttle:ProhibitTimePeriod wsp:Optional="true"/> |
| </wsp:All> |
| <throttle:IsAllow>true</throttle:IsAllow> |
| </wsp:ExactlyOne> |
| </wsp:All> |
| </throttle:ThrottleAssertion> |
| </wsp:Policy> |
| </policy> |
| <onAccept> |
| <log level="custom"> |
| <property name="text" value="**Access Accept**"/> |
| </log> |
| <send> |
| <endpoint> |
| <address uri="http://localhost:9000/services/SimpleStockQuoteService"/> |
| </endpoint> |
| </send> |
| </onAccept> |
| <onReject> |
| <log level="custom"> |
| <property name="text" value="**Access Denied**"/> |
| </log> |
| <makefault response="true"> |
| <code xmlns:tns="http://www.w3.org/2003/05/soap-envelope" |
| value="tns:Receiver"/> |
| <reason value="**Access Denied**"/> |
| </makefault> |
| <send/> |
| <drop/> |
| </onReject> |
| </throttle> |
| </in> |
| <out> |
| <throttle id="A"/> |
| <send/> |
| </out> |
| </sequence> |
| |
| </definitions></div> |
| <subsection name="Objective"> |
| <p> |
| Demonstrate how to throttle incoming requests based on complex policies |
| </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 371 (repository/conf/sample/synapse_sample_371.xml) |
| <div class="command"> |
| Unix/Linux: sh synapse.sh -sample 371<br/> |
| Windows: synapse.bat -sample 371 |
| </div> |
| </li> |
| </ul> |
| </p> |
| </subsection> |
| <subsection name="Executing the Client"> |
| <p> |
| Above configuration specifies a throttle mediator inside the in mediator. |
| Therefore, all request messages directed to the main sequence will be subjected |
| to throttling. Throttle mediator has policy, onAccept and onReject tags at the |
| top level. Policy tag specifies the throttling policy against which all messages |
| will be evaluated. It contains some IP address ranges and the maximum number of |
| messages to be allowed for those ranges within a time period given in 'UnitTime' |
| tag. 'ProhibitTimePeriod' tag specifies the time period to prohibit further |
| requests after the received request count exceeds the specified time. Now run the |
| client 5 times repetitively using the following command to see how throttling works. |
| </p> |
| <div class="command">ant stockquote -Dsymbol=IBM -Dmode=quote -Daddurl=http://localhost:8280/</div> |
| <p> |
| For the first four requests you will get the quote prices for IBM as follows. |
| </p> |
| <div class="consoleOutput">[java] Standard :: Stock price = $177.20143371883802</div> |
| <p> |
| Fifth request will not be sent to the Axis2 server and the client will receive |
| the following fault. |
| </p> |
| <div class="consoleOutput">[java] org.apache.axis2.AxisFault: **Access Denied**</div> |
| <p> |
| Maximum number of requests within 800000 milliseconds is specified as 4 for any |
| server (including localhost) other than the explicitly specified ones. Therefore, |
| our fifth request is denied by the throttle mediator. You can verify this by looking |
| at the Synapse console. |
| </p> |
| <div class="consoleOutput">[HttpServerWorker-1] INFO LogMediator - text = **Access Accept** |
| [HttpServerWorker-2] INFO LogMediator - text = **Access Accept** |
| [HttpServerWorker-3] INFO LogMediator - text = **Access Accept** |
| [HttpServerWorker-4] INFO LogMediator - text = **Access Accept** |
| [HttpServerWorker-5] INFO LogMediator - text = **Access Denied**</div> |
| </subsection> |
| </section> |
| <p><a href="../samples.html">Back to Catalog</a></p> |
| </body> |
| </document> |