nextapp.echo.webcontainer
Class ClientProperties

java.lang.Object
  nextapp.echo.webcontainer.ClientProperties

All Implemented Interfaces:

java.io.Serializable

public class ClientProperties
extends java.lang.Object
implements java.io.Serializable

A description of the client browser environment.

See Also:

Serialized Form

Field Summary

static java.lang.String	BROWSER_CHROME Flag indicating that the browser is a derivative of the Google Chrome platform.
static java.lang.String	BROWSER_INTERNET_EXPLORER Flag indicating that the browser is a derivative of the Microsoft Internet Explorer browser platform.
static java.lang.String	BROWSER_KONQUEROR Flag indicating that the browser is a derivative of the KDE Konqueror browser platform.
static java.lang.String	BROWSER_MOZILLA Flag indicating that the browser is a derivative of the Mozilla 1.0-1.8+ browser platform.
static java.lang.String	BROWSER_MOZILLA_FIREFOX Flag indicating that the browser is a derivative of the Mozilla Firefox 1.0+ browser platform.
static java.lang.String	BROWSER_OPERA Flag indicating that the browser is a derivative of the Opera browser platform.
static java.lang.String	BROWSER_SAFARI Flag indicating that the browser is a derivative of the Apple Safari browser platform.
static java.lang.String	BROWSER_VERSION_MAJOR The major version number of the browser.
static java.lang.String	BROWSER_VERSION_MINOR The minor version number of the browser.
static java.lang.String	ENGINE_GECKO Flag indicating the layout engine is Mozilla Gecko.
static java.lang.String	ENGINE_KHTML Flag indicating the layout engine is KHTML (from Konqueror).
static java.lang.String	ENGINE_MSHTML Flag indicating the layout engine is MSHTML / Trident.
static java.lang.String	ENGINE_PRESTO Flag indicating the layout engine is Presto (Opera).
static java.lang.String	ENGINE_VERSION_MAJOR The major version number of the layout engine.
static java.lang.String	ENGINE_VERSION_MINOR The minor version number of the layout engine.
static java.lang.String	ENGINE_WEBKIT Flag indicating the layout engine is WebKit.
static java.lang.String	LOCALES The Locale of the client, derived from the language property.
static java.lang.String	NAVIGATOR_APP_CODE_NAME The client's navigator.appCodeName property.
static java.lang.String	NAVIGATOR_APP_NAME The client's navigator.appName property.
static java.lang.String	NAVIGATOR_APP_VERSION The client's navigator.appVersion property.
static java.lang.String	NAVIGATOR_COOKIE_ENABLED The client's navigator.cookieEnabled property.
static java.lang.String	NAVIGATOR_JAVA_ENABLED The client's navigator.javaEnabled property.
static java.lang.String	NAVIGATOR_LANGUAGE The client's navigator.language (or navigator.userLanguage) property.
static java.lang.String	NAVIGATOR_PLATFORM The client's navigator.platform property.
static java.lang.String	NAVIGATOR_USER_AGENT The client's navigator.userAgent property.
static java.lang.String	REMOTE_HOST The client host.
static java.lang.String	SCREEN_COLOR_DEPTH Color depth of the screen in bits (integer).
static java.lang.String	SCREEN_HEIGHT Height of the screen in pixels (integer).
static java.lang.String	SCREEN_WIDTH Width of the screen in pixels (integer).
static java.lang.String	UTC_OFFSET The client's time offset from UTC in minutes.

Constructor Summary

ClientProperties()
Creates a new ClientProperties object.

Method Summary

java.lang.Object	get(java.lang.String propertyName) Returns the value of the specified property as an Object.
boolean	getBoolean(java.lang.String propertyName) Returns a boolean property.
int	getInt(java.lang.String propertyName, int nullValue) Returns a int property.
java.lang.String[]	getPropertyNames() Returns an array of all property names which are set.
java.lang.String	getString(java.lang.String propertyName) Returns a String property.
void	setProperty(java.lang.String propertyName, java.lang.Object propertyValue) Sets the value of the specified property.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SCREEN_WIDTH

public static final java.lang.String SCREEN_WIDTH

Width of the screen in pixels (integer).

See Also:

Constant Field Values

SCREEN_HEIGHT

public static final java.lang.String SCREEN_HEIGHT

Height of the screen in pixels (integer).

See Also:

Constant Field Values

SCREEN_COLOR_DEPTH

public static final java.lang.String SCREEN_COLOR_DEPTH

Color depth of the screen in bits (integer).

See Also:

Constant Field Values

BROWSER_MOZILLA

public static final java.lang.String BROWSER_MOZILLA

Flag indicating that the browser is a derivative of the Mozilla 1.0-1.8+ browser platform.

See Also:

Constant Field Values

BROWSER_CHROME

public static final java.lang.String BROWSER_CHROME

Flag indicating that the browser is a derivative of the Google Chrome platform.

See Also:

Constant Field Values

BROWSER_MOZILLA_FIREFOX

public static final java.lang.String BROWSER_MOZILLA_FIREFOX

Flag indicating that the browser is a derivative of the Mozilla Firefox 1.0+ browser platform.

See Also:

Constant Field Values

BROWSER_INTERNET_EXPLORER

public static final java.lang.String BROWSER_INTERNET_EXPLORER

