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

Class JsonRequest

java.lang.Object

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

Direct Known Subclasses:

JsonStartupRequest

public class JsonRequest
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	JsonRequest.RequestType

Field Summary

Fields

Modifier and Type	Field	Description
static final ThreadLocal<JsonRequest>	CURRENT	The JsonRequest which is currently associated with the current thread.
static final String	PROP_ACK_SEQUENCE_NO
static final String	PROP_CANCEL
static final String	PROP_EVENT
static final String	PROP_EVENTS
static final String	PROP_LOG
static final String	PROP_MESSAGE
static final String	PROP_PING
static final String	PROP_POLL
static final String	PROP_SEQUENCE_NO
static final String	PROP_STARTUP
static final String	PROP_SYNC_RESPONSE_QUEUE
static final String	PROP_UI_SESSION_ID
static final String	PROP_UNLOAD

Constructor Summary

Constructors

Constructor	Description
JsonRequest(JSONObject request)	Creates a new (validated) JsonRequest instance.

Method Summary

Modifier and Type	Method	Description
Long	getAckSequenceNo()
JSONObject	getEvent()
List<JsonEvent>	getEvents()
String	getMessage()
protected JSONObject	getRequestObject()
JsonRequest.RequestType	getRequestType()	Returns the type of the JsonRequest, and is never null.
Long	getSequenceNo()
String	getUiSessionId()
String	toString()
protected void	validate(JsonRequest.RequestType requestType, JSONObject request)

Methods inherited from class java.lang.Object

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

Field Details

CURRENT

public static final ThreadLocal<JsonRequest> CURRENT

The JsonRequest which is currently associated with the current thread.

PROP_STARTUP

public static final String PROP_STARTUP

See Also:

• Constant Field Values

PROP_UNLOAD

public static final String PROP_UNLOAD

See Also:

• Constant Field Values

PROP_LOG

public static final String PROP_LOG

See Also:

• Constant Field Values

PROP_POLL

public static final String PROP_POLL

See Also:

• Constant Field Values

PROP_CANCEL

public static final String PROP_CANCEL

See Also:

• Constant Field Values

PROP_PING

public static final String PROP_PING

See Also:

• Constant Field Values

PROP_SYNC_RESPONSE_QUEUE

public static final String PROP_SYNC_RESPONSE_QUEUE

See Also:

• Constant Field Values

PROP_UI_SESSION_ID

public static final String PROP_UI_SESSION_ID

See Also:

• Constant Field Values

PROP_EVENTS

public static final String PROP_EVENTS

See Also:

• Constant Field Values

PROP_EVENT

public static final String PROP_EVENT

See Also:

• Constant Field Values

PROP_MESSAGE

public static final String PROP_MESSAGE

See Also:

• Constant Field Values

PROP_SEQUENCE_NO

public static final String PROP_SEQUENCE_NO

See Also:

• Constant Field Values

PROP_ACK_SEQUENCE_NO

public static final String PROP_ACK_SEQUENCE_NO

See Also:

• Constant Field Values

Constructor Details

JsonRequest

public JsonRequest(JSONObject request)

Creates a new (validated) JsonRequest instance.

Throws:

org.eclipse.scout.rt.platform.util.Assertions.AssertionException - if mandatory property 'uiSessionId' is not set for a request other than 'STARTUP' or 'PING' request.

Method Details

validate

protected void validate(JsonRequest.RequestType requestType,
 JSONObject request)

getRequestObject

protected JSONObject getRequestObject()

getUiSessionId

public String getUiSessionId()

getEvents

public List<JsonEvent> getEvents()

getRequestType

public JsonRequest.RequestType getRequestType()

Returns the type of the JsonRequest, and is never null.

getEvent

public JSONObject getEvent()

Returns:

attribute PROP_EVENT (for type JsonRequest.RequestType.LOG_REQUEST)

getMessage

public String getMessage()

Returns:

attribute PROP_MESSAGE (for type JsonRequest.RequestType.LOG_REQUEST)

getAckSequenceNo

public Long getAckSequenceNo()

Returns:

The acknowledged response sequence number

getSequenceNo

public Long getSequenceNo()

Returns:

The sequence number of this request

toString

public String toString()

Overrides:

toString in class Object