fiftyone.devicedetection.cloud.flowelements.DeviceDetectionCloudEngineBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of device-detection.cloud Show documentation

Device detection that consumes the 51Degrees cloud service.

There is a newer version: 4.5.0-alpha.313

Show newest version

/* *********************************************************************
 * 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.cloud.flowelements;

import fiftyone.devicedetection.cloud.data.DeviceDataCloud;
import fiftyone.pipeline.annotations.ElementBuilder;
import fiftyone.pipeline.core.data.FlowData;
import fiftyone.pipeline.core.data.factories.ElementDataFactory;
import fiftyone.pipeline.core.flowelements.FlowElement;
import fiftyone.pipeline.engines.flowelements.CloudAspectEngineBuilderBase;
import fiftyone.pipeline.engines.services.MissingPropertyServiceDefault;
import org.slf4j.ILoggerFactory;

import java.util.List;

/**
 * Builder for the {@link DeviceDetectionCloudEngine}. All options for the engine
 * should be set here.
 */
@ElementBuilder(alternateName = "CloudDeviceDetection")
public class DeviceDetectionCloudEngineBuilder
    extends CloudAspectEngineBuilderBase<
            DeviceDetectionCloudEngineBuilder,
            DeviceDetectionCloudEngine> {

    /**
     * Construct a new instance using the {@link ILoggerFactory} supplied.
     * @param loggerFactory the logger factory to use
     */
    public DeviceDetectionCloudEngineBuilder(ILoggerFactory loggerFactory) {
        super(loggerFactory);
    }

    @Override
    protected DeviceDetectionCloudEngine newEngine(List properties) {
        return new DeviceDetectionCloudEngine(
            loggerFactory.getLogger(DeviceDetectionCloudEngine.class.getName()),
            new DeviceDataCloudFactory(loggerFactory));
    }

    /**
     * Build an engine using the current options.
     * @return new instance
     */
    public DeviceDetectionCloudEngine build() throws Exception {
        return buildEngine();
    }

    private static class DeviceDataCloudFactory
        implements ElementDataFactory {

        private final ILoggerFactory loggerFactory;

        public DeviceDataCloudFactory(ILoggerFactory loggerFactory) {
            this.loggerFactory = loggerFactory;
        }

        @Override
        public DeviceDataCloud create(
            FlowData flowData,
            FlowElement engine) {
            return new DeviceDataCloudInternal(
                loggerFactory.getLogger(DeviceDataCloud.class.getName()),
                flowData,
                (DeviceDetectionCloudEngine) engine,
                MissingPropertyServiceDefault.getInstance());
        }
    }
}