51Degrees Device Detection Java  4.1

Device detection services for 51Degrees Pipeline

mvc/configuration/ExampleMvcConfig.java

Spring MVC device detection exampleThis example shows how to:

  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  </Elements>
    20 </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  </Elements>
17 </PipelineOptions>
  1. Set up MVC, enable configuration, and add the Pipeline component.
    @EnableWebMvc
    @Configuration
    @ComponentScan({"fiftyone.pipeline.web.examples.mvc.controller","fiftyone.pipeline.web.mvc"})
    public class ExampleMvcConfig extends WebMvcConfigurerAdapter {
    ...
  2. Configure the interceptor.
    public class ExampleMvcConfig extends WebMvcConfigurerAdapter {
    ...
    @Bean
    public FiftyOneInterceptorConfig fiftyOneInterceptorConfig() {
    final FiftyOneInterceptorConfigDefault bean = new FiftyOneInterceptorConfigDefault();
    bean.setDataFilePath(servletContext.getRealPath("/WEB-INF/51Degrees-Cloud.xml"));
    bean.setClientsidePropertiesEnabled(true);
    return bean;
    }
    ...
  3. Enable client-side code to improve detection accuracy on devices like iPhones.
    public class ExampleMvcConfig extends WebMvcConfigurerAdapter {
    ...
    @Override
    public void addViewControllers(final ViewControllerRegistry registry) {
    enableClientsideProperties(registry);
    }
    ...
  4. Add the interceptor.
    public class ExampleMvcConfig extends WebMvcConfigurerAdapter {
    ...
    @Autowired
    FiftyOneInterceptor fiftyOneInterceptor;
    @Override
    public void addInterceptors(final InterceptorRegistry registry) {
    registry.addInterceptor(fiftyOneInterceptor);
    }
    ...
  5. Inject the FlowDataProvider into a controller.
    @Controller
    @RequestMapping("/")
    public class ExampleController {
    private FlowDataProvider flowDataProvider;
    @Autowired
    public ExampleController(FlowDataProvider flowDataProvider) {
    this.flowDataProvider = flowDataProvider;
    }
    ...
  6. Use the results contained in the flow data to display something on a page view.
    @Controller
    @RequestMapping("/")
    public class ExampleController {
    ...
    @RequestMapping(method = RequestMethod.GET)
    public String get(ModelMap model, HttpServletRequest request) {
    FlowData data = flowDataProvider.getFlowData(request);
    DeviceData device = data.get(DeviceData.class);
    model.addAttribute("browser", device.getBrowserVendor() + " " + device.getBrowserName() + " " + device.getBrowserVersion());
    model.addAttribute("device", device.getHardwareVendor() + " " + device.getHardwareName());
    model.addAttribute("os", device.getPlatformVendor() + " " + device.getPlatformName() + " " + device.getPlatformVersion());
    return "example";
    }
    ...

    Controller

/* *********************************************************************
* 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.web.examples.mvc.controller;
import fiftyone.devicedetection.shared.DeviceData;
import fiftyone.pipeline.core.data.FlowData;
import fiftyone.pipeline.jsonbuilder.data.JsonBuilderData;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.ui.ModelMap;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import fiftyone.pipeline.web.mvc.components.FlowDataProvider;
import javax.servlet.http.HttpServletRequest;
@Controller
@RequestMapping("/")
public class ExampleController {
private FlowDataProvider flowDataProvider;
@Autowired
public ExampleController(FlowDataProvider flowDataProvider) {
this.flowDataProvider = flowDataProvider;
}
@RequestMapping(method = RequestMethod.GET)
public String get(ModelMap model, HttpServletRequest request) {
FlowData data = flowDataProvider.getFlowData(request);
DeviceData device = data.get(DeviceData.class);
model.addAttribute("hardwareVendor", device.getHardwareVendor());
model.addAttribute("hardwareName", device.getHardwareName());
model.addAttribute("deviceType", device.getDeviceType());
model.addAttribute("platformVendor", device.getPlatformVendor());
model.addAttribute("platformName", device.getPlatformName());
model.addAttribute("platformVersion", device.getPlatformVersion());
model.addAttribute("browserVendor", device.getBrowserVendor());
model.addAttribute("browserName", device.getBrowserName());
model.addAttribute("browserVersion", device.getBrowserVersion());
return "example";
}
}

Config

/* *********************************************************************
* 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.web.examples.mvc.configuration;
import fiftyone.pipeline.web.mvc.components.FiftyOneInterceptor;
import fiftyone.pipeline.web.mvc.configuration.FiftyOneInterceptorConfig;
import fiftyone.pipeline.web.mvc.configuration.FiftyOneInterceptorConfigDefault;
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.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.ViewControllerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
import org.springframework.web.servlet.view.InternalResourceViewResolver;
import org.springframework.web.servlet.view.JstlView;
import javax.servlet.ServletContext;
import static fiftyone.pipeline.web.mvc.components.FiftyOneInterceptor.enableClientsideProperties;
@EnableWebMvc
@Configuration
@ComponentScan({"fiftyone.pipeline.web.examples.mvc.controller","fiftyone.pipeline.web.mvc"})
public class ExampleMvcConfig extends WebMvcConfigurerAdapter {
public ExampleMvcConfig() {
super();
}
@Override
public void addViewControllers(final ViewControllerRegistry registry) {
enableClientsideProperties(registry);
}
@Autowired
ServletContext servletContext;
@Bean
public FiftyOneInterceptorConfig fiftyOneInterceptorConfig() {
final FiftyOneInterceptorConfigDefault bean = new FiftyOneInterceptorConfigDefault();
bean.setDataFilePath(servletContext.getRealPath("/WEB-INF/51Degrees-Cloud.xml"));
bean.setClientsidePropertiesEnabled(true);
return bean;
}
@Bean
public ViewResolver viewResolver() {
final InternalResourceViewResolver bean = new InternalResourceViewResolver();
bean.setViewClass(JstlView.class);
bean.setPrefix("/WEB-INF/views/");
bean.setSuffix(".jsp");
return bean;
}
@Autowired
FiftyOneInterceptor fiftyOneInterceptor;
@Override
public void addInterceptors(final InterceptorRegistry registry) {
registry.addInterceptor(fiftyOneInterceptor);
}
}