server.msg

Class SimpleEchoRequest

java.lang.Object

server.msg.SimpleRequest

server.msg.SimpleEchoRequest

All Implemented Interfaces:

org.json.JSONString

public class SimpleEchoRequest
extends SimpleRequest

Request to echo the request message. The requesting entity identity and user (if any) is also echoed.

The request data object is defined as: data = { "#mandatory" : [ "message" ], "message" : "string" } where:

• message is the message to echo.

Nested Class Summary

Nested classes/interfaces inherited from class server.msg.SimpleRequest

SimpleRequest.Type

Constructor Summary

Constructors

Constructor and Description
SimpleEchoRequest(java.lang.String identity, SimpleUser user, org.json.JSONObject data) Create a new echo request.

Method Summary

Methods

Modifier and Type	Method and Description
SimpleRespondMessageContext	execute() Executes the operation and returns the response.
org.json.JSONObject	getData()

Methods inherited from class server.msg.SimpleRequest

getIdentity, getType, getUser, parse, toJSONString

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleEchoRequest

public SimpleEchoRequest(java.lang.String identity,
                 SimpleUser user,
                 org.json.JSONObject data)
                  throws SimpleRequestParseException

Create a new echo request.

Parameters:

identity - requesting entity identity.

user - requesting user. May be null.

data - the request data object.

Throws:

SimpleRequestParseException - if there is an error parsing the request data.

Method Detail

getData

public org.json.JSONObject getData()

Specified by:

getData in class SimpleRequest

Returns:

the request data object.

execute

public SimpleRespondMessageContext execute()

Description copied from class: SimpleRequest

Executes the operation and returns the response.

Specified by:

execute in class SimpleRequest

Returns:

the response.