Class DefaultRateThrottlingPolicyHeaplet
- java.lang.Object
-
- org.forgerock.openig.heap.GenericHeaplet
-
- org.forgerock.openig.filter.throttling.DefaultRateThrottlingPolicyHeaplet
-
- All Implemented Interfaces:
Heaplet
public class DefaultRateThrottlingPolicyHeaplet extends GenericHeaplet
Creates and initializes aDefaultRateThrottlingPolicy
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.] } } }
{ "type": "DefaultRateThrottlingPolicy", "config": { "delegateThrottlingRatePolicy" : "customThrottlingRatePolicy" "defaultRate" : { "numberOfRequests" : 15, "duration" : "1 sec" } } }
-
-
Constructor Summary
Constructors Constructor Description DefaultRateThrottlingPolicyHeaplet()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Object
create()
Called to request the heaplet create an object.-
Methods inherited from class org.forgerock.openig.heap.GenericHeaplet
create, destroy, endpointRegistry, evaluatedWithHeapProperties, expression, getConfig, getHeap, getSecretService, getSecretsProvider, getType, initialBindings, meterRegistryHolder, start
-
-
-
-
Method Detail
-
create
public Object create() throws HeapException
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.
-
-