A B C D E F G H I J L M N P R S T U V W

A

add(MatchCandidate) - Method in class com.deviceatlas.device.MatchCandidatesCharPosition

API_VERSION - Static variable in class com.deviceatlas.device.DeviceApi

asBoolean() - Method in class com.deviceatlas.Property

Get the value of the property as a boolean.

asInteger() - Method in class com.deviceatlas.Property

Get the value of the property as an int.

asSet() - Method in class com.deviceatlas.Property

Gets a set of possible values for this property.

asString() - Method in class com.deviceatlas.Property

Get the value of the property as a String.

B

BAD_DATA - Static variable in exception com.deviceatlas.exception.JsonException

The data stored in the JSON cannot be used to build a valid DeviceAtlas data tree.

BaseDeviceAtlasApi - Class in com.deviceatlas

BaseDeviceAtlasApi() - Constructor for class com.deviceatlas.BaseDeviceAtlasApi

BOOLEAN - Static variable in class com.deviceatlas.DataType

Type boolean

build() - Method in class com.deviceatlas.Property.Builder

buildCarrierDataFile() - Method in class com.deviceatlas.datafile.DataFile.Builder

buildDeviceDataFile() - Method in class com.deviceatlas.datafile.DataFile.Builder

Builder(String) - Constructor for class com.deviceatlas.datafile.DataFile.Builder

Builder(Object, byte) - Constructor for class com.deviceatlas.Property.Builder

BYTE - Static variable in class com.deviceatlas.DataType

Type byte

C

CarrierApi - Class in com.deviceatlas.carrier

The main class for the Carrier Detection API.

CarrierApi() - Constructor for class com.deviceatlas.carrier.CarrierApi

CarrierApiWeb - Class in com.deviceatlas.carrier

A small extension to the core CarrierApi to permit passing of a javax.servlet.http.HttpServletRequest object.

CarrierApiWeb() - Constructor for class com.deviceatlas.carrier.CarrierApiWeb

CarrierApiWebJakarta - Class in com.deviceatlas.carrier

A small extension to the core CarrierApi to permit passing of a jakarta.servlet.http.HttpServletRequest object.

CarrierApiWebJakarta() - Constructor for class com.deviceatlas.carrier.CarrierApiWebJakarta

ClientPropertiesException - Exception in com.deviceatlas.exception

The ClientPropertiesException is thrown by the API when there is a problem parsing the properties from the client or when the JSON file does not support client side properties.

ClientPropertiesException(String) - Constructor for exception com.deviceatlas.exception.ClientPropertiesException

ClientPropertiesException(String, Throwable) - Constructor for exception com.deviceatlas.exception.ClientPropertiesException

com.deviceatlas - package com.deviceatlas

Common classes for the various DeviceAtlas APIs.

com.deviceatlas.carrier - package com.deviceatlas.carrier

com.deviceatlas.datafile - package com.deviceatlas.datafile

com.deviceatlas.device - package com.deviceatlas.device

com.deviceatlas.exception - package com.deviceatlas.exception

Common exceptions for DeviceAtlas APIs.

Config - Class in com.deviceatlas.device

DeviceApi Configurations.

Config() - Constructor for class com.deviceatlas.device.Config

contains(String, T) - Method in class com.deviceatlas.Properties

Check if a property has a specific value.

D

DataFile - Class in com.deviceatlas.datafile

DataFile class is used to represent data file configuration options.

DataFile.Builder - Class in com.deviceatlas.datafile

DataFileManager - Class in com.deviceatlas.datafile

DataFileManager(DeviceAtlasApi, DataFile) - Constructor for class com.deviceatlas.datafile.DataFileManager

DataLoadingException - Exception in com.deviceatlas.exception

The DataLoadException is thrown if there is a problem loading the data file.

DataLoadingException(String) - Constructor for exception com.deviceatlas.exception.DataLoadingException

DataLoadingException(String, Throwable) - Constructor for exception com.deviceatlas.exception.DataLoadingException

DataLoadingException(Throwable) - Constructor for exception com.deviceatlas.exception.DataLoadingException

DataType - Class in com.deviceatlas

The data types for various properties.

DataType() - Constructor for class com.deviceatlas.DataType

DEFAULT_COOKIE_NAME - Static variable in class com.deviceatlas.device.Config

The default cookie name that the client side properties would be set to.

DEFAULT_MAX_CACHE_ENTRIES - Static variable in class com.deviceatlas.device.Config

