org.forgerock.http.filter.throttling

Class DefaultRateThrottlingPolicy

java.lang.Object

org.forgerock.http.filter.throttling.DefaultRateThrottlingPolicy

All Implemented Interfaces:

ThrottlingPolicy

public class DefaultRateThrottlingPolicy
extends Object
implements ThrottlingPolicy

A DefaultRateThrottlingPolicy is a delegating ThrottlingPolicy that ensures the returned ThrottlingRate is never null. If the delegated ThrottlingPolicy returns null, then it returns the specified default rate.

Constructor Summary

Constructors

Constructor and Description
DefaultRateThrottlingPolicy(ThrottlingRate defaultRate, ThrottlingPolicy delegate) Constructs a new DefaultRateThrottlingPolicy.

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultRateThrottlingPolicy

public DefaultRateThrottlingPolicy(ThrottlingRate defaultRate,
                                   ThrottlingPolicy delegate)

Constructs a new DefaultRateThrottlingPolicy.

Parameters:

defaultRate - the rate to return if the one returned by the delegate is null.

delegate - the wrapped datasource to execute

Method Detail

lookup

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

Description copied from interface: ThrottlingPolicy

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

Specified by:

lookup in interface ThrottlingPolicy

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.