Author: supun Date: Fri Jun 26 23:01:14 2009 New Revision: 40109 URL: http://wso2.org/svn/browse/wso2?view=rev&revision=40109
Log: Adding throttle mediator guide Added: trunk/esb/java/docs/xdoc/mediators/throttle.xml Added: trunk/esb/java/docs/xdoc/mediators/throttle.xml URL: http://wso2.org/svn/browse/wso2/trunk/esb/java/docs/xdoc/mediators/throttle.xml?pathrev=40109 ============================================================================== --- (empty file) +++ trunk/esb/java/docs/xdoc/mediators/throttle.xml Fri Jun 26 23:01:14 2009 @@ -0,0 +1,54 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" + "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd";> +<html xmlns="http://www.w3.org/1999/xhtml";> + <head> + <meta http-equiv="content-type" content="text/html; charset=iso-8859-1" /> + <title>WSO2 ESB - Throttle Mediator </title> + <link href="css/esb-docs.css" rel="stylesheet" /> + <link href="styles/dist-docs.css" rel="stylesheet" type="text/css" + media="all" /> + </head> + <body> + <h2>Throttle Mediator</h2> + <p> + The Throttle mediator can be used for rate limiting as well as concurrency + based limiting. A WS-Policy dictates the throttling configuration and may be + specified inline or loaded from the registry. Please refer to the samples + document for sample throttling policies. The Throttle mediator could be added + in the request path for rate limiting and concurrent access limitation. When + using for concurrent access limitation, the same throttle mediator 'id' must be + triggered on the response flow so that completed responses are deducted from + the available limit. (i.e. two instances of the throttle mediator with the same + 'id' attribute in the request and response flows). The 'onReject' and + 'onAccept' sequence references or inline sequences define how accepted and + rejected messages are to be handled. + </p> + <h3>Syntax</h3> + <pre xml:space="preserve"> + <throttle [onReject="string"] [onAccept="string"] id="string"> + (<policy key="string"/> | <policy>..</policy>) + <onReject>..</onReject>? + <onAccept>..</onAccept>? + </throttle></pre> + <h3>UI Configuration</h3> + <p> + <img src="../throttle-mediator/docs/images/throttle_mediator.jpg" alt=""/> + </p> + <ul> + <li> + Throttle Group ID: The id for the throttle group. Note you would have two throttle mediator configuration in + request and response paths with the same group id. + </li> + <li> + Referring Policy: The policy for the throttling. You can specify it inline or refer from the regsitry + </li> + <li> + On Acceptance Referring Sequence: The sequence to act on accpetance + </li> + <li> + On Rejection Referring Sequence: The sequence to act on rejection + </li> + </ul> + </body> +</html> \ No newline at end of file _______________________________________________ Esb-java-dev mailing list [email protected] https://wso2.org/cgi-bin/mailman/listinfo/esb-java-dev
