@DefaultKey(value="browser") @InvalidScope(value="application") public class BrowserTool extends BrowserToolDeprecatedMethods implements Serializable
Browser sniffing tool (session or request scope requested, session scope advised).
Usage:
BrowserTool defines properties that are used to test the client browser, operating system, device, language...
All properties are boolean, excpet those in italic which are strings (and major/minor versions which are integers)
The following properties are available:
Language properties are filtered by the languagesFilter tool param, if present, which is here to specify which languages are acceptable on the server side. If no matching language is found, or if there is no matching language, the tools defaut locale (or the first value of languagesFilter) is returned. Their value is guarantied to belong to the set provided in languagesFilter, if any.
Notes on implementation:
Thanks to Lee Semel (lee@semel.net), the author of the HTTP::BrowserDetect Perl module.
See also:
TODO:
DEFAULT_FORMAT, FORMAT_KEYDEFAULT_LOCALELOCK_CONFIG_KEY, log, LOGGER_NAME_KEY, SAFE_MODE_KEY, USE_CLASS_LOGGER_KEY| Constructor and Description |
|---|
BrowserTool() |
| Modifier and Type | Method and Description |
|---|---|
boolean |
get(String key) |
String |
getAcceptLanguage() |
UAParser.UAEntity |
getBrowser() |
boolean |
getCss3() |
String |
getDevice() |
boolean |
getDom3() |
String |
getIPAddress()
Get the client browser IP address.
|
String |
getLanguagesFilter() |
UAParser.UAEntity |
getOperatingSystem() |
String |
getPreferredLanguage() |
Locale |
getPreferredLocale() |
UAParser.UAEntity |
getRenderingEngine() |
String |
getUserAgentString() |
boolean |
isAndroid() |
boolean |
isBlackberry() |
boolean |
isBlink() |
boolean |
isBSD() |
boolean |
isChrome() |
boolean |
isDesktop() |
boolean |
isEdgeHTML() |
boolean |
isFirefox() |
boolean |
isGecko() |
boolean |
isIOS() |
boolean |
isKHTML() |
boolean |
isKonqueror() |
boolean |
isLinks() |
boolean |
isLinux() |
boolean |
isMobile() |
boolean |
isMozilla() |
boolean |
isMSIE() |
boolean |
isNetscape() |
boolean |
isOpera() |
boolean |
isOSX() |
boolean |
isPresto() |
boolean |
isRobot() |
boolean |
isSafari() |
boolean |
isSymbian() |
boolean |
isTablet() |
boolean |
isTrident() |
boolean |
isTV() |
boolean |
isUnix() |
boolean |
isWebKit() |
boolean |
isWindows() |
void |
setAcceptLanguage(String al) |
void |
setLanguagesFilter(String filter) |
void |
setRequest(javax.servlet.http.HttpServletRequest request)
Retrieves the User-Agent header from the request (if any).
|
void |
setUserAgentString(String ua)
Sets the User-Agent string to be parsed for info.
|
protected boolean |
test(String key) |
String |
toString() |
getCss, getCss1, getCss2, getDom0, getDom1, getDom2, getDotnet, getGeckoMajorVersion, getGeckoMinorVersion, getGeckoVersion, getIe, getIe3, getIe4, getIe4up, getIe5, getIe55, getIe55up, getIe5up, getIe6, getIe6up, getIe7, getIe7up, getIe8, getIe8up, getJavascript, getMajorVersion, getMinorVersion, getNav2, getNav3, getNav4, getNav45, getNav45up, getNav4up, getNav6, getNav6up, getNavgold, getOpera3, getOpera4, getOpera5, getOpera6, getOpera7, getOpera8, getOpera9, getUserAgent, getVersion, getVista, getWin16, getWin2k, getWin31, getWin32, getWin3x, getWin95, getWin98, getWinme, getWinnt, getWinxp, isAix, isAix1, isAix2, isAix3, isAix4, isAmiga, isBsd, isDec, isEmacs, isFreebsd, isHpux, isHpux10, isHpux9, isIrix, isIrix5, isIrix6, isMac, isMac68k, isMacppc, isMpras, isOs2, isReliant, isSco, isSinix, isSun, isSun4, isSun5, isSuni86, isUnixware, isVMS, isX11configure, getFormat, setFormatgetLocale, setLocale, toLocaleconfigure, getLog, initLogger, isConfigLocked, isSafeMode, setLockConfig, setSafeModepublic void setRequest(javax.servlet.http.HttpServletRequest request)
request - servlet requestsetUserAgentString(java.lang.String)public void setUserAgentString(String ua)
ua - user agent stringpublic void setAcceptLanguage(String al)
public void setLanguagesFilter(String filter)
public String getLanguagesFilter()
public boolean get(String key)
public String getUserAgentString()
getUserAgentString in class BrowserToolDeprecatedMethodspublic String getAcceptLanguage()
public String getIPAddress()
Get the client browser IP address. In the session scope, which is the default, it corresponds to the first seen IP adress.
The tool tries to get the real IP address whenever the request has been proxied.
Please note that the result may be null.
public String getDevice()
public boolean isRobot()
public boolean isTablet()
public boolean isMobile()
public boolean isDesktop()
public boolean isTV()
public UAParser.UAEntity getBrowser()
getBrowser in class BrowserToolDeprecatedMethodspublic UAParser.UAEntity getRenderingEngine()
getRenderingEngine in class BrowserToolDeprecatedMethodspublic UAParser.UAEntity getOperatingSystem()
getOperatingSystem in class BrowserToolDeprecatedMethodspublic boolean isGecko()
isGecko in class BrowserToolDeprecatedMethodspublic boolean isWebKit()
public boolean isKHTML()
public boolean isTrident()
public boolean isBlink()
public boolean isEdgeHTML()
public boolean isPresto()
public boolean isChrome()
isChrome in class BrowserToolDeprecatedMethodspublic boolean isMSIE()
isMSIE in class BrowserToolDeprecatedMethodspublic boolean isFirefox()
isFirefox in class BrowserToolDeprecatedMethodspublic boolean isOpera()
isOpera in class BrowserToolDeprecatedMethodspublic boolean isSafari()
isSafari in class BrowserToolDeprecatedMethodspublic boolean isNetscape()
isNetscape in class BrowserToolDeprecatedMethodspublic boolean isKonqueror()
isKonqueror in class BrowserToolDeprecatedMethodspublic boolean isLinks()
isLinks in class BrowserToolDeprecatedMethodspublic boolean isMozilla()
isMozilla in class BrowserToolDeprecatedMethodspublic boolean isWindows()
isWindows in class BrowserToolDeprecatedMethodspublic boolean isOSX()
isOSX in class BrowserToolDeprecatedMethodspublic boolean isLinux()
isLinux in class BrowserToolDeprecatedMethodspublic boolean isBSD()
public boolean isUnix()
public boolean isAndroid()
public boolean isIOS()
public boolean isSymbian()
public boolean isBlackberry()
public boolean getCss3()
public boolean getDom3()
public String getPreferredLanguage()
public Locale getPreferredLocale()
protected boolean test(String key)
test in class BrowserToolDeprecatedMethodsCopyright © 2002–2021 The Apache Software Foundation. All rights reserved.