51Degrees Device Detection Java  4.3

Device detection services for 51Degrees Pipeline


Spring MVC User Agent Client Hints-Manual example.In this scenario, the standard Pipeline API web integration is not used. This means that several jobs that the API usually takes care of automatically must be handled manually. For example, setting the HTTP response headers to request user-agent client hints.

The source code for this example is available in full on GitHub.

This example can be configured to use the 51Degrees cloud service or a local data file. If you don't already have data file you can obtain one from the device-detection-data GitHub repository.

To use the cloud service you will need to create a resource key. The resource key is used as short-hand 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.

  1. Set up configuration options to add elements to the 51Degrees Pipeline.
    1 <PipelineOptions>
    2  <Elements>
    3  <Element>
    4  <BuildParameters>
    5  <EndPoint>https://cloud.51degrees.com/api/v4</EndPoint>
    6  <!-- Obtain a resource key for free at
    7  https://configure.51degrees.com
    8  Make sure to include the 'BrowserName','BrowserVendor',
    9  'BrowserVersion','HardwareName','HardwareVendor',
    10  'PlatformName','PlatformVendor','PlatformVersion'
    11  properties as they are used by this example. -->
    12  <ResourceKey>!!YOUR_RESOURCE_KEY!!</ResourceKey>
    13  </BuildParameters>
    14  <BuilderName>CloudRequestEngine</BuilderName>
    15  </Element>
    16  <Element>
    17  <BuilderName>DeviceDetectionCloudEngine</BuilderName>
    18  </Element>
    19  <Element>
    20  <BuilderName>SetHeadersElement</BuilderName>
    21  </Element>
    22  </Elements>
    23 </PipelineOptions>

Alternatively, to use the on-premise API with automatic updates enabled, replace the cloud element in the config with the new configuration.

1 <PipelineOptions>
2  <Elements>
3  <Element>
4  <BuildParameters>
5  <AutoUpdate>true</AutoUpdate>
6  <DataFileSystemWatcher>false</DataFileSystemWatcher>
7  <CreateTempDataCopy>true</CreateTempDataCopy>
8  <!-- Obtain your own license key and enterprise data file
9  from https://51degrees.com. -->
10  <DataUpdateLicenseKey>[[Your License Key]]</DataUpdateLicenseKey>
11  <DataFile>D:\[[Path to data file]]\51Degrees-EnterpriseV4.1.hash</DataFile>
12  <PerformanceProfile>LowMemory</PerformanceProfile>
13  </BuildParameters>
14  <BuilderName>DeviceDetectionHashEngineBuilder</BuilderName>
15  </Element>
16  <Element>
17  <BuilderName>SetHeadersElement</BuilderName>
18  </Element>
19  </Elements>
20 </PipelineOptions>
  1. Set up MVC, enable configuration, Add builders and the Pipeline to the Controller.
// Create the configuration object from an XML file
ServletContext context = request.getSession().getServletContext();
File configFile = new File(context.getRealPath("/WEB-INF/51Degrees-Hash.xml"));
JAXBContext jaxbContext = JAXBContext.newInstance(PipelineOptions.class);
Unmarshaller unmarshaller = jaxbContext.createUnmarshaller();
PipelineOptions options = (PipelineOptions) unmarshaller.unmarshal(configFile);
// Build a new Pipeline from the configuration.
Pipeline pipeline = new FiftyOnePipelineBuilder()
  1. Process the request, set response headers and send the results to the view.
// Create an instance of WebRequestEvidenceServiceCore and Set evidence
// from HTTP request headers to flowData
WebRequestEvidenceServiceCore evidenceService = new WebRequestEvidenceServiceCore.Default();
evidenceService.addEvidenceFromRequest(flowData, request);
// Create an instance of UACHServiceCore and Set UACH response headers.
UACHServiceCore uachServiceCore = new UACHServiceCore.Default();
uachServiceCore.setResponseHeaders(flowData, (HttpServletResponse)response);
  1. Display device details in the view.
<strong>Detection results:</strong><br /><br />
Hardware Vendor: ${hardwareVendor.hasValue() ? hardwareVendor.getValue() : "Unknown: ".concat(hardwareVendor.getNoValueMessage())}<br />
/* *********************************************************************
* 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.pipeline.uachmanual.examples.mvc.configuration;
import javax.servlet.ServletContext;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.ViewResolver;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
import org.springframework.web.servlet.view.InternalResourceViewResolver;
import org.springframework.web.servlet.view.JstlView;
public class UACHManualExampleMvcConfig extends WebMvcConfigurerAdapter {
public UACHManualExampleMvcConfig() {
ServletContext servletContext;
public ViewResolver viewResolver() {
final InternalResourceViewResolver bean = new InternalResourceViewResolver();
return bean;