Class DefaultRateThrottlingPolicyHeaplet
java.lang.Object
org.forgerock.openig.heap.GenericHeaplet
org.forgerock.openig.filter.throttling.DefaultRateThrottlingPolicyHeaplet
- All Implemented Interfaces:
Heaplet
Creates and initializes a
DefaultRateThrottlingPolicy
in a heap environment.
Configuration options:
{
"type": "DefaultRateThrottlingPolicy",
"config": {
"delegateThrottlingRatePolicy" : reference or [REQUIRED - the policy that will define the
inlined declaration throttling rate to apply]
"defaultRate" { : reference [OPTIONAL - the default rate to apply if
the delegated throttling rate
policy returns no rate to apply]
"numberOfRequests" : integer [REQUIRED - The number of requests allowed
to go through this filter during
the duration window.]
"duration" : duration [REQUIRED - The time window during which the
incoming requests are counted.]
}
}
}
Example : it applies a rate of 15 requests / sec if the scripted throttling rate policy returns no rate.
{
"type": "DefaultRateThrottlingPolicy",
"config": {
"delegateThrottlingRatePolicy" : "customThrottlingRatePolicy"
"defaultRate" : {
"numberOfRequests" : 15,
"duration" : "1 sec"
}
}
}
-
Field Summary
-
Constructor Summary
-
Method Summary
Methods inherited from class org.forgerock.openig.heap.GenericHeaplet
create, destroy, endpointRegistry, evaluatedWithHeapProperties, expression, getConfig, getHeap, getType, initialBindings, meterRegistryHolder, start
-
Constructor Details
-
DefaultRateThrottlingPolicyHeaplet
public DefaultRateThrottlingPolicyHeaplet()
-
-
Method Details
-
create
Description copied from class:GenericHeaplet
Called to request the heaplet create an object. Called byHeaplet.create(Name, JsonValue, Heap)
after initializing the protected field members. Implementations should parse configuration but not acquire resources, start threads, or log any initialization messages. These tasks should be performed by theGenericHeaplet.start()
method.- Specified by:
create
in classGenericHeaplet
- Returns:
- The created object.
- Throws:
HeapException
- if an exception occurred during creation of the heap object or any of its dependencies.
-