Package fiftyone.devicedetection

Class DeviceDetectionPipelineBuilder

  • public class DeviceDetectionPipelineBuilder
extends java.lang.Object
    Builder used to create a Pipeline with a device detection engine.

    • Field Detail

      • loggerFactory

        protected final org.slf4j.ILoggerFactory loggerFactory

    • Constructor Detail

      • DeviceDetectionPipelineBuilder

        public DeviceDetectionPipelineBuilder()
        Constructor

      • DeviceDetectionPipelineBuilder

        public DeviceDetectionPipelineBuilder​(org.slf4j.ILoggerFactory loggerFactory)
        Constructor
        Parameters:
        loggerFactory - The factory to use for creating loggers within the pipeline.

      • DeviceDetectionPipelineBuilder

        public DeviceDetectionPipelineBuilder​(org.slf4j.ILoggerFactory loggerFactory,
                                      fiftyone.pipeline.engines.services.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

        public DeviceDetectionPipelineBuilder​(org.slf4j.ILoggerFactory loggerFactory,
                                      fiftyone.pipeline.engines.services.HttpClient httpClient,
                                      fiftyone.pipeline.engines.services.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.

    • Method Detail

      • useOnPremise

        public DeviceDetectionOnPremisePipelineBuilder useOnPremise​(java.lang.String datafile,
                                                            boolean createTempDataCopy)
                                                     throws java.lang.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.
        Throws:
        java.lang.Exception - Thrown if a required parameter is null.

      • useOnPremise

        @Deprecated
public DeviceDetectionOnPremisePipelineBuilder useOnPremise​(byte[] data,
                                                            Enums.DeviceDetectionAlgorithm algorithm)
        Deprecated.
        there is no choice of algorithm, use the (byte[]) method
        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.

      • useOnPremise

        public DeviceDetectionOnPremisePipelineBuilder 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.

      • useCloud

        public DeviceDetectionCloudPipelineBuilder useCloud​(java.lang.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
        Returns:
        A builder that can be used to configure and build a pipeline that will use the cloud device detection engine.