org.forgerock.http.filter.throttling

Interface ThrottlingPolicy

All Known Implementing Classes:

DefaultRateThrottlingPolicy, FixedRateThrottlingPolicy, MappedThrottlingPolicy, ScriptableThrottlingPolicy

public interface ThrottlingPolicy

This interface defines the contract to lookup a ThrottlingRate that will be applied to the given Request.

Method Summary

Modifier and Type	Method and Description
org.forgerock.util.promise.Promise<ThrottlingRate,Exception>	lookup(org.forgerock.services.context.Context context, org.forgerock.http.protocol.Request request) Returns the ThrottlingRate that should be used for the provided request.

Method Detail

lookup

org.forgerock.util.promise.Promise<ThrottlingRate,Exception> lookup(org.forgerock.services.context.Context context,
                                                                    org.forgerock.http.protocol.Request request)

Returns the ThrottlingRate that should be used for the provided request.

Parameters:

context - The current context which might be used to retrieve the throttling rate.

request - The current request which might be used to retrieve the throttling rate.

Returns:

A Promise representing the ThrottlingRate that should be used for the request.