sirius.web.http

Class UserAgent

java.lang.Object

sirius.web.http.UserAgent

public class UserAgent
extends Object

Provides information about user agent and used device for given user agent.

This class only provides valid information for requests by browsers or clients which do transmit an user agent. If no user agent is transmitted, the client is considered as desktop.

Assumptions of device properties based on user agents might not be accurate all the time as some browsers transmit some special user agents and user agents for different browsers and devices might change over time.

Constructor Summary

Constructors

Constructor and Description
UserAgent(String userAgentString) Creates a new instance based on the given user agent string.

Method Summary

Modifier and Type	Method and Description
boolean	contains(String userAgentPart) Determines if the user agent contains the given value.
String	getUserAgentString() Returns the user agent as String.
boolean	is(String expectedUserAgent) Determines if the user agent is equal to the given value.
boolean	isAndroid() Determines whether the user agent hints to an Android device.
boolean	isDesktop() Determines whether the user agent hits to a desktop device.
boolean	isIOS() Determines whether the user agent hints to an iOS device.
boolean	isMobile() Determines whether the user agent hints to a mobile device.
boolean	isPhone() Determines whether the user agent hints to a phone.
boolean	isTablet() Determines whether the user agent hints to a tablet.
protected void	parseUserAgent()

Methods inherited from class java.lang.Object

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

Constructor Detail

UserAgent

public UserAgent(String userAgentString)

Creates a new instance based on the given user agent string.

Parameters:

userAgentString - the header value indicating the user angent, which is a fancy word for browser.

Method Detail

parseUserAgent

protected void parseUserAgent()

isMobile

public boolean isMobile()

Determines whether the user agent hints to a mobile device. Phones and tablets are considered as mobile devices.

Returns:

whether user agent hints to a mobile device

isPhone

public boolean isPhone()

Determines whether the user agent hints to a phone.

Returns:

whether the user agent hints to a phone

isTablet

public boolean isTablet()

Determines whether the user agent hints to a tablet.

Returns:

whether the user agent hints to a tablet

isDesktop

public boolean isDesktop()

Determines whether the user agent hits to a desktop device.

Returns:

whether the user agent hints a desktop device

isAndroid

public boolean isAndroid()

Determines whether the user agent hints to an Android device.

Returns:

whether the user agent hints to a Android device

isIOS

public boolean isIOS()

Determines whether the user agent hints to an iOS device.

Returns:

whether the user agent hints to an iOS device

getUserAgentString

public String getUserAgentString()

Returns the user agent as String.

Returns:

the user agent as String

is

public boolean is(@Nonnull
                  String expectedUserAgent)

Determines if the user agent is equal to the given value.

Parameters:

expectedUserAgent - the expected user agent

Returns:

true if the user agent matches, false otherwise

contains

public boolean contains(@Nonnull
                        String userAgentPart)

Determines if the user agent contains the given value.

Parameters:

userAgentPart - the user agent to check for

Returns:

true if the usr agent contains the given value, false otherwise