The default config value for result (Properties object) caching.

DeviceApi - Class in com.deviceatlas.device

The DeviceAtlas device detection API provides a way to detect devices based on the HTTP headers.

DeviceApi() - Constructor for class com.deviceatlas.device.DeviceApi

Constructs a DeviceApi instance with default config.

DeviceApi(Config) - Constructor for class com.deviceatlas.device.DeviceApi

Constructs a DeviceApi instance with custom config.

DeviceApiWeb - Class in com.deviceatlas.device

A small extension to the core DeviceApi to permit passing of an javax.servlet.http.HttpServletRequest object.

DeviceApiWeb() - Constructor for class com.deviceatlas.device.DeviceApiWeb

Constructs a DeviceApiWeb instance with default config.

DeviceApiWeb(Config) - Constructor for class com.deviceatlas.device.DeviceApiWeb

Constructs a DeviceApiWeb instance with custom config.

DeviceApiWebJakarta - Class in com.deviceatlas.device

A small extension to the core DeviceApi to permit passing of an jakarta.servlet.http.HttpServletRequest object.

DeviceApiWebJakarta() - Constructor for class com.deviceatlas.device.DeviceApiWebJakarta

Constructs a DeviceApiWeb instance with default config.

DeviceApiWebJakarta(Config) - Constructor for class com.deviceatlas.device.DeviceApiWebJakarta

Constructs a DeviceApiWeb instance with custom config.

DeviceAtlasApi - Interface in com.deviceatlas

disableScheduledDownloadAndReload(boolean) - Method in class com.deviceatlas.datafile.DataFile.Builder

DOUBLE - Static variable in class com.deviceatlas.DataType

Type double

downloadAndLoadDataFile(DataFile) - Method in class com.deviceatlas.BaseDeviceAtlasApi

Load the DeviceAtlas data file data from a URL.

downloadAndLoadDataFile(String) - Method in class com.deviceatlas.BaseDeviceAtlasApi

Load the DeviceAtlas data file from a URL.

downloadAndLoadDataFile(DataFile) - Method in interface com.deviceatlas.DeviceAtlasApi

downloadAndLoadDataFile(String) - Method in interface com.deviceatlas.DeviceAtlasApi

downloadAndLoadFrequencyDays(int) - Method in class com.deviceatlas.datafile.DataFile.Builder

downloadAndLoadScheduleTime(String) - Method in class com.deviceatlas.datafile.DataFile.Builder

downloadAndLoadTaskFailureCallback(DownloadAndLoadTaskFailureCallback) - Method in class com.deviceatlas.datafile.DataFile.Builder

DownloadAndLoadTaskFailureCallback - Interface in com.deviceatlas.datafile

downloadAndLoadTaskSuccessCallback(DownloadAndLoadTaskSuccessCallback) - Method in class com.deviceatlas.datafile.DataFile.Builder

DownloadAndLoadTaskSuccessCallback - Interface in com.deviceatlas.datafile

downloadConnectionTimeoutMilliseconds(int) - Method in class com.deviceatlas.datafile.DataFile.Builder

downloadReadTimeoutMilliseconds(int) - Method in class com.deviceatlas.datafile.DataFile.Builder

DynamicVersionExtractor - Class in com.deviceatlas.device

The "version" dynamic value extractor extracts a dynamic value and ensures it is a version value.

DynamicVersionExtractor(DelimitersHandler, DelimitersHandler, String, boolean, char, boolean, char) - Constructor for class com.deviceatlas.device.DynamicVersionExtractor

E

equals(Object) - Method in class com.deviceatlas.Property

Check if another object is equal to this object.

equals(Object) - Method in class com.deviceatlas.PropertyName

F

FILE_NOT_FOUND_ERROR - Static variable in exception com.deviceatlas.exception.JsonException

The path to the JSON file that was given cannot be resolved.

fileDirectory(String) - Method in class com.deviceatlas.datafile.DataFile.Builder

FLOAT - Static variable in class com.deviceatlas.DataType

Type float

G

getApiVersion() - Static method in class com.deviceatlas.carrier.CarrierApi

Returns the version of the Carrier API.

getApiVersion() - Static method in class com.deviceatlas.device.DeviceApi

The version of this API.

getCause() - Method in exception com.deviceatlas.exception.ClientPropertiesException

getCause() - Method in exception com.deviceatlas.exception.DataLoadingException

getCause() - Method in exception com.deviceatlas.exception.IncorrectPropertyTypeException

