Package jmri.server.json.consist
Class JsonConsistSocketService
- java.lang.Object
-
- jmri.server.json.JsonSocketService<JsonConsistHttpService>
-
- jmri.server.json.consist.JsonConsistSocketService
-
public class JsonConsistSocketService extends JsonSocketService<JsonConsistHttpService>
-
-
Field Summary
-
Fields inherited from class jmri.server.json.JsonSocketService
connection, service
-
-
Constructor Summary
Constructors Constructor Description JsonConsistSocketService(JsonConnection connection)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
onClose()
Perform any teardown required when closing a connection.void
onList(java.lang.String type, com.fasterxml.jackson.databind.JsonNode data, JsonRequest request)
Handle a request for a list of objects.void
onMessage(java.lang.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
-
-
-
-
Constructor Detail
-
JsonConsistSocketService
public JsonConsistSocketService(JsonConnection connection)
-
-
Method Detail
-
onMessage
public void onMessage(java.lang.String type, com.fasterxml.jackson.databind.JsonNode data, JsonRequest request) throws java.io.IOException, JmriException, JsonException
Description copied from class:JsonSocketService
Handle an inbound message.- Specified by:
onMessage
in classJsonSocketService<JsonConsistHttpService>
- Parameters:
type
- The service type; if the implementing service responds to multiple types, it will need to use this to handle data correctlydata
- JSON data; the contents of this will depend on the implementing servicerequest
- The JSON request- Throws:
java.io.IOException
- Thrown if the service cannot send a response; this will cause the JSON Server to close its connection to the client if openJmriException
- Thrown if the request cannot be handled; throwing this will cause the JSON Server to pass a 500 UnsupportedOperation message to the clientJsonException
- Thrown if the service needs to pass an error message back to the client
-
onList
public void onList(java.lang.String type, com.fasterxml.jackson.databind.JsonNode data, JsonRequest request) throws java.io.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 classJsonSocketService<JsonConsistHttpService>
- Parameters:
type
- The service type; if the implementing service responds to multiple types, it will need to use this to handle data correctlydata
- JSON data; the contents of this will depend on the implementing servicerequest
- The JSON request- Throws:
java.io.IOException
- Thrown if the service cannot send a response; this will cause the JSON Server to close its connection to the client if openJmriException
- Thrown if the request cannot be handled; throwing this will cause the JSON Server to pass a 500 UnsupportedOperation message to the clientJsonException
- 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 thattype
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 classJsonSocketService<JsonConsistHttpService>
-
-