fiftyone.mobile.detection

Class AutoUpdate

java.lang.Object

fiftyone.mobile.detection.AutoUpdate

public class AutoUpdate
extends Object

Used to fetch new device data from 51Degrees if a Premium or Enterprise licence key is available.

Requires a valid 51Degrees licence key and read/write access to the file system folder where the downloaded file should be written.

Class only pulls the data file once per invocation and has no concept of the environment. For a sample implementation please see the AutoUpdate class in the 'Webapp' package.

When implementing custom auto updates keep in mind the following points:

• You need a licence key for the automatic update to work, get a licence key.
• You need to implement two timers. The first timer should wake up the second timer when the next update is ready (see below). The second timer should attempt to download the data file by calling one of the update functions in this class.

  Please note that auto update will return a status code. If the status code is AUTO_UPDATE_SUCCESS then no further actions required, if the status code is AUTO_UPDATE_NOT_NEEDED then no newer data is currently available. All other codes indicate there is a problem with the update.

• If you are using Stream mode you should not invoke automatic update with the same file path as the one used for constructing the stream data set. Stream data set retains a file lock on the underlying file to perform detection lookups and the auto update will fail to replace the data file. Use a copy of the master file for device detection while leaving the master data file free of locks.
• Each data file (including 'Lite') contains a date when the next data file will be released which can be accessed like: dataset.nextUpdate;. The next update date is set by 51Degrees when the data file gets generated. Use this date to avoid unnecessary automatic update requests.
• A licence key may be blacklisted, preventing further automatic updates if we see excessive amount of traffic (i.e., if the amount of update requests from your Web site or project becomes so large that it starts to cause the quality of service to deteriorate for other clients).

  If your key is blacklisted the update server will respond with 403 Forbidden. Please contact 51Degrees as soon as possible. We will not blacklist your key without contacting you first.

Constructor Summary

Constructors

Constructor and Description
AutoUpdate()

Method Summary

Modifier and Type	Method and Description
static URL	fullUrl(String[] licenseKeys) Constructs the URL needed to download Enhanced device data.
static Dataset	getDataSetWithHeaderLoaded(File binaryFile) Provides access to the header fields of a data set.
static AutoUpdateStatus	update(String[] licenseKeys, String binaryFilePath) Uses the given license keys to perform a device data update, writing the data to the file system and filling providers from this factory instance with it.
static AutoUpdateStatus	update(String licenseKey, String dataFilePath) Uses the given license key to perform a device data update, writing the data to the file system and filling providers from this factory instance with it.

Methods inherited from class java.lang.Object

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

Constructor Detail

AutoUpdate

public AutoUpdate()

Method Detail

update

public static AutoUpdateStatus update(String licenseKey,
                                      String dataFilePath)
                               throws FileNotFoundException,
                                      NoSuchAlgorithmException,
                                      IllegalArgumentException,
                                      Exception

Uses the given license key to perform a device data update, writing the data to the file system and filling providers from this factory instance with it.

Parameters:

licenseKey - the licence key to submit to the server

dataFilePath - path to the device data file

Returns:

the result of the update to enable user reporting

Throws:

FileNotFoundException - if a file could not be found.

NoSuchAlgorithmException - if MD5 not available.

IllegalArgumentException

Exception

update

public static AutoUpdateStatus update(String[] licenseKeys,
                                      String binaryFilePath)
                               throws FileNotFoundException,
                                      NoSuchAlgorithmException,
                                      IllegalArgumentException,
                                      Exception

Uses the given license keys to perform a device data update, writing the data to the file system and filling providers from this factory instance with it.

Parameters:

licenseKeys - the licence key to use for the update request.

binaryFilePath - where the original data file is located.

Returns:

the result of the update to enable user reporting

Throws:

FileNotFoundException - if a file could not be found.

NoSuchAlgorithmException - if MD5 is not available.

IllegalArgumentException

Exception

getDataSetWithHeaderLoaded

public static Dataset getDataSetWithHeaderLoaded(File binaryFile)
                                          throws IOException

Provides access to the header fields of a data set.

Parameters:

binaryFile - path to a binary data file uncompressed

Returns:

a dataset with just the header loaded.

Throws:

IOException

fullUrl

public static URL fullUrl(String[] licenseKeys)
                   throws MalformedURLException

Constructs the URL needed to download Enhanced device data.

Parameters:

licenseKeys - Array of licence key strings.

Returns:

Premium data download URL.

Throws:

MalformedURLException