Package jmri.server.json.util

Class JsonUtilSocketService

java.lang.Object

jmri.server.json.JsonSocketService<JsonUtilHttpService>

jmri.server.json.util.JsonUtilSocketService

public class JsonUtilSocketService
extends JsonSocketService<JsonUtilHttpService>

Field Summary

Fields inherited from class jmri.server.json.JsonSocketService

connection, service

Constructor Summary

Constructors

Constructor	Description
JsonUtilSocketService(JsonConnection connection)
JsonUtilSocketService(JsonConnection connection, JsonUtilHttpService service)	Package protected method for unit testing that allows a test HTTP service to be used.

Method Summary

Modifier and Type	Method	Description
void	onClose()	Perform any teardown required when closing a connection.
void	onList(String type, com.fasterxml.jackson.databind.JsonNode data, JsonRequest request)	Handle a request for a list of objects.
void	onMessage(String type, com.fasterxml.jackson.databind.JsonNode data, JsonRequest request)	Handle an inbound message.

Methods inherited from class jmri.server.json.JsonSocketService

getConnection, getHttpService, getLocale, getVersion

Methods inherited from class java.lang.Object

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

Constructor Details

JsonUtilSocketService

public JsonUtilSocketService(JsonConnection connection)

JsonUtilSocketService

JsonUtilSocketService(JsonConnection connection,
 JsonUtilHttpService service)

Package protected method for unit testing that allows a test HTTP service to be used.

Parameters:

connection - the connection to use

service - the supporting HTTP service

Method Details

onMessage

public void onMessage(String type,
 com.fasterxml.jackson.databind.JsonNode data,
 JsonRequest request)
               throws IOException,
JmriException,
JsonException

Description copied from class: JsonSocketService

Handle an inbound message.

Specified by:

onMessage in class JsonSocketService<JsonUtilHttpService>

Parameters:

type - The service type; if the implementing service responds to multiple types, it will need to use this to handle data correctly

data - JSON data; the contents of this will depend on the implementing service

request - The JSON request

Throws:

IOException - Thrown if the service cannot send a response; this will cause the JSON Server to close its connection to the client if open

JmriException - Thrown if the request cannot be handled; throwing this will cause the JSON Server to pass a 500 UnsupportedOperation message to the client

JsonException - Thrown if the service needs to pass an error message back to the client

onList

public void onList(String type,
 com.fasterxml.jackson.databind.JsonNode data,
 JsonRequest request)
            throws IOException,
JmriException,
JsonException

Description copied from class: JsonSocketService

Handle a request for a list of objects. Note that this should not create listeners for items in the list, but should only create listeners for the object providing the list, if applicable.

Specified by:

onList in class JsonSocketService<JsonUtilHttpService>

Parameters:

type - The service type; if the implementing service responds to multiple types, it will need to use this to handle data correctly

data - JSON data; the contents of this will depend on the implementing service

request - The JSON request

Throws:

IOException - Thrown if the service cannot send a response; this will cause the JSON Server to close its connection to the client if open

JmriException - Thrown if the request cannot be handled; throwing this will cause the JSON Server to pass a 500 UnsupportedOperation message to the client

JsonException - If the service needs to pass an error message back to the client; implementing services may throw a JsonException with code 400 and the localized message "UnlistableService" to indicate that type should not be listed

onClose

public void onClose()

Description copied from class: JsonSocketService

Perform any teardown required when closing a connection.

Specified by:

onClose in class JsonSocketService<JsonUtilHttpService>