org.adroitlogic.ultraesb.api.mediation

Interface ThrottleSupport

public interface ThrottleSupport

This interface defines the base for throttling implementations for the UltraESB. Implementations of this interface should implement the isAllowed(org.adroitlogic.ultraesb.api.Message) method to provide the throttling functionality.

Since:

1.7.0

Author:

Ruwan

Method Summary

Methods

Modifier and Type	Method and Description
void	addOrUpdateRule(String key, String rule) Adds a rule to the existing throttle or update if it is already existing
boolean	isAllowed(Message message) Implementer should implement the throttling logic within this.
boolean	isAllowed(String key, Message message) Throttling method implementation which takes in a category/key for evaluation - such as username, group, IP etc.

Method Detail

isAllowed

boolean isAllowed(Message message)

Implementer should implement the throttling logic within this. If the throttle logic allows this message to proceed then it should return true or if the message fails to satisfy the throttle logic false should be returned.

Parameters:

message - the current message to be used for validation

Returns:

true if the throttle configuration allows the message to proceed further, false otherwise

isAllowed

boolean isAllowed(String key,
                Message message)

Throttling method implementation which takes in a category/key for evaluation - such as username, group, IP etc.

Parameters:

key - the category / key for the request

message - message to throttle

Returns:

true if allowed, false otherwise

addOrUpdateRule

void addOrUpdateRule(String key,
                   String rule)

Adds a rule to the existing throttle or update if it is already existing

Parameters:

key - the rule kep to be added or updated

rule - the rule to be added or updated