51Degrees Device Detection Java  4.1

Device detection services for 51Degrees Pipeline

hash/GettingStarted.java

This example is available in full on GitHub.

This example requires a local data file. Free data files can be acquired by pulling the submodules under this repository or from the device-detection-data GitHub repository.

/* *********************************************************************
* This Original Work is copyright of 51 Degrees Mobile Experts Limited.
* Copyright 2019 51 Degrees Mobile Experts Limited, 5 Charlotte Close,
* Caversham, Reading, Berkshire, United Kingdom RG4 7BY.
*
* 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.examples.hash;
import fiftyone.devicedetection.DeviceDetectionPipelineBuilder;
import fiftyone.devicedetection.examples.ExampleBase;
import fiftyone.devicedetection.examples.ProgramBase;
import fiftyone.devicedetection.shared.DeviceData;
import fiftyone.pipeline.core.data.FlowData;
import fiftyone.pipeline.core.flowelements.Pipeline;
import fiftyone.pipeline.engines.Constants;
import fiftyone.pipeline.engines.data.AspectPropertyValue;
public class GettingStarted extends ProgramBase {
public static void main(String[] args) throws Exception {
String dataFile = args.length > 0 ? args[0] :
getDefaultFilePath("51Degrees-LiteV4.1.hash").getAbsolutePath();
new Example(true).run(dataFile);
System.out.println("Complete. Press enter to exit.");
System.in.read();
}
public static class Example extends ExampleBase {
private final String mobileUserAgent =
"Mozilla/5.0 (iPhone; CPU iPhone OS 7_1 like Mac OS X) " +
"AppleWebKit/537.51.2 (KHTML, like Gecko) Version/7.0 Mobile" +
"/11D167 Safari/9537.53";
public Example(boolean printOutput) {
super(printOutput);
}
public void run(String dataFile) throws Exception {
println("Constructing pipeline with engine " +
"from file " + dataFile);
// Build the device detection pipeline using the builder that comes with the
// fiftyone.devicedetection package and pass in the desired settings. Additional
// flow elements / engines can be added before the build() method is called if
// needed.
Pipeline pipeline = new DeviceDetectionPipelineBuilder()
.useOnPremise(dataFile, false)
//.setShareUsage(false)
// Prefer low memory profile where all data streamed
// from disk on-demand. Experiment with other profiles.
//.setPerformanceProfile(Constants.PerformanceProfiles.HighPerformance)
.setPerformanceProfile(Constants.PerformanceProfiles.LowMemory)
//.setPerformanceProfile(Constants.PerformanceProfiles.Balanced)
.build();
// A pipeline can create a flow data element which is where evidence is added
// (for example from a device web request). This evidence is then processed by
// the pipeline through the flow data's `process()` method.
FlowData data = pipeline.createFlowData();
data.addEvidence(
"header.user-agent",
mobileUserAgent)
.process();
// Here is an example of a function that checks if a User-Agent is a mobile
// device. In some cases the IsMobile value is not meaningful so instead of
// returning a default, a .hasValue() check can be made.
AspectPropertyValue<Boolean> isMobile = data.get(DeviceData.class).getIsMobile();
if (isMobile.hasValue()) {
println("IsMobile: " + isMobile.getValue());
}
else {
println(isMobile.getNoValueMessage());
}
}
}
}