This example is available in full on GitHub.

To run this example, you will need to create a resource key. The resource key is used as shorthand to store the particular set of properties you are interested in as well as any associated license keys that entitle you to increased request limits and/or paid-for properties.

You can create a resource key using the 51Degrees Configurator.

Overview

The PipelineFilter to intercept requests and perform device detection. The results will be stored in the HttpServletRequest object. The filter will also handle setting response headers (e.g. Accept-CH for User-Agent Client Hints) and serving requests for client-side JavaScript and JSON resources.

The results of detection can be accessed by using a FlowDataProvider which is responsible for managing the lifecycle of the flowData - do NOT dispose

FlowData flowData = flowDataProvider.getFlowData(request);

DeviceData device = flowData.get(DeviceData.class);

...

Results can also be accessed in client-side code by using the fod object.

window.onload = function () {

fod.complete(function(data) {

var hardwareName = data.device.hardwarename;

alert(hardwareName.join(", "));

}

package fiftyone.devicedetection.examples.web;

import fiftyone.devicedetection.shared.DeviceData;

import fiftyone.pipeline.core.data.FlowData;

import fiftyone.pipeline.web.Constants;

import fiftyone.pipeline.web.services.FlowDataProviderCore;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

import javax.servlet.http.HttpServlet;

import javax.servlet.http.HttpServletRequest;

import javax.servlet.http.HttpServletResponse;

import java.io.PrintWriter;

import static fiftyone.common.testhelpers.LogbackHelper.configureLogback;

import static fiftyone.devicedetection.examples.shared.ResourceKeyHelper.getOrSetTestResourceKey;

import static fiftyone.devicedetection.examples.web.HtmlContentHelper.*;

import static fiftyone.pipeline.util.FileFinder.getFilePath;

public class GettingStartedWebCloud extends HttpServlet {

private static final long serialVersionUID = 1734154705981153540L;

public static String resourceBase = "device-detection.examples/web/getting-started.cloud/src/main/webapp";

public static Logger logger = LoggerFactory.getLogger(GettingStartedWebCloud.class);

public static void main(String[] args) throws Exception {

configureLogback(getFilePath("logback.xml"));

String resourceKey = args.length > 0 ? args[0] : null;

logger.info("Running Example {}", GettingStartedWebCloud.class);

// check resource key and set as System Property

getOrSetTestResourceKey(resourceKey);

// start Jetty with this WebApp

EmbedJetty.runWebApp(resourceBase, 8081);

}

FlowDataProviderCore flowDataProvider = new FlowDataProviderCore.Default();

protected void processRequest(HttpServletRequest request, HttpServletResponse response)

throws Exception {

// the detection has already been carried out by the Filter

// which is responsible to the lifecycle of the flowData - do NOT dispose

FlowData flowData = flowDataProvider.getFlowData(request);

// retrieve the device data from the flowdata

DeviceData device = flowData.get(DeviceData.class);

response.setContentType("text/html;charset=UTF-8");

try (PrintWriter out = response.getWriter()) {

doHtmlPreamble(out, "Web Integration Cloud Example");

// request main 51Degrees Client Side Script - this is automatically

// served by inclusion of the PipelineFilter which intercepts the request

// and serves dynamically generated JavaScript

out.println("<script src=\"" + Constants.CORE_JS_NAME+ "\"></script>");

// include description of example

doStaticText(out, resourceBase + "/WEB-INF/html/example-description.html");

// include a script to display the results of the client side detection

doStaticText(out, resourceBase + "/WEB-INF/html/client-side-js-include.html");

doDeviceData(out, device, flowData, null);

doStaticText(out, resourceBase + "/WEB-INF/html/apple-detection.html");

doEvidence(out, request, flowData);

doResponseHeaders(out, response);

doHtmlPostamble(out);

}

@Override

protected void doGet(HttpServletRequest request, HttpServletResponse response) {

// any failure causes 500 error

try {

processRequest(request, response);

response.setStatus(200);

} catch (Exception e) {

e.printStackTrace();

response.setStatus(500);

}

51Degrees Device Detection Java 4.4

GettingStartedWebCloud.java

Overview