mobi.mtld.da.device

Class Config

java.lang.Object

mobi.mtld.da.device.Config

All Implemented Interfaces:

java.lang.Cloneable

public class Config
extends java.lang.Object
implements java.lang.Cloneable

DeviceApi Configurations. To change the default configs of the DeviceAtlas DeviceApi create an instance of this class, set your preferred configs and pass the instance to the constructor of a DeviceApi or DeviceApiWeb. Note that you may change the configs even after the Config instance has been passed to the DeviceApi.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_COOKIE_NAME The default cookie name that the client side properties would be set to.
static boolean	DEFAULT_INCLUDE_LANG_PROPS The default config value for getProperties(HEADERS) or getProperties(REQUEST) to check the Accept-Language header and include properties to the property set for getting client's language and locale preferences.
static boolean	DEFAULT_INCLUDE_MATCH_INFO The default config value for getProperties() to include the matched and unmatched parts of the User-Agent to the property set.
static boolean	DEFAULT_INCLUDE_UA_PROPS The default config value for getProperties() to include User-Agent dynamic properties.
static int	DEFAULT_MAX_CACHE_ENTRIES The default config value for result (Properties object) caching.
static boolean	DEFAULT_RETURN_NULL_WHEN_NO_PROPERTIES The default config value for getProperties() return value when there was no properties found.

Constructor Summary

Constructors

Constructor and Description
Config()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCookieName() Get the cookie name that the client side properties would be set to.
boolean	getIncludeLangProps() Get if the language/locale properties are being included in the property set or not.
boolean	getIncludeMatchInfo() To get if getProperties() include the matched and unmatched parts of the User-Agent to the property set.
boolean	getIncludeUaProps() Get if the User-Agent dynamic properties are being included in the property set or not.
int	getMaxCacheEntries() Get the max number of results to be cached.
boolean	getReturnNullWhenNoProperties() Get if the value returned by getProperties() should be null when there are no properties found or an instance of Properties that has no Property inside it should be returned.
void	setCookieName(java.lang.String cookieName) To change the cookie name that the client side properties would be set to.
void	setIncludeLangProps(boolean includeLangProps) To disable or enable getProperties(HEADERS) or getProperties(REQUEST) including language and locale properties.
void	setIncludeMatchInfo(boolean includeMatchInfo) To disable or enable getProperties() including the matched and unmatched parts of the User-Agent to the property set.
void	setIncludeUaProps(boolean includeUaProps) To disable or enable getProperties() including User-Agent dynamic properties.
void	setMaxCacheEntries(int maxCacheEntries) Set the max number of results to be cached.
void	setReturnNullWhenNoProperties(boolean returnNullWhenNoProperties) Set if the value returned by the getProperties() method should be null when there are no properties found or whether an empty Properties object should be returned instead.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_COOKIE_NAME

public static final java.lang.String DEFAULT_COOKIE_NAME

The default cookie name that the client side properties would be set to. When using getProperties() on a servlet container, the detection would automatically use the contents of this cookie if it exists. If you want the client side properties to be used add the DeviceAtlas Client-side component (JS lib) to your web-site pages.

See Also:

Constant Field Values

DEFAULT_INCLUDE_UA_PROPS

public static final boolean DEFAULT_INCLUDE_UA_PROPS

The default config value for getProperties() to include User-Agent dynamic properties.

See Also:

Constant Field Values

DEFAULT_INCLUDE_LANG_PROPS

public static final boolean DEFAULT_INCLUDE_LANG_PROPS

The default config value for getProperties(HEADERS) or getProperties(REQUEST) to check the Accept-Language header and include properties to the property set for getting client's language and locale preferences.

See Also:

Constant Field Values

DEFAULT_INCLUDE_MATCH_INFO

public static final boolean DEFAULT_INCLUDE_MATCH_INFO

The default config value for getProperties() to include the matched and unmatched parts of the User-Agent to the property set.

See Also:

Constant Field Values

DEFAULT_RETURN_NULL_WHEN_NO_PROPERTIES

public static final boolean DEFAULT_RETURN_NULL_WHEN_NO_PROPERTIES

The default config value for getProperties() return value when there was no properties found. true = if no properties found then return null, false = if no properties found then return an instance of Properties with no Property inside it.

