Detailed Description
Builder used to create a Pipeline with a device detection engine.
Public Member Functions | |
| DeviceDetectionPipelineBuilder () | |
| Constructor. | |
| DeviceDetectionPipelineBuilder (ILoggerFactory loggerFactory) | |
| Constructor. | |
| DeviceDetectionPipelineBuilder (ILoggerFactory loggerFactory, HttpClient httpClient) | |
| Constructor. | |
| DeviceDetectionPipelineBuilder (ILoggerFactory loggerFactory, HttpClient httpClient, DataUpdateService dataUpdateService) | |
| Constructor. | |
| DeviceDetectionOnPremisePipelineBuilder | useOnPremise (String datafile, boolean createTempDataCopy) throws Exception |
| Use a 51Degrees on-premise device detection engine to perform device detection. | |
| DeviceDetectionOnPremisePipelineBuilder | useOnPremise (byte[] data, Enums.DeviceDetectionAlgorithm algorithm) |
| Use a 51Degrees on-premise device detection engine to perform device detection. | |
| DeviceDetectionOnPremisePipelineBuilder | useOnPremise (byte[] data) |
| Use a 51Degrees on-premise device detection engine to perform device detection. | |
| DeviceDetectionCloudPipelineBuilder | useCloud (String resourceKey) |
| Use the 51Degrees Cloud service to perform device detection. | |
Protected Attributes | |
| final ILoggerFactory | loggerFactory |
Constructor & Destructor Documentation
◆ DeviceDetectionPipelineBuilder() [1/3]
| fiftyone.devicedetection.DeviceDetectionPipelineBuilder.DeviceDetectionPipelineBuilder | ( | ILoggerFactory | loggerFactory | ) |
Constructor.
- Parameters
-
loggerFactory The factory to use for creating loggers within the pipeline.
◆ DeviceDetectionPipelineBuilder() [2/3]
| fiftyone.devicedetection.DeviceDetectionPipelineBuilder.DeviceDetectionPipelineBuilder | ( | ILoggerFactory | loggerFactory, |
| HttpClient | httpClient ) |
Constructor.
- Parameters
-
loggerFactory The factory to use for creating loggers within the pipeline. httpClient The HTTP Client to use within the pipeline.
◆ DeviceDetectionPipelineBuilder() [3/3]
| fiftyone.devicedetection.DeviceDetectionPipelineBuilder.DeviceDetectionPipelineBuilder | ( | ILoggerFactory | loggerFactory, |
| HttpClient | httpClient, | ||
| DataUpdateService | dataUpdateService ) |
Constructor.
- Parameters
-
loggerFactory The factory to use for creating loggers within the pipeline. httpClient The HTTP Client to use within the pipeline. dataUpdateService The DataUpdateService to use when checking for data updates.
Member Function Documentation
◆ useCloud()
| DeviceDetectionCloudPipelineBuilder fiftyone.devicedetection.DeviceDetectionPipelineBuilder.useCloud | ( | String | resourceKey | ) |
Use the 51Degrees Cloud service to perform device detection.
- Parameters
-
resourceKey The resource key to use when querying the cloud service. Obtain one from https://configure.51degrees.com?utm_source=code&utm_medium=comment&utm_campaign=51degrees-java&utm_content=device-detection-src-main-java-fiftyone-devicedetection-devicedetectionpipelinebuilder.java&utm_term=usecloud
- Returns
- A builder that can be used to configure and build a pipeline that will use the cloud device detection engine.
◆ useOnPremise() [1/3]
| DeviceDetectionOnPremisePipelineBuilder fiftyone.devicedetection.DeviceDetectionPipelineBuilder.useOnPremise | ( | byte[] | data | ) |
Use a 51Degrees on-premise device detection engine to perform device detection.
- Parameters
-
data The device detection data file as a byte array.
- Returns
- A builder that can be used to configure and build a pipeline that will use the on-premise detection engine.
◆ useOnPremise() [2/3]
| DeviceDetectionOnPremisePipelineBuilder fiftyone.devicedetection.DeviceDetectionPipelineBuilder.useOnPremise | ( | byte[] | data, |
| Enums.DeviceDetectionAlgorithm | algorithm ) |
Use a 51Degrees on-premise device detection engine to perform device detection.
- Parameters
-
data The device detection data file as a byte array. algorithm The detection algorithm that the supplied data supports.
- Returns
- A builder that can be used to configure and build a pipeline that will use the on-premise detection engine.
- Deprecated
- there is no choice of algorithm, use the (byte[]) method
◆ useOnPremise() [3/3]
| DeviceDetectionOnPremisePipelineBuilder fiftyone.devicedetection.DeviceDetectionPipelineBuilder.useOnPremise | ( | String | datafile, |
| boolean | createTempDataCopy ) throws Exception |
Use a 51Degrees on-premise device detection engine to perform device detection.
- Parameters
-
datafile The full path to the device detection data file. createTempDataCopy If true, the engine will create a temporary copy of the data file rather than using the data file directly.
- Returns
- A builder that can be used to configure and build a pipeline that will use the on-premise detection engine.
- Exceptions
-
Exception Thrown if a required parameter is null.