com.simplifiedlogic.nitro.jshell.json.request

Class BaseRequest

java.lang.Object

com.simplifiedlogic.nitro.jshell.json.request.BaseRequest

public class BaseRequest
extends java.lang.Object

This is the common structure for all JSON requests. All requests will have this format, though some of the fields are optional. Any function-specific input parameters will be stored in the "data" property.

The "echo" property is a legacy property that will cause the original JSON string to be passed back to the client in the response, in addition to the regular function output.

Constructor Summary

Constructors

Constructor and Description
BaseRequest()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	get(java.lang.String key) Forwarding method for getting a data item from the request
java.lang.String	getCommand() Get the request's command (function family)
java.util.Hashtable<java.lang.String,java.lang.Object>	getData() Get the function-specific input data
java.lang.String	getFunction() Get the function name within the command
java.lang.String	getSessionId() Get the user's session ID
boolean	isEcho() Get the echo property
java.lang.Object	put(java.lang.String key, java.lang.Object value) Forwarding method for adding a data item to the request
void	setCommand(java.lang.String command) Set the request's command (function family)
void	setData(java.util.Hashtable<java.lang.String,java.lang.Object> data) Set the function-specific input data
void	setEcho(boolean echo) Set the echo property
void	setFunction(java.lang.String function) Set the function name within the command
void	setSessionId(java.lang.String sessionId) Set the user's session ID

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseRequest

public BaseRequest()

Method Detail

put

public java.lang.Object put(java.lang.String key,
                   java.lang.Object value)

Forwarding method for adding a data item to the request

Parameters:

key - The item's key

value - The item's value

Returns:

The old value for the key, or null if there was no old value

get

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

Forwarding method for getting a data item from the request

Parameters:

key - The item's key

Returns:

The value for the key, or null if there was no value

getSessionId

public java.lang.String getSessionId()

Get the user's session ID

Returns:

The session ID

setSessionId

public void setSessionId(java.lang.String sessionId)

Set the user's session ID

Parameters:

sessionId - The session iD

getCommand

public java.lang.String getCommand()

Get the request's command (function family)

Returns:

The command for the request

setCommand

public void setCommand(java.lang.String command)

Set the request's command (function family)

Parameters:

command - The command for the request

getFunction

public java.lang.String getFunction()

Get the function name within the command

Returns:

The function name

setFunction

public void setFunction(java.lang.String function)

Set the function name within the command

Parameters:

function - The function name

isEcho

public boolean isEcho()

Get the echo property

Returns:

True if the request string is to be echoed back to the client

setEcho

public void setEcho(boolean echo)

Set the echo property

Parameters:

echo - True if the request string is to be echoed back to the client

getData

public java.util.Hashtable<java.lang.String,java.lang.Object> getData()

Get the function-specific input data

Returns:

The input data as a generic Hashtable object

setData

public void setData(java.util.Hashtable<java.lang.String,java.lang.Object> data)

Set the function-specific input data

Parameters:

data - The input data as a generic Hashtable object