cz.mallat.uasparser

Class UASparser

java.lang.Object

cz.mallat.uasparser.UASparser

Direct Known Subclasses:

BrowserFamilyParser, OnlineUpdateUASparser, SingleThreadedUASparser

public class UASparser
extends java.lang.Object

User agent parser. Thread-safe, however also see the MultithreadedUASparser for a faster variant.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.Long,cz.mallat.uasparser.BrowserEntry>	browserMap
protected java.util.Map<java.lang.Long,java.lang.Long>	browserOsMap
protected java.util.Map<java.lang.String,java.lang.Long>	browserRegMap
protected java.util.Map<java.lang.Long,java.lang.String>	browserTypeMap
protected java.util.Map<jregex.Pattern,java.lang.Long>	compiledBrowserRegMap
protected java.util.Map<jregex.Pattern,java.lang.Long>	compiledDeviceRegMap
protected java.util.Map<jregex.Pattern,java.lang.Long>	compiledOsRegMap
protected java.util.Map<java.lang.Long,cz.mallat.uasparser.DeviceEntry>	deviceMap
protected java.util.Map<java.lang.String,java.lang.Long>	deviceRegMap
protected java.util.Map<java.lang.Long,cz.mallat.uasparser.OsEntry>	osMap
protected java.util.Map<java.lang.String,java.lang.Long>	osRegMap
protected java.util.Map<java.lang.String,cz.mallat.uasparser.RobotEntry>	robotsMap
protected UserAgentInfo	unknownAgentInfo

Constructor Summary

Constructors

Constructor and Description
UASparser() Create a new UASparser without initializing maps.
UASparser(java.io.InputStream inputStreamToDefinitionFile) Use the given inputstream to load the definition file from the local filesystem
UASparser(java.lang.String localDefinitionFilename) Use the given filename to load the definition file from the local filesystem

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkDataMaps() Deprecated.
protected java.lang.String	convertPerlToJavaRegex(java.lang.String regex) Converts a PERL style regex into the Java style.
protected void	createInternalDataStructure(java.util.List<Section> sectionList) Creates the internal data structures from the sectionList
protected void	guessDeviceType(UserAgentInfo uaInfo) Determine device type based on UA type field
protected void	loadDataFromFile(java.io.File definitionFile) loads the data file and creates all internal data structures
protected void	loadDataFromFile(java.io.InputStream is) loads the data file and creates all internal data structs
UserAgentInfo	parse(java.lang.String useragent) Parse the given user agent string and returns a UserAgentInfo object with the related data
UserAgentInfo	parseBrowserOnly(java.lang.String useragent) Parse the given user agent string and returns a UserAgentInfo object with only the related Browser data set.
protected void	preCompileBrowserRegMap() Precompile browser regexes
protected void	preCompileDeviceRegMap() Precompile device regexes
protected void	preCompileOsRegMap() Precompile OS regexes
protected void	preCompileRegExes() Precompile all regular regexes
protected void	processBrowserRegex(java.lang.String useragent, UserAgentInfo uaInfo) Searchs in the browser regex table.
protected void	processDeviceRegex(java.lang.String useragent, UserAgentInfo uaInfo) Searches in the devices regex table.
protected void	processOsRegex(java.lang.String useragent, UserAgentInfo uaInfo) Searches in the os regex table.
protected boolean	processRobot(java.lang.String useragent, UserAgentInfo uaInfo) Checks if the User Agent matches that of a known Robot (crawler or other automated agent)

Methods inherited from class java.lang.Object

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

Field Detail

robotsMap

protected java.util.Map<java.lang.String,cz.mallat.uasparser.RobotEntry> robotsMap

osMap

protected java.util.Map<java.lang.Long,cz.mallat.uasparser.OsEntry> osMap

browserMap

protected java.util.Map<java.lang.Long,cz.mallat.uasparser.BrowserEntry> browserMap

browserTypeMap

protected java.util.Map<java.lang.Long,java.lang.String> browserTypeMap

browserRegMap

protected java.util.Map<java.lang.String,java.lang.Long> browserRegMap

browserOsMap

protected java.util.Map<java.lang.Long,java.lang.Long> browserOsMap

osRegMap

protected java.util.Map<java.lang.String,java.lang.Long> osRegMap

