◆ ShareUsageBase() [1/3]
fiftyone.pipeline.engines.fiftyone.flowelements.ShareUsageBase.ShareUsageBase | ( | Logger | logger, |
double | sharePercentage, | ||
int | minimumEntriesPerMessage, | ||
int | maximumQueueSize, | ||
int | addTimeout, | ||
int | takeTimeout, | ||
int | repeatEvidenceIntervalMinutes, | ||
boolean | trackSession, | ||
String | shareUsageUrl, | ||
List< String > | blockedHttpHeaders, | ||
List< String > | includedQueryStringParameters, | ||
List< Map.Entry< String, String >> | ignoreDataEvidenceFilter | ||
) |
protected
Constructor.
- Parameters
-
- logger - the logger to use
- sharePercentage - the approximate proportion of requests to share. 1 = 100%, 0.5 = 50%, etc.
- minimumEntriesPerMessage - the minimum number of request entries per message sent to 51Degrees
- maximumQueueSize - the maximum number of items to hold in the queue at one time. This must be larger than minimum entries
- addTimeout - the timeout in milliseconds to allow when attempting to add an item to the queue. If this timeout is exceeded then usage sharing will be disabled
- takeTimeout - the timeout in milliseconds to allow when attempting to take an item to the queue
- repeatEvidenceIntervalMinutes - the interval (in minutes) which is used to decide if repeat evidence is old enough to consider a new session
- trackSession - set if the tracker should consider sessions in share usage
- shareUsageUrl - the URL to send data to
- blockedHttpHeaders - a list of the names of the HTTP headers that share usage should not send to 51Degrees
- includedQueryStringParameters - a list of the names of query string parameters that share usage should send to 51Degrees
- ignoreDataEvidenceFilter - the filter used to determine if an item of evidence should be ignored or not
◆ ShareUsageBase() [2/3]
fiftyone.pipeline.engines.fiftyone.flowelements.ShareUsageBase.ShareUsageBase ( Logger logger, double sharePercentage, int minimumEntriesPerMessage, int maximumQueueSize, int addTimeout, int takeTimeout, int repeatEvidenceIntervalMinutes, boolean trackSession, String shareUsageUrl, List< String > blockedHttpHeaders, List< String > includedQueryStringParameters, List< Map.Entry< String, String >> ignoreDataEvidenceFilter, String sessionCookieName ) protectedConstructor.
- Parameters
-
- logger - the logger to use
- sharePercentage - the approximate proportion of requests to share. 1 = 100%, 0.5 = 50%, etc.
- minimumEntriesPerMessage - the minimum number of request entries per message sent to 51Degrees
- maximumQueueSize - the maximum number of items to hold in the queue at one time. This must be larger than minimum entries
- addTimeout - the timeout in milliseconds to allow when attempting to add an item to the queue. If this timeout is exceeded then usage sharing will be disabled
- takeTimeout - the timeout in milliseconds to allow when attempting to take an item to the queue
- repeatEvidenceIntervalMinutes - the interval (in minutes) which is used to decide if repeat evidence is old enough to consider a new session
- trackSession - set if the tracker should consider sessions in share usage
- shareUsageUrl - the URL to send data to
- blockedHttpHeaders - a list of the names of the HTTP headers that share usage should not send to 51Degrees
- includedQueryStringParameters - a list of the names of query string parameters that share usage should send to 51Degrees
- ignoreDataEvidenceFilter - the filter used to determine if an item of evidence should be ignored or not
- sessionCookieName - the name of the cookie that contains the session id
◆ ShareUsageBase() [3/3]
rameterType -->List< Map.Entry< String, String >> ignoreDataEvidenceFilter, String sessionCookieName ) protectedConstructor.
- Parameters
-
- logger - the logger to use
- sharePercentage - the approximate proportion of requests to share. 1 = 100%, 0.5 = 50%, etc.
- minimumEntriesPerMessage - the minimum number of request entries per message sent to 51Degrees
- maximumQueueSize - the maximum number of items to hold in the queue at one time. This must be larger than minimum entries
- addTimeout - the timeout in milliseconds to allow when attempting to add an item to the queue. If this timeout is exceeded then usage sharing will be disabled
- takeTimeout - the timeout in milliseconds to allow when attempting to take an item to the queue
- repeatEvidenceIntervalMinutes - the interval (in minutes) which is used to decide if repeat evidence is old enough to consider a new session
- trackSession - set if the tracker should consider sessions in share usage
- shareUsageUrl - the URL to send data to
- blockedHttpHeaders - a list of the names of the HTTP headers that share usage should not send to 51Degrees
- includedQueryStringParameters - a list of the names of query string parameters that share usage should send to 51Degrees
- ignoreDataEvidenceFilter - the filter used to determine if an item of evidence should be ignored or not
- sessionCookieName - the name of the cookie that contains the session id
◆ ShareUsageBase() [3/3]
fiftyone.pipeline.engines.fiftyone.flowelements.ShareUsageBase.ShareUsageBase ( Logger logger, double sharePercentage, int minimumEntriesPerMessage, int maximumQueueSize, int addTimeout, int takeTimeout, int repeatEvidenceIntervalMinutes, boolean trackSession, String shareUsageUrl, List< String > blockedHttpHeaders, List< String > includedQueryStringParameters, List< Map.Entry< String, String >> ignoreDataEvidenceFilter, String sessionCookieName, Tracker tracker ) protectedConstructor.
- Parameters
-
- logger - the logger to use
- sharePercentage - the approximate proportion of requests to share. 1 = 100%, 0.5 = 50%, etc.
- minimumEntriesPerMessage - the minimum number of request entries per message sent to 51Degrees
- maximumQueueSize - the maximum number of items to hold in the queue at one time. This must be larger than minimum entries
- addTimeout - the timeout in milliseconds to allow when attempting to add an item to the queue. If this timeout is exceeded then usage sharing will be disabled
- takeTimeout - the timeout in milliseconds to allow when attempting to take an item to the queue
- repeatEvidenceIntervalMinutes - the interval (in minutes) which is used to decide if repeat evidence is old enough to consider a new session
- trackSession - set if the tracker should consider sessions in share usage
- shareUsageUrl - the URL to send data to
- blockedHttpHeaders - a list of the names of the HTTP headers that share usage should not send to 51Degrees
- includedQueryStringParameters - a list of the names of query string parameters that share usage should send to 51Degrees
- ignoreDataEvidenceFilter - the filter used to determine if an item of evidence should be ignored or not
- sessionCookieName - the name of the cookie that contains the session id
- tracker - the Tracker to use to determine if a given FlowData instance should be shared or not
Member Function Documentation
◆ buildData()
void fiftyone.pipeline.engines.fiftyone.flowelements.ShareUsageBase.buildData ( XmlBuilder builder, ShareUsageData data ) protectedVirtual method to be overridden in extending usage share elements.
Write the specified data using the specified writer.
- Parameters
-
- builder - the XmlBuilder to use
- data - the data to write
◆ buildDeviceData()
void fiftyone.pipeline.engines.fiftyone.flowelements.ShareUsageBase.buildDeviceData ( XmlBuilder builder, ShareUsageData data ) protectedWrite the specified device data using the specified writer.
- Parameters
-
- builder - the XmlBuilder to use
- data - the data to write
◆ encodeInvalidXMLChars()
String fiftyone.pipeline.engines.fiftyone.flowelements.ShareUsageBase.encodeInvalidXMLChars ( String text ) Encodes any unusual characters into their hex representation.
- Parameters
-
- text - the text to encode
- Returns
- encoded text
◆ trySendData()
void fiftyone.pipeline.engines.fiftyone.flowelements.ShareUsageBase.trySendData ( ) protectedAttempt to send the data to the remote service.
This only happens if there is not a task already running. If any error occurs while sending the data, then usage sharing is stopped.
◆ writePipelineInfo()
void fiftyone.pipeline.engines.fiftyone.flowelements.ShareUsageBase.writePipelineInfo ( XmlBuilder builder ) protectedMethod to write details about the pipeline.
- Parameters
-
- builder - XmlBuilder to use