getCode() - Method in exception com.deviceatlas.exception.JsonException

getCookieName() - Method in class com.deviceatlas.device.Config

Get the cookie name that the client side properties would be set to.

getDataCreationIso8601() - Method in class com.deviceatlas.device.DeviceApi

The creation date/time of the loaded data file in ISO 8601 format.

getDataCreationTimestamp() - Method in class com.deviceatlas.device.DeviceApi

The creation date/time of the loaded data file as a Unix timestamp.

getDataFileCopyright() - Method in class com.deviceatlas.carrier.CarrierApi

Returns the data file copyright text.

getDataFileCreationDate() - Method in class com.deviceatlas.carrier.CarrierApi

Returns the data file creation date in ISO8601 format.

getDataFileVersion() - Method in class com.deviceatlas.carrier.CarrierApi

Returns the version of the data file.

getDataType() - Method in class com.deviceatlas.Property

Get the data type name for values associated with this Property

getDataType() - Method in class com.deviceatlas.PropertyName

Get the data type name for values associated with this Property name.

getDataTypeId() - Method in class com.deviceatlas.Property

Get the data type ID for values associated with this Property

getDataTypeId() - Method in class com.deviceatlas.PropertyName

Get the data type ID for values associated with this Property name.

getDataVersion() - Method in class com.deviceatlas.device.DeviceApi

The version of the data file.

getDetectionLookupCount() - Method in class com.deviceatlas.BaseDeviceAtlasApi

getDetectionLookupCount() - Method in interface com.deviceatlas.DeviceAtlasApi

getDeviceAtlasApiVersion() - Method in class com.deviceatlas.carrier.CarrierApi

getDeviceAtlasApiVersion() - Method in class com.deviceatlas.device.DeviceApi

getDeviceAtlasApiVersion() - Method in interface com.deviceatlas.DeviceAtlasApi

getDownloadAndLoadFrequencyDays() - Method in class com.deviceatlas.datafile.DataFile

getDownloadConnectionTimeoutMilliseconds() - Method in class com.deviceatlas.datafile.DataFile

getDownloadedDataFilePath() - Method in class com.deviceatlas.datafile.DataFileManager

If the temporary data file exists on the system return the temporary file path.

getDownloadReadTimeoutMilliseconds() - Method in class com.deviceatlas.datafile.DataFile

getDownloadUrl() - Method in class com.deviceatlas.datafile.DataFile

getDynamicValue(String, int) - Method in class com.deviceatlas.device.DynamicVersionExtractor

Extracts the characters between a valid delimiter (if defined) and up to the next delimiter.

getEndTokenCharPosition() - Method in class com.deviceatlas.device.MatchCandidatesCharPosition

getFileDirectory() - Method in class com.deviceatlas.datafile.DataFile

getFileExtension() - Method in class com.deviceatlas.datafile.DataFile

getFileName() - Method in class com.deviceatlas.datafile.DataFile

getFilePath() - Method in class com.deviceatlas.datafile.DataFile

getHeaderContentMd5() - Method in class com.deviceatlas.datafile.DataFile

getIp(Map<String, String>) - Method in class com.deviceatlas.carrier.CarrierApi

Get the most suitable IP address from the given keyVals set of HTTP headers.

getMatchCandidates() - Method in class com.deviceatlas.device.MatchCandidatesCharPosition

getMaxCacheEntries() - Method in class com.deviceatlas.device.Config

Get the max number of results to be cached.

getName(byte) - Static method in class com.deviceatlas.DataType

getName() - Method in class com.deviceatlas.PropertyName

Get the name of this PropertyName

getOrDefault(String, String) - Method in class com.deviceatlas.Properties

The method returns the String property value for the specified property name, otherwise the defaultValue is returned instead.

getOrDefault(String, Integer) - Method in class com.deviceatlas.Properties

The method returns the Integer property value for the specified property name, otherwise the defaultValue is returned instead.

getOrDefault(String, Boolean) - Method in class com.deviceatlas.Properties

The method returns the Boolean property value for the specified property name, otherwise the defaultValue is returned instead.

getOrDefault(String, Set<?>) - Method in class com.deviceatlas.Properties

The method returns the Set property value for the specified property name, otherwise the defaultValue is returned instead.

getProperties(String) - Method in class com.deviceatlas.carrier.CarrierApi

Get the Carrier properties for a given IP address.

