Skip to content

Latest commit

 

History

History
102 lines (75 loc) · 7.15 KB

README.md

File metadata and controls

102 lines (75 loc) · 7.15 KB
Raw

51Degrees Device Detection Engines - Examples

51Degrees Java Device Detection

Developer Documentation

Introduction

These examples are not distributed as maven jars and need to be built by you.

This project contains sub-modules - console, giving examples that are intended to be run from the command line/console and web, illustrating use of 51Degrees Web/Servlet integration. There is also a shared sub-module containing various helpers for the examples.

Among other things, the examples illustrate:

  • use of the fluent builder to configure a pipeline
  • use of a configuration options file to configure a pipeline
  • use of the cloud device detection service
  • use of the on-premise "hash" device detection service
  • use of device detection pipeline for off-line processing tasks
  • configuring device detection trade-offs between speed and conserving memory

Cloud resource keys

You will require resource keys to use the Cloud API, as described on our website. Get resource keys from our configurator, see our documentation on how to use this.

A resource key configured with the properties needed to run most of the examples can be obtained here. To use the resource key in the example it can be supplied as a command line parameter, pasted into the configuration file (where there is one) or supplied as either an environment variable or a system property called "TestResourceKey".

Some cloud examples require an enhanced resource key containing a license key. And some on-premise examples require you to provide a license key. You can find out about resource keys and license keys at our pricing page.

Running examples with changes to Pipeline packages

A common use case is to make a change to the Pipeline logic in device-detection-java and then use these examples to observe the results of the change.

By default, the examples are configured to use the packages from Maven central. In order to produce and use local packages instead:

  • Clone and make your changes to device-detection-java
  • Set the version of the device detection packages that we're going to create to 0.0.0: mvn versions:set-property -Dproperty="project.version" "-DnewVersion=0.0.0"
  • Create and install the packages locally (skipping tests is needed): mvn clean install [-DskipTests]
  • Modify the POM for the examples to reference these new local packages. This can be done by editing the POM directly or by using the command line: mvn versions:set-property -Dproperty="device-detection.version" "-DnewVersion=0.0.0"

The same principle can be applied to incorporate changes in pipeline-java if needed.

Examples

The tables below describe the examples available in this repository.

Cloud

Example Description
GettingStarted (Console) How to use the 51Degrees Cloud service to determine details about a device based on its User-Agent and User-Agent Client Hints HTTP header values.
GettingStarted (Web) How to use the 51Degrees Cloud service to determine details about a device as part of a simple Java servlet website.
Metadata How to access the meta-data that relates to things like the properties populated device detection
TacLookup How to get device details from a TAC (Type Allocation Code) using the 51Degrees cloud service.
NativeModelLookup How to get device details from a native model name using the 51Degrees cloud service.

On-Premise

Example Description
GettingStarted (Console) How to use the 51Degrees on-premise device detection API to determine details about a device based on its User-Agent and User-Agent Client Hints HTTP header values.
GettingStarted (Web) How to use the 51Degrees Cloud service to determine details about a device as part of a simple Java servlet website.
Metadata How to access the meta-data that relates to things like the properties populated device detection.
MatchMetrics How to view metrics associated with the properties of processing with a Device Detection engine.
OfflineProcessing Example showing how to ingest a file containing data from web requests and perform detection against the entries.
PerformanceBenchmark How to configure the various performance options and run some simple performance tests.
UpdateOnStartup How to configure the Pipeline to automatically update the device detection data file on startup. Also illustrates 'file watcher'. This will refresh the device detection engine if the specified data file is updated on disk.

Running built examples from command line

Running

mvn package

will produce "fat" JARs inside target subfolders.

Use them with relevant example class entrypoints like:

java -cp .\console\target\device-detection-java-examples.console-4.4.20-jar-with-dependencies.jar fiftyone.devicedetection.examples.console.OfflineProcessing