deviceMap

protected java.util.Map<java.lang.Long,cz.mallat.uasparser.DeviceEntry> deviceMap

deviceRegMap

protected java.util.Map<java.lang.String,java.lang.Long> deviceRegMap

compiledBrowserRegMap

protected java.util.Map<jregex.Pattern,java.lang.Long> compiledBrowserRegMap

compiledOsRegMap

protected java.util.Map<jregex.Pattern,java.lang.Long> compiledOsRegMap

compiledDeviceRegMap

protected java.util.Map<jregex.Pattern,java.lang.Long> compiledDeviceRegMap

unknownAgentInfo

protected UserAgentInfo unknownAgentInfo

Constructor Detail

UASparser

public UASparser()

Create a new UASparser without initializing maps. Expects an updater to be configured and run immediately.

UASparser

public UASparser(java.lang.String localDefinitionFilename)
          throws java.io.IOException

Use the given filename to load the definition file from the local filesystem

Parameters:

localDefinitionFilename -

Throws:

java.io.IOException

UASparser

public UASparser(java.io.InputStream inputStreamToDefinitionFile)
          throws java.io.IOException

Use the given inputstream to load the definition file from the local filesystem

Parameters:

inputStreamToDefinitionFile -

Throws:

java.io.IOException

Method Detail

checkDataMaps

@Deprecated
protected void checkDataMaps()
                      throws java.io.IOException

Deprecated.

When a class inherits from this class, it probably has to override this method

Throws:

java.io.IOException

parse

public UserAgentInfo parse(java.lang.String useragent)
                    throws java.io.IOException

Parse the given user agent string and returns a UserAgentInfo object with the related data

Parameters:

useragent -

Returns:

Throws:

java.io.IOException - may happen when the retrieval of the data file fails

guessDeviceType

protected void guessDeviceType(UserAgentInfo uaInfo)

Determine device type based on UA type field

Parameters:

uaInfo -

parseBrowserOnly

public UserAgentInfo parseBrowserOnly(java.lang.String useragent)

Parse the given user agent string and returns a UserAgentInfo object with only the related Browser data set.

Parameters:

useragent -

Returns:

UserAgentInfo

preCompileRegExes

protected void preCompileRegExes()

Precompile all regular regexes

preCompileBrowserRegMap

protected void preCompileBrowserRegMap()

Precompile browser regexes

preCompileOsRegMap

protected void preCompileOsRegMap()

Precompile OS regexes

preCompileDeviceRegMap

protected void preCompileDeviceRegMap()

Precompile device regexes

processRobot

protected boolean processRobot(java.lang.String useragent,
                   UserAgentInfo uaInfo)

Checks if the User Agent matches that of a known Robot (crawler or other automated agent)

Parameters:

useragent -

uaInfo -

processBrowserRegex

protected void processBrowserRegex(java.lang.String useragent,
                       UserAgentInfo uaInfo)

Searchs in the browser regex table. if found a match copies the browser data and if possible os data

Parameters:

useragent -

uaInfo -

processOsRegex

protected void processOsRegex(java.lang.String useragent,
                  UserAgentInfo uaInfo)

Searches in the os regex table. if found a match copies the os data

Parameters:

useragent -

uaInfo -

processDeviceRegex

protected void processDeviceRegex(java.lang.String useragent,
                      UserAgentInfo uaInfo)

Searches in the devices regex table. if found a match copies the device data

Parameters:

useragent -

uaInfo -

loadDataFromFile

protected void loadDataFromFile(java.io.File definitionFile)
                         throws java.io.IOException

loads the data file and creates all internal data structures

Parameters:

definitionFile -

Throws:

java.io.IOException

loadDataFromFile

protected void loadDataFromFile(java.io.InputStream is)
                         throws java.io.IOException

loads the data file and creates all internal data structs

Parameters:

is -

Throws:

java.io.IOException

createInternalDataStructure

protected void createInternalDataStructure(java.util.List<Section> sectionList)

Creates the internal data structures from the sectionList

Parameters:

sectionList -

convertPerlToJavaRegex

protected java.lang.String convertPerlToJavaRegex(java.lang.String regex)

Converts a PERL style regex into the Java style. That means in removes the leading and the last / and removes the modifiers

Parameters:

regex -

Returns: