51Degrees Pipeline for Node.js

EvidenceKeyFilter Class Reference

Detailed Description

An evidence key filter is added to a flowElement It tells the pipeline which evidence it is interested in This can be used to determine whether a request can be cached Or to filter out evidence not needed by any element in a pipeline This base class is always extended for a specific filter type.

Inheritance diagram for EvidenceKeyFilter:

[legend]

Public Member Functions

 filterEvidence (evidenceKeyObject)
 Filter an evidence object.
 filterEvidenceKey (key)
 Internal filterEvidenceKey function overriden by specific filters to keep or filter out a piece of evidence.

Member Function Documentation

◆ filterEvidence()

EvidenceKeyFilter::filterEvidence ( evidenceKeyObject)
inline

Filter an evidence object.

Parameters
{object}evidenceKeyObject key value object of evidence
Returns
{object} filtered evidence object

◆ filterEvidenceKey()

EvidenceKeyFilter::filterEvidenceKey ( key)
inline

Internal filterEvidenceKey function overriden by specific filters to keep or filter out a piece of evidence.

Parameters
{string}key the evidence key to check
Returns
{boolean} whether the key should stay or not