51Degrees Pipeline Python  4.2

51Degrees Pipeline for Python
  • pipeline-python
  • fiftyone_pipeline_engines_fiftyone
  • fiftyone_pipeline_engines_fiftyone
  • share_usage_evidencekeyfilter
  • ShareUsageEvidenceKeyFilter

pipeline-python.fiftyone_pipeline_engines_fiftyone.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 pipeline-python.fiftyone_pipeline_engines_fiftyone.fiftyone_pipeline_engines_fiftyone.share_usage_evidencekeyfilter.ShareUsageEvidenceKeyFilter:

[legend]

Collaboration diagram for pipeline-python.fiftyone_pipeline_engines_fiftyone.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 Attributes

 query_whitelist
 header_blacklist
 cookie

Constructor & Destructor Documentation

◆ __init__()

def pipeline-python.fiftyone_pipeline_engines_fiftyone.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 pipeline-python.fiftyone_pipeline_engines_fiftyone.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?