org.openhubframework.openhub.spi.throttling

Interface ThrottlingConfiguration

All Known Implementing Classes:

AbstractThrottlingConfiguration, ThrottlingPropertiesConfiguration

public interface ThrottlingConfiguration

Throttling configuration contract.

Author:

Petr Juza

Method Summary

Modifier and Type	Method and Description
Map<ThrottleScope,ThrottleProps>	getProperties() Gets all throttling properties.
ThrottleProps	getThrottleProps(ThrottleScope inScope) Gets throttle properties for most equal scope.
boolean	isThrottlingDisabled() Is throttling disabled at all?

Method Detail

getThrottleProps

@Nullable
ThrottleProps getThrottleProps(ThrottleScope inScope)

Gets throttle properties for most equal scope.

Parameters:

inScope - the scope of the incoming request

Returns:

properties or null if there is no properties for specified scope

getProperties

Map<ThrottleScope,ThrottleProps> getProperties()

Gets all throttling properties.

Returns:

throttling properties

isThrottlingDisabled

boolean isThrottlingDisabled()

Is throttling disabled at all?

Returns:

true for disabling