Flag indicating that the browser is a derivative of the Microsoft Internet Explorer browser platform.

See Also:

Constant Field Values

BROWSER_KONQUEROR

public static final java.lang.String BROWSER_KONQUEROR

Flag indicating that the browser is a derivative of the KDE Konqueror browser platform.

See Also:

Constant Field Values

BROWSER_SAFARI

public static final java.lang.String BROWSER_SAFARI

Flag indicating that the browser is a derivative of the Apple Safari browser platform.

See Also:

Constant Field Values

BROWSER_OPERA

public static final java.lang.String BROWSER_OPERA

Flag indicating that the browser is a derivative of the Opera browser platform.

See Also:

Constant Field Values

BROWSER_VERSION_MAJOR

public static final java.lang.String BROWSER_VERSION_MAJOR

The major version number of the browser.

See Also:

Constant Field Values

BROWSER_VERSION_MINOR

public static final java.lang.String BROWSER_VERSION_MINOR

The minor version number of the browser.

See Also:

Constant Field Values

ENGINE_GECKO

public static final java.lang.String ENGINE_GECKO

Flag indicating the layout engine is Mozilla Gecko.

See Also:

Constant Field Values

ENGINE_KHTML

public static final java.lang.String ENGINE_KHTML

Flag indicating the layout engine is KHTML (from Konqueror).

See Also:

Constant Field Values

ENGINE_MSHTML

public static final java.lang.String ENGINE_MSHTML

Flag indicating the layout engine is MSHTML / Trident.

See Also:

Constant Field Values

ENGINE_PRESTO

public static final java.lang.String ENGINE_PRESTO

Flag indicating the layout engine is Presto (Opera).

See Also:

Constant Field Values

ENGINE_VERSION_MAJOR

public static final java.lang.String ENGINE_VERSION_MAJOR

The major version number of the layout engine.

See Also:

Constant Field Values

ENGINE_VERSION_MINOR

public static final java.lang.String ENGINE_VERSION_MINOR

The minor version number of the layout engine.

See Also:

Constant Field Values

ENGINE_WEBKIT

public static final java.lang.String ENGINE_WEBKIT

Flag indicating the layout engine is WebKit.

See Also:

Constant Field Values

LOCALES

public static final java.lang.String LOCALES

The Locale of the client, derived from the language property.

See Also:

Constant Field Values

NAVIGATOR_APP_NAME

public static final java.lang.String NAVIGATOR_APP_NAME

The client's navigator.appName property.

See Also:

Constant Field Values

NAVIGATOR_APP_VERSION

public static final java.lang.String NAVIGATOR_APP_VERSION

The client's navigator.appVersion property.

See Also:

Constant Field Values

NAVIGATOR_APP_CODE_NAME

public static final java.lang.String NAVIGATOR_APP_CODE_NAME

The client's navigator.appCodeName property.

See Also:

Constant Field Values

NAVIGATOR_COOKIE_ENABLED

public static final java.lang.String NAVIGATOR_COOKIE_ENABLED

The client's navigator.cookieEnabled property.

See Also:

Constant Field Values

NAVIGATOR_JAVA_ENABLED

public static final java.lang.String NAVIGATOR_JAVA_ENABLED

The client's navigator.javaEnabled property.

See Also:

Constant Field Values

NAVIGATOR_LANGUAGE

public static final java.lang.String NAVIGATOR_LANGUAGE

The client's navigator.language (or navigator.userLanguage) property.

See Also:

Constant Field Values

NAVIGATOR_PLATFORM

public static final java.lang.String NAVIGATOR_PLATFORM

The client's navigator.platform property.

See Also:

Constant Field Values

NAVIGATOR_USER_AGENT

public static final java.lang.String NAVIGATOR_USER_AGENT

The client's navigator.userAgent property.

See Also:

Constant Field Values

REMOTE_HOST

public static final java.lang.String REMOTE_HOST

The client host. Note this is the original host address used when the ClientProperties object was created, which is not necessarily the same as that making the current HTTP request.

See Also:

Constant Field Values

UTC_OFFSET

public static final java.lang.String UTC_OFFSET

The client's time offset from UTC in minutes.

See Also:

Constant Field Values

Constructor Detail

ClientProperties

public ClientProperties()

Creates a new ClientProperties object.

Method Detail

get

public java.lang.Object get(java.lang.String propertyName)

Returns the value of the specified property as an Object.

Parameters:

propertyName - the property name

Returns:

the property value

getBoolean

public boolean getBoolean(java.lang.String propertyName)

Returns a boolean property. If the property is not set, false is returned.

Parameters:

propertyName - the property name

Returns:

the property value

getInt

public int getInt(java.lang.String propertyName,
                  int nullValue)

Returns a int property. If the property is not set, nullValue is returned.

Parameters:

propertyName - the property name

nullValue - the returned value when the property is not set

Returns:

the property value

getString

public java.lang.String getString(java.lang.String propertyName)

Returns a String property. If the property is not set, null is returned.

Parameters:

propertyName - the property name

Returns:

the property value

getPropertyNames

public java.lang.String[] getPropertyNames()

Returns an array of all property names which are set.

Returns:

the array

setProperty

public void setProperty(java.lang.String propertyName,
                        java.lang.Object propertyValue)

Sets the value of the specified property.

Parameters:

propertyName - the property name

propertyValue - the property value

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()