org.wso2.carbon.apimgt.samples.utils

Class ThrottlingUtils

java.lang.Object

org.wso2.carbon.apimgt.samples.utils.ThrottlingUtils

public class ThrottlingUtils
extends Object

Constructor Summary

Constructors

Constructor and Description
ThrottlingUtils()

Method Summary

Modifier and Type	Method and Description
static String	addAdvanceThrottlePolicy(String displayName, String policyName, String description, String timeUnit, Integer unitTime, long requestCount, ThrottleLimit.TypeEnum typeEnum, long dataAmount, String dataUnit) This method is used to add advanceThrottlingPolicies
static String	addAdvanceThrottlePolicyForTenants(String displayName, String policyName, String description, String timeUnit, Integer unitTime, long requestCount, ThrottleLimit.TypeEnum typeEnum, long dataAmount, String dataUnit, String tenantDomain, String adminUsername, String adminPassword) This method is used to add advanceThrottlingPolicies for tenants.
static String	addAdvanceThrottlePolicyWithConditionalGroups(String displayName, String policyName, String description, String timeUnit, Integer unitTime, long requestCount, ThrottleLimit.TypeEnum typeEnum, long dataAmount, String dataUnit, String startingIP, String endingIP, String headerName, String headerValue, boolean invertHeaderCondition, String conditionalGroupDescription) This method is used to add advanceThrottlingPolicies with Conditional Groups.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ThrottlingUtils

public ThrottlingUtils()

Method Detail

addAdvanceThrottlePolicy

public static String addAdvanceThrottlePolicy(String displayName,
                                              String policyName,
                                              String description,
                                              String timeUnit,
                                              Integer unitTime,
                                              long requestCount,
                                              ThrottleLimit.TypeEnum typeEnum,
                                              long dataAmount,
                                              String dataUnit)
                                       throws ApiException

This method is used to add advanceThrottlingPolicies

Parameters:

displayName - policy display name

policyName - policy name

description - policy description

timeUnit - time unit

unitTime - unit time

requestCount - request count per unit time

typeEnum - throttling type

dataAmount - bandwidth amount

dataUnit - bandwidth unit

Returns:

created throttle policy Id.

Throws:

ApiException - Throws is an error occurs when creating a advance throttle policy.

addAdvanceThrottlePolicyForTenants

public static String addAdvanceThrottlePolicyForTenants(String displayName,
                                                        String policyName,
                                                        String description,
                                                        String timeUnit,
                                                        Integer unitTime,
                                                        long requestCount,
                                                        ThrottleLimit.TypeEnum typeEnum,
                                                        long dataAmount,
                                                        String dataUnit,
                                                        String tenantDomain,
                                                        String adminUsername,
                                                        String adminPassword)
                                                 throws ApiException

This method is used to add advanceThrottlingPolicies for tenants.

Parameters:

displayName - policy display name

policyName - policy name

description - policy description

timeUnit - time unit

unitTime - unit time

requestCount - request count per unit time

typeEnum - throttling type

dataAmount - bandwidth amount

dataUnit - bandwidth unit

tenantDomain - tenant domain

adminUsername - tenant admin username

adminPassword - tenant admin password

Returns:

created throttle policy Id.

Throws:

ApiException - Throws is an error occurs when creating a advance throttle policy.

addAdvanceThrottlePolicyWithConditionalGroups

public static String addAdvanceThrottlePolicyWithConditionalGroups(String displayName,
                                                                   String policyName,
                                                                   String description,
                                                                   String timeUnit,
                                                                   Integer unitTime,
                                                                   long requestCount,
                                                                   ThrottleLimit.TypeEnum typeEnum,
                                                                   long dataAmount,
                                                                   String dataUnit,
                                                                   String startingIP,
                                                                   String endingIP,
                                                                   String headerName,
                                                                   String headerValue,
                                                                   boolean invertHeaderCondition,
                                                                   String conditionalGroupDescription)
                                                            throws ApiException

This method is used to add advanceThrottlingPolicies with Conditional Groups.

Parameters:

displayName - policy display name

policyName - policy name

description - policy description

timeUnit - time unit

unitTime - unit time

requestCount - request count per unit time

typeEnum - throttling type

dataAmount - bandwidth amount

dataUnit - bandwidth unit

startingIP - starting ip address of allowed ip range

endingIP - ending ip address of allowed ip range

headerName - header name

headerValue - heder value

invertHeaderCondition - blocking the header name for the above value or not.

Returns:

created throttle policy Id.

Throws:

ApiException - Throws is an error occurs when creating a advance throttle policy.