Package org.eclipse.scout.rt.ui.html.json

Class JsonStartupRequest

java.lang.Object

org.eclipse.scout.rt.ui.html.json.JsonRequest

org.eclipse.scout.rt.ui.html.json.JsonStartupRequest

public class JsonStartupRequest
extends JsonRequest

The JsonStartupRequest contains all information used to create a new IUiSession and a new IClientSession. The information sources are listed in the following table

• PROP_PART_ID - portlet part ID (attribute 'data-partid' of scout html element)
• PROP_CLIENT_SESSION_ID - first one defined: argument to scout.init(), sessionStorage.getItem('scout:clientSessionId'), current timestamp
• PROP_USER_AGENT - first one defined: argument to scout.init(), default scout.UserAgent.DEVICE_TYPE_DESKTOP
• PROP_SESSION_STARTUP_PARAMS - contains session startup parameters to scout.init() as well as all location url parameters and the url itself with key 'url'

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.scout.rt.ui.html.json.JsonRequest

JsonRequest.RequestType

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROP_CLIENT_SESSION_ID
static final String	PROP_PART_ID
static final String	PROP_SESSION_STARTUP_PARAMS
static final String	PROP_USER_AGENT
static final String	PROP_VERSION

Fields inherited from class org.eclipse.scout.rt.ui.html.json.JsonRequest

CURRENT, PROP_ACK_SEQUENCE_NO, PROP_CANCEL, PROP_EVENT, PROP_EVENTS, PROP_LOG, PROP_MESSAGE, PROP_PING, PROP_POLL, PROP_SEQUENCE_NO, PROP_STARTUP, PROP_SYNC_RESPONSE_QUEUE, PROP_UI_SESSION_ID, PROP_UNLOAD

Constructor Summary

Constructors

Constructor	Description
JsonStartupRequest(JsonRequest request)

Method Summary

Modifier and Type	Method	Description
String	getClientSessionId()
String	getPartId()
Map<String,String>	getSessionStartupParams()
JSONObject	getUserAgent()
String	getVersion()
protected Map<String,String>	parseSessionStartupParams(JSONObject object)

Methods inherited from class org.eclipse.scout.rt.ui.html.json.JsonRequest

getAckSequenceNo, getEvent, getEvents, getMessage, getRequestObject, getRequestType, getSequenceNo, getUiSessionId, toString, validate

Methods inherited from class java.lang.Object

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

Field Details

PROP_PART_ID

public static final String PROP_PART_ID

See Also:

• Constant Field Values

PROP_CLIENT_SESSION_ID

public static final String PROP_CLIENT_SESSION_ID

See Also:

• Constant Field Values

PROP_USER_AGENT

public static final String PROP_USER_AGENT

See Also:

• Constant Field Values

PROP_SESSION_STARTUP_PARAMS

public static final String PROP_SESSION_STARTUP_PARAMS

See Also:

• Constant Field Values

PROP_VERSION

public static final String PROP_VERSION

See Also:

• Constant Field Values

Constructor Details

JsonStartupRequest

public JsonStartupRequest(JsonRequest request)

Method Details

getPartId

public String getPartId()

Returns:

partId or "0" (mandatory attribute)

getClientSessionId

public String getClientSessionId()

Returns:

clientSessionId or null (optional attribute)

getUserAgent

public JSONObject getUserAgent()

Returns:

userAgent or null (optional attribute)

getVersion

public String getVersion()

Returns:

version or null (optional attribute)

getSessionStartupParams

public Map<String,String> getSessionStartupParams()

Returns:

session startup parameters, or an empty Map if not provided (optional attribute)

parseSessionStartupParams

protected Map<String,String> parseSessionStartupParams(JSONObject object)