Device Recognition is configured with an XML module called the Device Identification Module. This XML module is loaded by Tinak from a URL defined in the webapp deployment descriptor as described in the J2EE Deployment section.
Module DTD
The module DTD can be viewed as a reference here.
Module Elements
The module root element is the device-ident element. The device-ident element contains one or more device elements. The device element contains one or more http-req-header or http-req-param elements.
The http-req-header and http-req-param elements define the Device Identification Unit patterns to match a requesting device. Both elements have the same attributes:
| Attribute | Description | Required |
|---|---|---|
| id | The id attribute is a named identifier (unique) for the identification unit. It allows the Identification Unit to be referenced by the match attribute on the device element (parent element). If no id attribute is defined, a pseudo value is applied based on the index of the Identification Unit i.e. first=1, second=2 etc. | No |
| name | The name of the HTTP request header (http-req-header) or parameter (http-req-param). | Yes |
| value | The Regular Expression value of the HTTP request header/parameter to be matched. | Yes |
The device element is the core element of the module. It contains the recognition patterns for a named device (http-req-header and/or http-req-param). The device element has the following attribute definition:
| Attribute | Description | Required |
|---|---|---|
| name | The name attribute defines the unique name of the device within the module. | Yes |
| match | The match attribute defines which enclosed Identification Units (http-req-header and/or http-req-param) need to be matched in order to make a positive match on a requesting device. The Identification Units are referenced by their id attribute value. This attribute can have the following values:
|
No |
The device-ident element has no attributes.
Handling Special XML Characters
In all cases, attribute value characters can be represented using entity/character references.
An Example Module
A sample module can be referenced here.
