51Degrees Pipeline Java  4.1

51Degrees Pipeline for Java

fiftyone.pipeline.engines.fiftyone.data.EvidenceKeyFilterShareUsage Class Reference

Detailed Description

This filter is used by the ShareUsageElement.

It will include anything that is: 1) An HTTP header that is not blocked by the constructor parameter. 2) A cookie that starts with Constants#FIFTYONE_COOKIE_PREFIX or is the session cookie (if configured in the constructor). 3) An query string parameters that have been configured to be shared using the constructor parameter. 4) Not a header, cookie or query string parameter.

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 white list

Inheritance diagram for fiftyone.pipeline.engines.fiftyone.data.EvidenceKeyFilterShareUsage:

[legend]

Collaboration diagram for fiftyone.pipeline.engines.fiftyone.data.EvidenceKeyFilterShareUsage:

[legend]

Public Member Functions

 EvidenceKeyFilterShareUsage (List< String > blockedHttpHeaders, List< String > includedQueryStringParams, boolean includeSession, String sessionCookieName)
Constructor. More...
boolean  include (String key)
Check if the specified evidence key is included by this filter. More...
Integer  order (String key)
Get the order of precedence of the specified key. More...

Constructor & Destructor Documentation

◆ EvidenceKeyFilterShareUsage()

fiftyone.pipeline.engines.fiftyone.data.EvidenceKeyFilterShareUsage.EvidenceKeyFilterShareUsage ( List< String >   blockedHttpHeaders,
List< String >   includedQueryStringParams,
boolean   includeSession,
String   sessionCookieName  
)

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
includeSession - if true then the session cookie will be included in the filter
sessionCookieName - the name of the cookie that contains the session id

Member Function Documentation

◆ include()

boolean fiftyone.pipeline.engines.fiftyone.data.EvidenceKeyFilterShareUsage.include ( String   key )

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

Implements fiftyone.pipeline.core.data.EvidenceKeyFilter.

◆ order()

Integer fiftyone.pipeline.engines.fiftyone.data.EvidenceKeyFilterShareUsage.order ( String   key )

Get the order of precedence of the specified key.

Parameters
key - the key to check
Returns
the order, where lower values indicate a higher order of precedence. Null if the key is not in the white list

Implements fiftyone.pipeline.core.data.EvidenceKeyFilter.