server.msg

Class SimpleQueryRequest

java.lang.Object

server.msg.SimpleRequest

server.msg.SimpleQueryRequest

All Implemented Interfaces:

org.json.JSONString

public class SimpleQueryRequest
extends SimpleRequest

Query for a data value. Some data values require a user identity for access.

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

• key is the data key identifying the value.

Nested Class Summary

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

SimpleRequest.Type

Constructor Summary

Constructors

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

Method Summary

Methods

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

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

SimpleQueryRequest

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

Create a new query request.

Parameters:

identity - requesting entity identity.

user - requesting user. May be null.

data - the request data.

Throws:

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

Method Detail

getKey

public java.lang.String getKey()

Returns:

the data key.

getData

public org.json.JSONObject getData()

Specified by:

getData in class SimpleRequest

Returns:

the request data object.

execute

public SimpleRespondMessageContext execute()
                                    throws SimpleRequestUserException,
                                           SimpleRequestExecutionException

Description copied from class: SimpleRequest

Executes the operation and returns the response.

Specified by:

execute in class SimpleRequest

Returns:

the response.

Throws:

SimpleRequestUserException - if the request type requires a user but there is none provided.

SimpleRequestExecutionException - if there is an error executing the request.