com.scientiamobile.wurfl.wmclient

Class WmClient

java.lang.Object

com.scientiamobile.wurfl.wmclient.WmClient

public class WmClient
extends java.lang.Object

Main class for Java WM client. Performs requests to WURFL Microservice server and handles response.
Author(s): Andrea Castello Date: 19/07/2017.

Method Summary

Methods

Modifier and Type	Method and Description
static WmClient	create(java.lang.String scheme, java.lang.String host, java.lang.String port, java.lang.String baseURI) Creates an instance of a WURFL Microservice client
void	destroyConnection() Deallocates all resources used by client.
int[]	getActualCacheSizes()
java.lang.String[]	getAllDeviceMakes()
Model.JSONModelMktName[]	getAllDevicesForMake(java.lang.String make)
Model.JSONMakeModel[]	getAllMakeModel() Deprecated. since version 1.2.0.0 Use getAllDeviceMakes and getAllDevicesForMake(String make) instead
java.lang.String[]	getAllOSes()
java.lang.String[]	getAllVersionsForOS(java.lang.String osName) returns a slice
java.lang.String	getApiVersion()
java.lang.String[]	getImportantHeaders()
Model.JSONInfoData	getInfo()
java.lang.String[]	getStaticCaps()
java.lang.String[]	getVirtualCaps()
boolean	hasStaticCapability(java.lang.String capName)
boolean	hasVirtualCapability(java.lang.String capName)
Model.JSONDeviceData	lookupDeviceId(java.lang.String wurflId) Returns the device matching the given WURFL ID
Model.JSONDeviceData	lookupRequest(javax.servlet.http.HttpServletRequest httpRequest) Performs a device detection using an HTTP request object, as passed from Java Web applications
Model.JSONDeviceData	lookupUseragent(java.lang.String useragent) Performs a device detection against a user agent header
void	setCacheSize(int uaMaxEntries) Sets the client cache size
void	setRequestedCapabilities(java.lang.String[] capsList)
void	setRequestedStaticCapabilities(java.lang.String[] capsList)
void	setRequestedVirtualCapabilities(java.lang.String[] vcapsList)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static WmClient create(java.lang.String scheme,
              java.lang.String host,
              java.lang.String port,
              java.lang.String baseURI)
                       throws WmException

Creates an instance of a WURFL Microservice client

Parameters:

scheme - protocol scheme

host - host of the WM server

port - port of the WM server

baseURI - any base URI which must be added after the host (NOT including the endpoints, which are handled by the client). This may be useful, for example, with thrird parties VMs (like docker or AWS). Leave empty or null if not needed.

Returns:

The instance of the WM client

Throws:

WmException - In case a connection error occurs

getInfo

public Model.JSONInfoData getInfo()
                           throws WmException

Returns:

A JSONInfoData instance holding the capabilities exposed from WM server, the headers used for device detection, WURFL file and API version

Throws:

WmException - If server cannot send data or incomplete data are sent

getAllMakeModel

@Deprecated
public Model.JSONMakeModel[] getAllMakeModel()
                                      throws WmException

Deprecated. since version 1.2.0.0 Use getAllDeviceMakes and getAllDevicesForMake(String make) instead

Returns:

An array of JSONMakeModel structures, holding brand, model and marketing name of all devices handled by WM server.

Throws:

WmException - In case a connection error occurs or malformed data are sent

getAllDeviceMakes

public java.lang.String[] getAllDeviceMakes()
                                     throws WmException

Returns:

GetAllDeviceMakes returns a string array of all devices brand_name capabilities in WM server

Throws:

WmException - In case a connection error occurs or malformed data are sent

getAllDevicesForMake

public Model.JSONModelMktName[] getAllDevicesForMake(java.lang.String make)
                                              throws WmException

Parameters:

make - a brand name

Returns:

An array of Model.JSONModelMktName that contain values for model_name and marketing_name (the latter, if available).

Throws:

WmException - In case a connection error occurs, malformed data are sent, or the given brand name parameter does not exist in WM server.

getAllOSes

public java.lang.String[] getAllOSes()
                              throws WmException

Returns:

an array of all devices device_os capabilities in WM server

Throws:

WmException - In case a connection error occurs or malformed data are sent

getAllVersionsForOS

public java.lang.String[] getAllVersionsForOS(java.lang.String osName)
                                       throws WmException

returns a slice

Parameters:

osName - a device OS name

Returns:

an array containing device_os_version for the given os_name

Throws:

WmException

lookupUseragent

public Model.JSONDeviceData lookupUseragent(java.lang.String useragent)
                                     throws WmException

Performs a device detection against a user agent header

Parameters:

useragent - a user agent header

Returns:

An object containing the device capabilities

Throws:

WmException - In case any error occurs during device detection

lookupDeviceId

public Model.JSONDeviceData lookupDeviceId(java.lang.String wurflId)
                                    throws WmException

Returns the device matching the given WURFL ID

Parameters:

wurflId - a WURFL device identifier

Returns:

An object containing the device capabilities

Throws:

WmException - In case any error occurs

lookupRequest

public Model.JSONDeviceData lookupRequest(javax.servlet.http.HttpServletRequest httpRequest)
                                   throws WmException

Performs a device detection using an HTTP request object, as passed from Java Web applications

Parameters:

httpRequest - an instance of HTTPServletRequest

Returns:

An object containing the device capabilities

Throws:

WmException - In case any error occurs during device detection

setRequestedStaticCapabilities

public void setRequestedStaticCapabilities(java.lang.String[] capsList)

setRequestedVirtualCapabilities

public void setRequestedVirtualCapabilities(java.lang.String[] vcapsList)

hasStaticCapability

public boolean hasStaticCapability(java.lang.String capName)

Parameters:

capName - capability name

Returns:

true if the given static capability is handled by this client, false otherwise

hasVirtualCapability

public boolean hasVirtualCapability(java.lang.String capName)

Parameters:

capName - capability name

Returns:

true if the given virtual capability is handled by this client, false otherwise

setRequestedCapabilities

public void setRequestedCapabilities(java.lang.String[] capsList)

destroyConnection

public void destroyConnection()
                       throws WmException

Deallocates all resources used by client. All subsequent usage of client will result in a WmException (you need to create the client again with a call to WmClient.create().

Throws:

WmException - In case of closing connection errors.

getStaticCaps

public java.lang.String[] getStaticCaps()

Returns:

All static capabilities handled by this client

getVirtualCaps

public java.lang.String[] getVirtualCaps()

Returns:

All the virtual capabilities handled by this client

getImportantHeaders

public java.lang.String[] getImportantHeaders()

Returns:

list all HTTP headers used for device detection by this client

setCacheSize

public void setCacheSize(int uaMaxEntries)

Sets the client cache size

Parameters:

uaMaxEntries - maximum cache dimension

getApiVersion

public java.lang.String getApiVersion()

Returns:

This client API version

getActualCacheSizes

public int[] getActualCacheSizes()