Package org.forgerock.openig.filter.throttling

Class MappedThrottlingPolicyHeaplet

java.lang.Object

org.forgerock.openig.heap.GenericHeaplet

org.forgerock.openig.filter.throttling.MappedThrottlingPolicyHeaplet

All Implemented Interfaces:

Heaplet

public class MappedThrottlingPolicyHeaplet
extends GenericHeaplet

Creates and initializes a MappedThrottlingPolicy in a heap environment. Configuration options:

 
 {
     "type": "MappedThrottlingPolicy",
     "config": {
         "throttlingRateMapper"         : expression<String>              [REQUIRED - The expression that will be
                                                                                      evaluated to lookup for a
                                                                                      throttling rate.]
         "throttlingRatesMapping"       : {                               [REQUIRED - This is a in memory map used to
                                                                                      lookup the throttling rate to
                                                                                      apply.]
             "<throttlingRateKey>" {   : String                           [REQUIRED - The value to match the
                                                                                      result of the expression
                                                                                      throttlingRateMapper.]
                 "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.]
             }
         },
         "defaultRate" {                 : reference                      [OPTIONAL - the default rate to apply if
                                                                                      there is no match]
             "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 : apply different throttling rates depending of the header 'Origin'. If the header is not specified, let's apply a default rate of 15 requests per second. { "type": "MappedThrottlingPolicy", "config": { "throttlingRateMapper" : "${request.headers['Origin'][0]}" "throttlingRateMapping" : { "http://www.alice.com" : { "numberOfRequests" : 30, "duration" : "1 hour" }, "http://www.bob.com" : { "numberOfRequests" : 42, "duration" : "1 minute" } }, "defaultRate" : { "numberOfRequests" : 15, "duration" : "1 sec" } } }

Field Summary

Fields inherited from class org.forgerock.openig.heap.GenericHeaplet

config, heap, name, object, qualified

Constructor Summary

Constructors

Constructor	Description
MappedThrottlingPolicyHeaplet()

Method Summary

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, getType, initialBindings, meterRegistryHolder, start

Methods inherited from class java.lang.Object

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

Constructor Details

MappedThrottlingPolicyHeaplet

public MappedThrottlingPolicyHeaplet()

Method Details

create

public Object create()
              throws HeapException

Description copied from class: GenericHeaplet

Called to request the heaplet create an object. Called by Heaplet.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 the GenericHeaplet.start() method.

Specified by:

create in class GenericHeaplet

Returns:

The created object.

Throws:

HeapException - if an exception occurred during creation of the heap object or any of its dependencies.