getProperties(Map<String, String>) - Method in class com.deviceatlas.carrier.CarrierApi

Get the Carrier properties for a given Map of HTTP Headers.

getProperties(HttpServletRequest) - Method in class com.deviceatlas.carrier.CarrierApiWeb

Get the Carrier properties for the given javax.servlet.http.HttpServletRequest object.

getProperties(HttpServletRequest) - Method in class com.deviceatlas.carrier.CarrierApiWebJakarta

Get the Carrier properties for the given jakarta.servlet.http.HttpServletRequest object.

getProperties(String) - Method in class com.deviceatlas.device.DeviceApi

Get the properties for the provided identifier.

getProperties(String, String) - Method in class com.deviceatlas.device.DeviceApi

Get the properties for an identifier merged with the client side properties (provided by the DeviceAtlas Client-side component).

getProperties(Map<String, String>) - Method in class com.deviceatlas.device.DeviceApi

Get the properties for a map of HTTP headers.

getProperties(Map<String, String>, String) - Method in class com.deviceatlas.device.DeviceApi

Get the properties for a set of HTTP headers merged with properties from the Client-side component.

getProperties(HttpServletRequest) - Method in class com.deviceatlas.device.DeviceApiWeb

Get the Device properties for the given javax.servlet.http.HttpServletRequest object.

getProperties(HttpServletRequest) - Method in class com.deviceatlas.device.DeviceApiWebJakarta

Get the Device properties for the given jakarta.servlet.http.HttpServletRequest object.

getProperty(String, String) - Method in class com.deviceatlas.carrier.CarrierApi

Try to obtain a specific property for a given IP address.

getProperty(Map<String, String>, String) - Method in class com.deviceatlas.carrier.CarrierApi

Try to obtain a specific property for a given Map of HTTP Headers.

getProperty(HttpServletRequest, String) - Method in class com.deviceatlas.carrier.CarrierApiWeb

Gets a specific Property for the IP found in the javax.servlet.http.HttpServletRequest object.

getProperty(HttpServletRequest, String) - Method in class com.deviceatlas.carrier.CarrierApiWebJakarta

Gets a specific Property for the IP found in the jakarta.servlet.http.HttpServletRequest object.

getPropertyNames() - Method in class com.deviceatlas.carrier.CarrierApi

A Set of all the possible property names.

getPropertyNames() - Method in class com.deviceatlas.device.DeviceApi

Get a set of all possible property names.

getTemporaryFilePath() - Method in class com.deviceatlas.datafile.DataFile

H

handle(Exception) - Method in interface com.deviceatlas.datafile.DownloadAndLoadTaskFailureCallback

handle() - Method in interface com.deviceatlas.datafile.DownloadAndLoadTaskSuccessCallback

hashCode() - Method in class com.deviceatlas.Property

hashCode() - Method in class com.deviceatlas.PropertyName

headerContentMd5(String) - Method in class com.deviceatlas.datafile.DataFile.Builder

HEADERS_TO_CHECK - Static variable in class com.deviceatlas.carrier.CarrierApi

A list of HTTP headers to choose the original client IP address from.

I

IncorrectPropertyTypeException - Exception in com.deviceatlas.exception

The unchecked IncorrectPropertyTypeException is thrown by the Api class when there is an attempt to fetch a property by type and the property is stored under a different type in the tree.

IncorrectPropertyTypeException(String) - Constructor for exception com.deviceatlas.exception.IncorrectPropertyTypeException

IncorrectPropertyTypeException(Throwable) - Constructor for exception com.deviceatlas.exception.IncorrectPropertyTypeException

InputSource - Enum in com.deviceatlas.device

INTEGER - Static variable in class com.deviceatlas.DataType

Type int

InvalidPropertyNameException - Exception in com.deviceatlas.exception

The InvalidPropertyNameException is thrown when an attempt is made to get a property using a property name that does not exist.

InvalidPropertyNameException(String) - Constructor for exception com.deviceatlas.exception.InvalidPropertyNameException

isDataFileReload() - Method in class com.deviceatlas.BaseDeviceAtlasApi

isDataFileReload() - Method in interface com.deviceatlas.DeviceAtlasApi

isDisableScheduledDownloadAndReload() - Method in class com.deviceatlas.datafile.DataFile

isPublicIp(String) - Static method in class com.deviceatlas.carrier.CarrierApi

An IP address is considered public if it is not in any of the following ranges:

isValidateMd5() - Method in class com.deviceatlas.datafile.DataFile

