fiftyone.devicedetection.DeviceDetectionPipelineBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of device-detection Show documentation
Show all versions of device-detection Show documentation
Parse HTTP headers to detect the device type, model, OS, browser, and crawler information. This is an alternative to popular UAParser, DeviceAtlas, and WURFL packages.
/* *********************************************************************
* This Original Work is copyright of 51 Degrees Mobile Experts Limited.
* Copyright 2023 51 Degrees Mobile Experts Limited, Davidson House,
* Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
*
* This Original Work is licensed under the European Union Public Licence
* (EUPL) v.1.2 and is subject to its terms as set out below.
*
* If a copy of the EUPL was not distributed with this file, You can obtain
* one at https://opensource.org/licenses/EUPL-1.2.
*
* The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
* amended by the European Commission) shall be deemed incompatible for
* the purposes of the Work and the provisions of the compatibility
* clause in Article 5 of the EUPL shall not apply.
*
* If using the Work as, or as part of, a network application, by
* including the attribution notice(s) required under Article 5 of the EUPL
* in the end user terms of the application under an appropriate heading,
* such notice(s) shall fulfill the requirements of that article.
* ********************************************************************* */
package fiftyone.devicedetection;
import fiftyone.pipeline.engines.services.DataUpdateService;
import fiftyone.pipeline.engines.services.DataUpdateServiceDefault;
import fiftyone.pipeline.engines.services.HttpClient;
import fiftyone.pipeline.engines.services.HttpClientDefault;
import org.slf4j.ILoggerFactory;
import org.slf4j.LoggerFactory;
/**
* Builder used to create a Pipeline with a device detection engine.
*/
public class DeviceDetectionPipelineBuilder {
protected final ILoggerFactory loggerFactory;
private final DataUpdateService dataUpdateService;
private final HttpClient httpClient;
/**
* Constructor
*/
public DeviceDetectionPipelineBuilder() {
this(LoggerFactory.getILoggerFactory());
}
/**
* Constructor
* @param loggerFactory The factory to use for creating loggers within the
* pipeline.
*/
public DeviceDetectionPipelineBuilder(
ILoggerFactory loggerFactory) {
this(loggerFactory, new HttpClientDefault());
}
/**
* Constructor
* @param loggerFactory The factory to use for creating loggers within the
* pipeline.
* @param httpClient The HTTP Client to use within the pipeline.
*/
public DeviceDetectionPipelineBuilder(
ILoggerFactory loggerFactory,
HttpClient httpClient) {
this(loggerFactory, httpClient, new DataUpdateServiceDefault(
loggerFactory.getLogger(DataUpdateServiceDefault.class.getName()),
httpClient));
}
/**
* Constructor
* @param loggerFactory The factory to use for creating loggers within the
* pipeline.
* @param httpClient The HTTP Client to use within the pipeline.
* @param dataUpdateService The DataUpdateService to use when checking for
* data updates.
*/
public DeviceDetectionPipelineBuilder(
ILoggerFactory loggerFactory,
HttpClient httpClient,
DataUpdateService dataUpdateService) {
this.httpClient = httpClient;
this.loggerFactory = loggerFactory;
this.dataUpdateService = dataUpdateService;
}
/**
* Use a 51Degrees on-premise device detection engine to
* perform device detection.
* @param datafile The full path to the device detection data file.
* @param createTempDataCopy If true, the engine will create a temporary
* copy of the data file rather than using the data file directly.
* @return A builder that can be used to configure and build a pipeline
* that will use the on-premise detection engine.
* @throws Exception Thrown if a required parameter is null.
*/
public DeviceDetectionOnPremisePipelineBuilder useOnPremise(
String datafile,
boolean createTempDataCopy) throws Exception {
DeviceDetectionOnPremisePipelineBuilder builder =
new DeviceDetectionOnPremisePipelineBuilder(
loggerFactory,
dataUpdateService,
httpClient);
builder.setFilename(datafile, createTempDataCopy);
return builder;
}
/**
* Use a 51Degrees on-premise device detection engine to
* perform device detection.
* @param data The device detection data file as a byte array.
* @param algorithm The detection algorithm that the supplied data supports.
* @return 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
*/
@Deprecated
public DeviceDetectionOnPremisePipelineBuilder useOnPremise(
byte[] data,
Enums.DeviceDetectionAlgorithm algorithm) {
return useOnPremise(data);
}
/**
*
* Use a 51Degrees on-premise device detection engine to
* perform device detection.
* @param data The device detection data file as a byte array.
* @return A builder that can be used to configure and build a pipeline
* that will use the on-premise detection engine.
*/
public DeviceDetectionOnPremisePipelineBuilder useOnPremise(
byte[] data) {
DeviceDetectionOnPremisePipelineBuilder builder =
new DeviceDetectionOnPremisePipelineBuilder(
loggerFactory,
dataUpdateService,
httpClient);
builder.setEngineData(data);
return builder;
}
/**
* Use the 51Degrees Cloud service to perform device detection.
* @param resourceKey The resource key to use when querying the cloud service.
* Obtain one from https://configure.51degrees.com
* @return A builder that can be used to configure and build a pipeline
* that will use the cloud device detection engine.
*/
public DeviceDetectionCloudPipelineBuilder useCloud(String resourceKey) {
DeviceDetectionCloudPipelineBuilder builder =
new DeviceDetectionCloudPipelineBuilder(loggerFactory, httpClient);
builder.setResourceKey(resourceKey);
return builder;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy