Package org.forgerock.openig.filter.throttling

Class FixedRateThrottlingPolicy

java.lang.Object

org.forgerock.openig.filter.throttling.FixedRateThrottlingPolicy

All Implemented Interfaces:

ThrottlingPolicy

public class FixedRateThrottlingPolicy
extends Object
implements ThrottlingPolicy

An implementation of the ThrottlingPolicy that always returns the same throtlling rate.

Constructor Summary

Constructors

Constructor	Description
FixedRateThrottlingPolicy(ThrottlingRate rate)	Constructs a new throttling policy that always returns the same throttling rate.

Method Summary

Modifier and Type	Method	Description
Promise<ThrottlingRate,Exception>	lookup(Context context, 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

FixedRateThrottlingPolicy

public FixedRateThrottlingPolicy(ThrottlingRate rate)

Constructs a new throttling policy that always returns the same throttling rate.

Parameters:

rate - the rate to return

Method Detail

lookup

public Promise<ThrottlingRate,Exception> lookup(Context context,
                                                      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.