Detailed Description

This filter is used by the ShareUsageElement.

See the Specification

As this filter is generally inclusive, it will often cause far more evidence to be passed into a pipeline than the engine-specific filters, which tend to be based on a list of values to include such as EvidenceKeyFilterWhitelist.

Inheritance diagram for FiftyOne.Pipeline.Engines.FiftyOne.Data.EvidenceKeyFilterShareUsage:

[legend]

Collaboration diagram for FiftyOne.Pipeline.Engines.FiftyOne.Data.EvidenceKeyFilterShareUsage:

[legend]

Public Member Functions

	EvidenceKeyFilterShareUsage () Constructor Using this constructor will create a filter that allows all evidence. More...
	EvidenceKeyFilterShareUsage (List< string > blockedHttpHeaders, List< string > includedQueryStringParams, bool includeSession, string aspSessionCookieName) Constructor More...
virtual bool	Include (string key) Check if the specified evidence key is included by this filter. More...
int?	Order (string key) Return the 'order of precedence of the specified evidence key. More...

Constructor & Destructor Documentation

◆ EvidenceKeyFilterShareUsage() [1/2]

FiftyOne.Pipeline.Engines.FiftyOne.Data.EvidenceKeyFilterShareUsage.EvidenceKeyFilterShareUsage

(

)

Constructor Using this constructor will create a filter that allows all evidence.

I.e. All evidence will be shared.

◆ EvidenceKeyFilterShareUsage() [2/2]

FiftyOne.Pipeline.Engines.FiftyOne.Data.EvidenceKeyFilterShareUsage.EvidenceKeyFilterShareUsage	(	List< string >	blockedHttpHeaders,
		List< string >	includedQueryStringParams,
		bool	includeSession,
		string	aspSessionCookieName
	)

Constructor

Parameters: blockedHttpHeaders - A list of the names of the HTTP headers that share usage should not send to 51Degrees.; includedQueryStringParams - A list of the names of query string parameters that share usage should send to 51Degrees. If this value is null, all query string parameters are shared.; includeSession - If true then the asp.net session cookie will be included in the filter.; aspSessionCookieName - The name of the cookie that contains the asp.net session id.

Member Function Documentation

◆ Include()

virtual bool FiftyOne.Pipeline.Engines.FiftyOne.Data.EvidenceKeyFilterShareUsage.Include

(

string

key

)

virtual

Check if the specified evidence key is included by this filter.

Parameters: key - The key to check

Returns: True if the key is included and false if not.

Exceptions: ArgumentNullException - Thrown if the supplied key is null

Implements FiftyOne.Pipeline.Core.Data.IEvidenceKeyFilter.

Reimplemented in FiftyOne.Pipeline.Engines.FiftyOne.Data.EvidenceKeyFilterShareUsageTracker.

◆ Order()

int? FiftyOne.Pipeline.Engines.FiftyOne.Data.EvidenceKeyFilterShareUsage.Order

(