com.indeed.proctor.pipet.deploy.useragent

Class UserAgent

java.lang.Object

com.indeed.proctor.pipet.deploy.useragent.UserAgent

public class UserAgent
extends java.lang.Object

Wrapper around bitwalker UserAgentUtils that provides lots of helpful convenience methods for defining proctor rules.

Author:

gaurav, matts

See Also:

UserAgent

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UserAgent.Builder

Constructor Summary

Constructors

Constructor and Description
UserAgent(java.lang.String userAgentString) Deprecated.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
static UserAgent	extractUserAgent(javax.servlet.http.HttpServletRequest request)
static UserAgent	extractUserAgentSafely(javax.servlet.http.HttpServletRequest request)
eu.bitwalker.useragentutils.Browser	getBrowser()
eu.bitwalker.useragentutils.Version	getBrowserVersion() Delegate method Detects the detailed version information of the browser.
eu.bitwalker.useragentutils.DeviceType	getDeviceType()
protected static int	getIntegerParameter(java.lang.String argument, int defaultValue) reading valid integer parameter
eu.bitwalker.useragentutils.OperatingSystem	getOperatingSystem()
VersionedOS	getOS()
java.lang.String	getUserAgentString()
UserAgentVersion	getVersion()
int	hashCode()
boolean	isAndroid()
boolean	isChromeForIOS()
boolean	isDumbPhone()
boolean	isIOS()
boolean	isMobileDevice()
boolean	isPhone() Mobile devices that are not tablets are regarded as phones.
boolean	isSmartPhone()
boolean	isTablet() Determines whether user agent is a tablet
boolean	isWindowsPhone()
static UserAgent.Builder	newBuilder()
static UserAgent	parseUserAgentString(java.lang.String userAgentString)
static UserAgent	parseUserAgentStringSafely(java.lang.String userAgentString)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UserAgent

@Deprecated
public UserAgent(@Nonnull
                             java.lang.String userAgentString)

Deprecated.

Method Detail

getBrowser

@Nonnull
public eu.bitwalker.useragentutils.Browser getBrowser()

extractUserAgent

@Nonnull
public static UserAgent extractUserAgent(@Nonnull
                                                  javax.servlet.http.HttpServletRequest request)

parseUserAgentString

@Nonnull
public static UserAgent parseUserAgentString(@Nullable
                                                      java.lang.String userAgentString)

extractUserAgentSafely

@Nonnull
public static UserAgent extractUserAgentSafely(@Nonnull
                                                        javax.servlet.http.HttpServletRequest request)

parseUserAgentStringSafely

@Nonnull
public static UserAgent parseUserAgentStringSafely(@Nullable
                                                            java.lang.String userAgentString)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getBrowserVersion

@Nonnull
public eu.bitwalker.useragentutils.Version getBrowserVersion()

Delegate method Detects the detailed version information of the browser. Depends on the userAgent to be available. Use it only after using UserAgent(String) or UserAgent.parseUserAgent(String). Returns UserAgent.UNKNOWN_VERSION if it can not detect the version information.

Returns:

Version

getVersion

@Nonnull
public UserAgentVersion getVersion()

getOperatingSystem

@Nonnull
public eu.bitwalker.useragentutils.OperatingSystem getOperatingSystem()

getOS

@Nonnull
public VersionedOS getOS()

getDeviceType

@Nonnull
public eu.bitwalker.useragentutils.DeviceType getDeviceType()

getUserAgentString

@Nonnull
public java.lang.String getUserAgentString()

isTablet

public boolean isTablet()

Determines whether user agent is a tablet

Returns:

true if tablet

isIOS

public boolean isIOS()

isChromeForIOS

public boolean isChromeForIOS()

isAndroid

public boolean isAndroid()

isWindowsPhone

public boolean isWindowsPhone()

isMobileDevice

public boolean isMobileDevice()

isSmartPhone

public boolean isSmartPhone()

isPhone

public boolean isPhone()

Mobile devices that are not tablets are regarded as phones. It is difficult to distinguish non-cellular handhelds

Returns:

true if mobile device and not a tablet

isDumbPhone

public boolean isDumbPhone()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

newBuilder

public static UserAgent.Builder newBuilder()

getIntegerParameter

protected static int getIntegerParameter(java.lang.String argument,
                                         int defaultValue)

reading valid integer parameter

Parameters:

argument - expected value

defaultValue - default value

Returns:

valid integer or default value