\r\n

51Degrees Pipeline Python  4.4

51Degrees Pipeline for Python
Search

fiftyone_pipeline_engines_fiftyone.share_usage_evidencekeyfilter.ShareUsageEvidenceKeyFilter Class Reference

Detailed Description

The ShareUsageEvidenceKeyFilter filters out all evidence 
not needed by the 51Degrees ShareUsage service.
It allows for a specific whitelist of query strings,
a blacklist of headers and a specific cookie used for 
session information

Inheritance diagram for fiftyone_pipeline_engines_fiftyone.share_usage_evidencekeyfilter.ShareUsageEvidenceKeyFilter:

[legend]

Collaboration diagram for fiftyone_pipeline_engines_fiftyone.share_usage_evidencekeyfilter.ShareUsageEvidenceKeyFilter:

[legend]

Public Member Functions

def  __init__ (self, cookie=None, query_whitelist=[], header_blacklist=[])
Constructor for ShareUsageEvidenceKeyFilter @type cookie: string. More...
def  filter_evidence_key (self, key)
Check if a specific key should be filtered. More...

Public Member Functions inherited from fiftyone_pipeline_core.basiclist_evidence_keyfilter.BasicListEvidenceKeyFilter

def  __init__ (self, keys_list)
BasicListEvidenceKeyFilter constructor. More...

Public Member Functions inherited from fiftyone_pipeline_core.evidence_keyfilter.EvidenceKeyFilter

def  filter_evidence (self, evidence_key_object)
Filter evidence from a dictionary of evidence keys/values. More...

Public Attributes

 query_whitelist
 header_blacklist
 cookie
 share_all

Public Attributes inherited from fiftyone_pipeline_core.basiclist_evidence_keyfilter.BasicListEvidenceKeyFilter

 list

Constructor & Destructor Documentation

◆ __init__()

def fiftyone_pipeline_engines_fiftyone.share_usage_evidencekeyfilter.ShareUsageEvidenceKeyFilter.__init__ (   self,
  cookie = None,
  query_whitelist = [],
  header_blacklist = []  
)

Constructor for ShareUsageEvidenceKeyFilter @type cookie: string.

Parameters
cookie - which cookie is used to track evidence @type query_whitelist: list
query_whitelist - list of query string whitelist evidence to keep @type query_blacklist: list
query_blacklist - list of header evidence to exclude @type
-

Member Function Documentation

◆ filter_evidence_key()

def fiftyone_pipeline_engines_fiftyone.share_usage_evidencekeyfilter.ShareUsageEvidenceKeyFilter.filter_evidence_key (   self,
  key  
)

Check if a specific key should be filtered.

@type key: string

Parameters
key - to check in the filter

@rtype: bool

Returns
: Is this key in the filter's keys list?

Reimplemented from fiftyone_pipeline_core.basiclist_evidence_keyfilter.BasicListEvidenceKeyFilter.

Member Data Documentation

◆ cookie

fiftyone_pipeline_engines_fiftyone.share_usage_evidencekeyfilter.ShareUsageEvidenceKeyFilter.cookie

◆ header_blacklist

fiftyone_pipeline_engines_fiftyone.share_usage_evidencekeyfilter.ShareUsageEvidenceKeyFilter.header_blacklist

◆ query_whitelist

fiftyone_pipeline_engines_fiftyone.share_usage_evidencekeyfilter.ShareUsageEvidenceKeyFilter.query_whitelist

◆ share_all

fiftyone_pipeline_engines_fiftyone.share_usage_evidencekeyfilter.ShareUsageEvidenceKeyFilter.share_all
On This Page

Generated by doxygen 1.8.15