\r\n

51Degrees Pipeline Java  4.4

51Degrees Pipeline for Java

fiftyone.pipeline.engines.fiftyone.flowelements.ShareUsageBuilder Class Reference

Detailed Description

Builder class that is used to create ShareUsageElement.

Inheritance diagram for fiftyone.pipeline.engines.fiftyone.flowelements.ShareUsageBuilder:

[legend]

Collaboration diagram for fiftyone.pipeline.engines.fiftyone.flowelements.ShareUsageBuilder:

[legend]

Public Member Functions

 ShareUsageBuilder (ILoggerFactory loggerFactory)
Constructor. More...
 ShareUsageBuilder (ILoggerFactory loggerFactory, Logger logger)
Constructor. More...
 ShareUsageBuilder (ILoggerFactory loggerFactory, DataUploader dataUploader)
Constructor. More...
 ShareUsageBuilder (ILoggerFactory loggerFactory, HttpClient httpClient)
Constructor. More...
 ShareUsageBuilder (ILoggerFactory loggerFactory, Logger logger, HttpClient httpClient)
Constructor. More...
ShareUsageElement  build () throws IOException

Public Member Functions inherited from fiftyone.pipeline.engines.fiftyone.flowelements.ShareUsageBuilderBase< ShareUsageElement >

 ShareUsageBuilderBase (ILoggerFactory loggerFactory)
Constructor. More...
 ShareUsageBuilderBase (ILoggerFactory loggerFactory, Logger logger)
Constructor. More...
ShareUsageBuilderBase< T >  setIncludedQueryStringParameters (List< String > queryStringParameterNames)
By default, query string parameters are not shared. More...
ShareUsageBuilderBase< T >  setIncludedQueryStringParameters (String queryStringParameterNames)
By default, query string parameters are not shared. More...
ShareUsageBuilderBase< T >  setIncludedQueryStringParameter (String queryStringParameterName)
By default, query string parameters are not shared. More...
ShareUsageBuilderBase< T >  setBlockedHttpHeaders (List< String > blockedHeaders)
By default, all HTTP headers (excluding a few such as 'cookies', if they don't start with 51D_) are shared. More...
ShareUsageBuilderBase< T >  setBlockedHttpHeaders (String blockedHeaders)
By default, all HTTP headers (excluding a few such as 'cookies', if they don't start with 51D_) are shared. More...
ShareUsageBuilderBase< T >  setBlockedHttpHeader (String blockedHeader)
By default, all HTTP headers (excluding a few such as 'cookies', if they don't start with 51D_) are shared. More...
ShareUsageBuilderBase< T >  setIgnoreFlowDataEvidenceFilter (String evidenceFilter)
This setter can be used to stop the usage sharing element from sharing anything about specific requests. More...
ShareUsageBuilderBase< T >  setSharePercentage (double sharePercentage)
Set the percentage of data that the ShareUsageElement should be sharing. More...
ShareUsageBuilderBase< T >  setMinimumEntriesPerMessage (int minimumEntriesPerMessage)
The usage element will group data into single requests before sending it. More...
ShareUsageBuilderBase< T >  setMaximumQueueSize (int size)
Set the maximum number of entries to be stored in the queue to be sent. More...
int  getMaximumQueueSize ()
Get the maximum number of entries to be stored in the queue to be sent. More...
ShareUsageBuilderBase< T >  setAddTimeout (int milliseconds)
Set the timeout in milliseconds to allow when attempting to add an item to the queue. More...
ShareUsageBuilderBase< T >  setAddTimeoutMillis (int milliseconds)
Set the timeout in milliseconds to allow when attempting to add an item to the queue. More...
ShareUsageBuilderBase< T >  setTakeTimeout (int milliseconds)
Set the timeout in milliseconds to allow when attempting to take an item from the queue in order to send to the remote service. More...
ShareUsageBuilderBase< T >  setTakeTimeoutMillis (int milliseconds)
Set the timeout in milliseconds to allow when attempting to take an item from the queue in order to send to the remote service. More...
ShareUsageBuilderBase< T >  setShareUsageUrl (String shareUsageUrl)
Set the URL to use when sharing usage data. More...
ShareUsageBuilderBase< T >  setSessionCookieName (String cookieName)
Set the name of the cookie that contains the session id. More...
ShareUsageBuilderBase< T >  setRepeatEvidenceIntervalMinutes (int interval)
If exactly the same evidence values are seen multiple times within this time limit then they will only be shared once. More...
ShareUsageBuilderBase< T >  setTrackSession (boolean track)
If set to true, the configured session cookie will be used to identify user sessions. More...
abstract T  build () throws IOException

Constructor & Destructor Documentation

◆ ShareUsageBuilder() [1/5]

fiftyone.pipeline.engines.fiftyone.flowelements.ShareUsageBuilder.ShareUsageBuilder ( ILoggerFactory   loggerFactory )

Constructor.

Parameters
loggerFactory - the ILoggerFactory to use when creating loggers for a ShareUsageElement

◆ ShareUsageBuilder() [2/5]

fiftyone.pipeline.engines.fiftyone.flowelements.ShareUsageBuilder.ShareUsageBuilder ( ILoggerFactory   loggerFactory,
Logger   logger  
)

Constructor.

Parameters
loggerFactory - the ILoggerFactory to use when creating loggers for a ShareUsageElement
logger - the Logger to use for ShareUsageElement

◆ ShareUsageBuilder() [4/5]

fiftyone.pipeline.engines.fiftyone.flowelements.ShareUsageBuilder.ShareUsageBuilder ( ILoggerFactory   loggerFactory,
HttpClient   httpClient  
)

Constructor.

Parameters
loggerFactory - the ILoggerFactory to use when creating loggers for a ShareUsageElement
httpClient - the HttpClient that ShareUsageElement should use for sending data
Deprecated:
use other constructor without httpClient