See Also:

Constant Field Values

DEFAULT_MAX_CACHE_ENTRIES

public static final int DEFAULT_MAX_CACHE_ENTRIES

The default config value for result (Properties object) caching. Depending on the frequency and distance factor of your user-agents or headers passed to the API for detection the result cache may increase performance by preventing repeated lookups.

See Also:

Constant Field Values

Constructor Detail

Config

public Config()

Method Detail

setCookieName

public void setCookieName(java.lang.String cookieName)

To change the cookie name that the client side properties would be set to. When using getProperties() on a servlet container, the detection would automatically use the contents of this cookie if it exists. If you want the client side properties to be used add the DeviceAtlas Client-side component (JS lib) to your web-site pages.
When the user-agent or HTTP headers are set manually to getProperties() the client side properties (probably the value set to the cookie) can be manually passed to this method as the second argument, note that this config is only used for getProperties(REQUEST-OBJECT). If you set the cookie-name to null then the client side properties cookie will be ignored.

Parameters:

cookieName - The cookie name which the client side properties are set to. Set to null to turn off using client side properties.

getCookieName

public java.lang.String getCookieName()

Get the cookie name that the client side properties would be set to. When using getProperties() on a servlet container, the detection would automatically use the contents of this cookie if it exists. If you want the client side properties to be used add the DeviceAtlas Client-side component (JS lib) to your web-site pages.
When the User-Agent or HTTP headers are set manually to getProperties() the client side properties (probably the value set to the cookie) can be manually passed to this method as the second argument, note that this config is only used for getProperties(REQUEST-OBJECT).

Returns:

The cookie name which the client side properties are set to

setIncludeUaProps

public void setIncludeUaProps(boolean includeUaProps)

To disable or enable getProperties() including User-Agent dynamic properties. Some properties cannot be known before runtime and can change from User-Agent to User-Agent. The most common of these are the OS Version and the Browser Version. The DeviceApi is able to dynamically detect these changing properties with a small overhead. If you do not use these properties you can set this config to false to make the detection marginally faster.

Parameters:

includeUaProps - True=include

getIncludeUaProps

public boolean getIncludeUaProps()

Get if the User-Agent dynamic properties are being included in the property set or not.

Returns:

true or false

setIncludeLangProps

public void setIncludeLangProps(boolean includeLangProps)

To disable or enable getProperties(HEADERS) or getProperties(REQUEST) including language and locale properties. To check the Accept-Language header and include properties to the property set for getting the client's language and locale preferences set to true. If you do not use these properties you can set this config to false to make the detection marginally faster.

Parameters:

includeLangProps - true=include

getIncludeLangProps

public boolean getIncludeLangProps()

Get if the language/locale properties are being included in the property set or not.

Returns:

true or false

setIncludeMatchInfo

public void setIncludeMatchInfo(boolean includeMatchInfo)

To disable or enable getProperties() including the matched and unmatched parts of the User-Agent to the property set.

Parameters:

includeMatchInfo - true=include

getIncludeMatchInfo

public boolean getIncludeMatchInfo()

To get if getProperties() include the matched and unmatched parts of the User-Agent to the property set.

Returns:

true or false

setReturnNullWhenNoProperties

public void setReturnNullWhenNoProperties(boolean returnNullWhenNoProperties)

Set if the value returned by the getProperties() method should be null when there are no properties found or whether an empty Properties object should be returned instead.

Parameters:

returnNullWhenNoProperties - true = return null on empty

getReturnNullWhenNoProperties

public boolean getReturnNullWhenNoProperties()

Get if the value returned by getProperties() should be null when there are no properties found or an instance of Properties that has no Property inside it should be returned.

Returns:

true or false

setMaxCacheEntries

public void setMaxCacheEntries(int maxCacheEntries)

Set the max number of results to be cached. Depending on the frequency and distance factor of your User-Agents or headers passed to the API for detection, increasing the result cache may increase performance by preventing repeated lookups. For a large set of inputs (i.e. an almost unique set of user-agents) set to lower numbers or o to disable.

Parameters:

maxCacheEntries -

getMaxCacheEntries

public int getMaxCacheEntries()

Get the max number of results to be cached.

Returns:

maxCacheEntries