Class Filter

Namespace

Fluxzy.Rules.Filters

Assembly

Fluxzy.Core.dll

public abstract class Filter : PolymorphicObject

Inheritance

object

PolymorphicObject

Filter

Derived

AnyFilter

ConnectionFilter

ExecFilter

FilterCollection

HasCommentFilter

HasTagFilter

IsWebSocketFilter

NoFilter

AgentFilter

H11TrafficOnlyFilter

H2TrafficOnlyFilter

HasAnyCookieOnRequestFilter

HasAuthorizationBearerFilter

HasAuthorizationFilter

HasRequestBodyFilter

IsSecureFilter

IsSelfFilter

NetworkErrorFilter

StatusCodeClientErrorFilter

StatusCodeFilter

StatusCodeRedirectionFilter

StatusCodeServerErrorFilter

StatusCodeSuccessFilter

StringFilter

TagContainsFilter

SearchTextFilter

Inherited Members

PolymorphicObject.TypeKind

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

FilterDistinctiveAttributeLoader.BuildDistinctiveIdentifier(Filter)

Properties

AutoGeneratedName

[YamlIgnore]
public virtual string AutoGeneratedName { get; }

Property Value

string

Category

[YamlIgnore]
public string Category { get; }

Property Value

string

Common

[YamlIgnore]
public virtual bool Common { get; set; }

Property Value

bool

Description

public virtual string? Description { get; set; }

Property Value

string

FilterScope

The scope of this filter

[YamlIgnore]
public abstract FilterScope FilterScope { get; }

Property Value

FilterScope

FriendlyName

A friendly name

[YamlIgnore]
public string FriendlyName { get; }

Property Value

string

GenericName

[YamlIgnore]
public virtual string GenericName { get; }

Property Value

string

Identifier

An identifier for this filter, should be the same value for the same filter.

[YamlIgnore]
public virtual Guid Identifier { get; }

Property Value

Guid

Inverted

Negate the filter result

public bool Inverted { get; set; }

Property Value

bool

Locked

public bool Locked { get; set; }

Property Value

bool

PreMadeFilter

[YamlIgnore]
public virtual bool PreMadeFilter { get; }

Property Value

bool

ScopeId

The scope id of this filter

[YamlIgnore]
public int ScopeId { get; }

Property Value

int

ShortName

[YamlIgnore]
public virtual string? ShortName { get; }

Property Value

string

Suffix

protected override string Suffix { get; }

Property Value

string

Methods

Apply(ExchangeContext?, IAuthority, IExchange?, IFilteringContext?)

public virtual bool Apply(ExchangeContext? exchangeContext, IAuthority authority, IExchange? exchange, IFilteringContext? filteringContext)

Parameters

exchangeContext ExchangeContext

authority IAuthority

exchange IExchange

filteringContext IFilteringContext

Returns

bool

GetDefaultSample()

protected virtual FilterExample? GetDefaultSample()

Returns

FilterExample

GetExamples()

public abstract IEnumerable<FilterExample> GetExamples()

Returns

IEnumerable<FilterExample>

Init(StartupContext)

Called once by the engine to initialize this directive

public virtual void Init(StartupContext startupContext)

Parameters

startupContext StartupContext

InternalApply(ExchangeContext?, IAuthority, IExchange?, IFilteringContext?)

protected abstract bool InternalApply(ExchangeContext? exchangeContext, IAuthority authority, IExchange? exchange, IFilteringContext? filteringContext)

Parameters

exchangeContext ExchangeContext

authority IAuthority

exchange IExchange

filteringContext IFilteringContext

Returns

bool