51Degrees Device Detection Java  4.1

Device detection services for 51Degrees Pipeline

fiftyone.devicedetection.shared.flowelements.OnPremiseDeviceDetectionEngineBuilderBase< TBuilder extends OnPremiseDeviceDetectionEngineBuilderBase< TBuilder, TEngine, TEngine extends FiftyOneAspectEngine > Class Template Reference abstract

Detailed Description

Base builder class for 51Degrees on-premise device detection engines.

Parameters
<TBuilder> - the specific builder type to use as the return type from the fluent builder methods
<TEngine> - the type of the engine that this builder will build

Inheritance diagram for fiftyone.devicedetection.shared.flowelements.OnPremiseDeviceDetectionEngineBuilderBase< TBuilder extends OnPremiseDeviceDetectionEngineBuilderBase< TBuilder, TEngine, TEngine extends FiftyOneAspectEngine >:

[legend]

Collaboration diagram for fiftyone.devicedetection.shared.flowelements.OnPremiseDeviceDetectionEngineBuilderBase< TBuilder extends OnPremiseDeviceDetectionEngineBuilderBase< TBuilder, TEngine, TEngine extends FiftyOneAspectEngine >:

[legend]

Public Member Functions

 OnPremiseDeviceDetectionEngineBuilderBase ()
Default constructor which uses the ILoggerFactory implementation returned by LoggerFactory#getILoggerFactory().
 OnPremiseDeviceDetectionEngineBuilderBase (ILoggerFactory loggerFactory)
Construct a new instance using the ILoggerFactory supplied. More...
 OnPremiseDeviceDetectionEngineBuilderBase (ILoggerFactory loggerFactory, DataUpdateService dataUpdateService)
Construct a new instance using the ILoggerFactory and DataUpdateService supplied. More...
abstract TBuilder  setDifference (int difference)
Set the maximum difference to allow when processing HTTP headers. More...
abstract TBuilder  setAllowUnmatched (boolean allow)
If set to false, a non-matching User-Agent will result in properties without set values. More...

Constructor & Destructor Documentation

◆ OnPremiseDeviceDetectionEngineBuilderBase() [2/2]

fiftyone.devicedetection.shared.flowelements.OnPremiseDeviceDetectionEngineBuilderBase< TBuilder extends OnPremiseDeviceDetectionEngineBuilderBase< TBuilder, TEngine, TEngine extends FiftyOneAspectEngine >.OnPremiseDeviceDetectionEngineBuilderBase ( ILoggerFactory   loggerFactory,
DataUpdateService   dataUpdateService  
)

Construct a new instance using the ILoggerFactory and DataUpdateService supplied.

Parameters
loggerFactory - the logger factory to use
dataUpdateService - the DataUpdateService to use when automatic updates happen on the data file

Member Function Documentation

◆ setAllowUnmatched()

abstract TBuilder fiftyone.devicedetection.shared.flowelements.OnPremiseDeviceDetectionEngineBuilderBase< TBuilder extends OnPremiseDeviceDetectionEngineBuilderBase< TBuilder, TEngine, TEngine extends FiftyOneAspectEngine >.setAllowUnmatched ( boolean   allow )
abstract

If set to false, a non-matching User-Agent will result in properties without set values.

If set to true, a non-matching User-Agent will cause the 'default profiles' to be returned. This means that properties will always have values (i.e. no need to check AspectPropertyValue#hasValue()) but some may be inaccurate. By default, this is false.

Parameters
allow - true if results with no matched hash nodes should be considered valid
Returns
this builder

◆ setDifference()

abstract TBuilder fiftyone.devicedetection.shared.flowelements.OnPremiseDeviceDetectionEngineBuilderBase< TBuilder extends OnPremiseDeviceDetectionEngineBuilderBase< TBuilder, TEngine, TEngine extends FiftyOneAspectEngine >.setDifference ( int   difference )
abstract

Set the maximum difference to allow when processing HTTP headers.

The meaning of difference depends on the Device Detection API being used. The difference is the difference in hash value between the hash that was found, and the hash that is being searched for. By default this is 0.

Parameters
difference - to allow
Returns
this builder