Class RateLimiterPolicyConfiguration

Namespace

Dynamicweb.SystemTools.Security

Assembly

Dynamicweb.dll

Defines the configuration for a single rate limiting policy.

public sealed class RateLimiterPolicyConfiguration

Inheritance

object

RateLimiterPolicyConfiguration

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Active

Shows whether the policy is active or not. If set to false, the policy will not be applied.

public bool Active { get; set; }

Property Value

bool

ExcludeFromGlobalLimiter

If true, requests matching this policy will not be processed by the global rate limiter. If false, after this policy's limiter is passed, the request will also be subject to the global limiter.

public bool ExcludeFromGlobalLimiter { get; set; }

Property Value

bool

Id

public long Id { get; set; }

Property Value

long

IsSystemPolicy

Shows whether the policy is a system policy. System policies are predefined and cannot be deleted.

public bool IsSystemPolicy { get; set; }

Property Value

bool

Name

The name/identifier of the policy. Used to reference the policy.

public string Name { get; set; }

Property Value

string

Paths

A list of URL paths to which this policy applies. The policy is triggered if a request path starts with any of these values.

public IEnumerable<string> Paths { get; set; }

Property Value

IEnumerable<string>

PermitLimit

Represents the maximum number of requests that are allowed within a time window defined by WindowSeconds.

public int PermitLimit { get; set; }

Property Value

int

Priority

Defines the order of policy evaluation. Policies with a higher priority value are evaluated first.

public int Priority { get; set; }

Property Value

int

QueueLimit

The maximum number of requests that can be queued when the PermitLimit is reached. A value of 0 means requests are rejected immediately without queuing.

public int QueueLimit { get; set; }

Property Value

int

WindowSeconds

The duration of the time window in seconds, during which up to PermitLimit requests are allowed.

public int WindowSeconds { get; set; }

Property Value

int

Methods

IsValid()

Validates the policy configuration

public bool IsValid()

Returns

bool