J

JSON_VERSION - Static variable in exception com.deviceatlas.exception.JsonException

The JSON data you are using is too old for this API.

JsonException - Exception in com.deviceatlas.exception

The JsonException is thrown by the DetectionData class or the Api class when there is an error parsing the Json.

JsonException(int, String) - Constructor for exception com.deviceatlas.exception.JsonException

JsonException(int, String, Throwable) - Constructor for exception com.deviceatlas.exception.JsonException

L

loadDataFromClassPath(String) - Method in class com.deviceatlas.carrier.CarrierApi

Load the data file from the class path.

loadDataFromClassPath(String) - Method in class com.deviceatlas.device.DeviceApi

Load the DeviceAtlas device detection data into the API from a JSON file form the class path.

loadDataFromFile(String) - Method in class com.deviceatlas.carrier.CarrierApi

Load the data file from the provided path.

loadDataFromFile(String) - Method in class com.deviceatlas.device.DeviceApi

Load the DeviceAtlas device detection data into the API from a JSON file.

loadDataFromFile(String) - Method in interface com.deviceatlas.DeviceAtlasApi

loadDataFromStream(InputStream) - Method in class com.deviceatlas.carrier.CarrierApi

Load the data from an input stream.

loadDataFromStream(InputStream) - Method in class com.deviceatlas.device.DeviceApi

Load the DeviceAtlas device detection data into the API from an input stream.

LONG - Static variable in class com.deviceatlas.DataType

Type long int

M

MatchCandidatesCharPosition - Class in com.deviceatlas.device

MatchCandidatesCharPosition(int) - Constructor for class com.deviceatlas.device.MatchCandidatesCharPosition

MissingDataException - Exception in com.deviceatlas.exception

The MissingDataException is thrown if a data file was not loaded before a call to methods like getProperties(String ip) or getPropertyNames();

MissingDataException(String) - Constructor for exception com.deviceatlas.exception.MissingDataException

MissingDataException(String, Exception) - Constructor for exception com.deviceatlas.exception.MissingDataException

N

NO_CLIENT_PROPERTIES_SECTION - Static variable in exception com.deviceatlas.exception.JsonException

The JSON file does not contain the Client Properties Section.

P

persistDataFile() - Method in class com.deviceatlas.datafile.DataFileManager

The data file is downloaded into a temporary file.

Properties - Class in com.deviceatlas

Map String property names to Property objects.

Properties() - Constructor for class com.deviceatlas.Properties

Properties(int) - Constructor for class com.deviceatlas.Properties

Properties(int, float) - Constructor for class com.deviceatlas.Properties

Property - Class in com.deviceatlas

Contains a property value.

Property.Builder - Class in com.deviceatlas

PropertyName - Class in com.deviceatlas

Contains a property name and the expected data type of values associated with the property.

PropertyName(String, byte) - Constructor for class com.deviceatlas.PropertyName

Create a new PropertyName with string name and expected data type of values.

R

resetDetectionLookupCount() - Method in class com.deviceatlas.BaseDeviceAtlasApi

resetDetectionLookupCount() - Method in interface com.deviceatlas.DeviceAtlasApi

S

scheduleDownloadAndReloadTask() - Method in class com.deviceatlas.datafile.DataFileManager

Schedule a task to download the data file and load it into the API.

setCookieName(String) - Method in class com.deviceatlas.device.Config

To change the cookie name that the client side properties would be set to.

setMaxCacheEntries(int) - Method in class com.deviceatlas.device.Config

Set the max number of results to be cached.

SHORT - Static variable in class com.deviceatlas.DataType

Type short int

STRING - Static variable in class com.deviceatlas.DataType

Type string

T

toString() - Method in class com.deviceatlas.Property

Get the value of the property as a String.

toString() - Method in class com.deviceatlas.PropertyName

Get the property name and the data type as "property-name (property-data-type)"

U

UNKNOWN - Static variable in class com.deviceatlas.DataType

Unknown type

V

validateMd5(boolean) - Method in class com.deviceatlas.datafile.DataFile.Builder

value() - Method in class com.deviceatlas.Property

Get the value Object.

valueOf(String) - Static method in enum com.deviceatlas.device.InputSource

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.deviceatlas.device.InputSource

Returns an array containing the constants of this enum type, in the order they are declared.

W

withIsCollectionOfValues() - Method in class com.deviceatlas.Property.Builder

A B C D E F G H I J L M N P R S T U V W