Package jmri.server.json.operations

Class JsonOperationsHttpService

java.lang.Object

jmri.server.json.JsonHttpService

jmri.server.json.operations.JsonOperationsHttpService

public class JsonOperationsHttpService
extends JsonHttpService

Field Summary

Fields inherited from class jmri.server.json.JsonHttpService

mapper

Constructor Summary

Constructors

Constructor	Description
JsonOperationsHttpService(com.fasterxml.jackson.databind.ObjectMapper mapper)

Method Summary

Modifier and Type	Method	Description
protected CarManager	carManager()
void	deleteCar(String name, Locale locale, int id)
void	deleteEngine(String name, Locale locale, int id)
void	deleteLocation(String name, Locale locale, int id)
void	deleteTrack(String name, com.fasterxml.jackson.databind.JsonNode data, Locale locale, int id)
void	doDelete(String type, String name, com.fasterxml.jackson.databind.JsonNode data, JsonRequest request)	Respond to an HTTP DELETE request for the requested name.
com.fasterxml.jackson.databind.JsonNode	doGet(String type, String name, com.fasterxml.jackson.databind.JsonNode data, JsonRequest request)	Respond to an HTTP GET request for the requested name.
com.fasterxml.jackson.databind.JsonNode	doGetList(String type, com.fasterxml.jackson.databind.JsonNode data, JsonRequest request)	Respond to an HTTP GET request for a list of items of type.
com.fasterxml.jackson.databind.JsonNode	doPost(String type, String name, com.fasterxml.jackson.databind.JsonNode data, JsonRequest request)	Respond to an HTTP POST request for the requested name.
com.fasterxml.jackson.databind.JsonNode	doPut(String type, String name, com.fasterxml.jackson.databind.JsonNode data, JsonRequest request)	Respond to an HTTP PUT request for the requested name.
com.fasterxml.jackson.databind.JsonNode	doSchema(String type, boolean server, JsonRequest request)	Get the JSON Schema for the data property of the requested type of JSON object.
protected EngineManager	engineManager()
protected Car	getCarByName(String name, Locale locale, int id)
com.fasterxml.jackson.databind.node.ArrayNode	getCars(Locale locale, int id)
protected Engine	getEngineByName(String name, Locale locale, int id)
com.fasterxml.jackson.databind.node.ArrayNode	getEngines(Locale locale, int id)
protected Location	getLocationByName(String name, Locale locale, int id)
com.fasterxml.jackson.databind.JsonNode	getLocations(Locale locale, int id)
protected Track	getTrackByName(String name, com.fasterxml.jackson.databind.JsonNode data, Locale locale, int id)
com.fasterxml.jackson.databind.JsonNode	getTrains(Locale locale, int id)
protected LocationManager	locationManager()
com.fasterxml.jackson.databind.node.ObjectNode	postCar(String name, com.fasterxml.jackson.databind.JsonNode data, Locale locale, int id)	Set the properties in the data parameter for the given car.
com.fasterxml.jackson.databind.node.ObjectNode	postCar(Car car, com.fasterxml.jackson.databind.JsonNode data, Locale locale, int id)	Set the properties in the data parameter for the given car.
com.fasterxml.jackson.databind.node.ObjectNode	postEngine(String name, com.fasterxml.jackson.databind.JsonNode data, Locale locale, int id)	Set the properties in the data parameter for the given engine.
com.fasterxml.jackson.databind.node.ObjectNode	postEngine(Engine engine, com.fasterxml.jackson.databind.JsonNode data, Locale locale, int id)	Set the properties in the data parameter for the given engine.
com.fasterxml.jackson.databind.node.ObjectNode	postLocation(String name, com.fasterxml.jackson.databind.JsonNode data, Locale locale, int id)
com.fasterxml.jackson.databind.node.ObjectNode	postLocation(Location location, com.fasterxml.jackson.databind.JsonNode data, Locale locale, int id)
com.fasterxml.jackson.databind.node.ObjectNode	postRollingStock(RollingStock rs, com.fasterxml.jackson.databind.JsonNode data, Locale locale, int id)	Set the properties in the data parameter for the given rolling stock.
com.fasterxml.jackson.databind.node.ObjectNode	postTrack(String name, com.fasterxml.jackson.databind.JsonNode data, Locale locale, int id)
com.fasterxml.jackson.databind.node.ObjectNode	postTrack(Track track, com.fasterxml.jackson.databind.JsonNode data, Locale locale, int id)
void	setTrain(String name, com.fasterxml.jackson.databind.JsonNode data, Locale locale, int id)	Set the properties in the data parameter for the train with the given id.
protected TrainManager	trainManager()

Methods inherited from class jmri.server.json.JsonHttpService

acceptForceDeleteToken, doSchema, doSchema, getObjectMapper, message, message, message, message, message, throwDeleteConflictException

Methods inherited from class java.lang.Object

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

Constructor Details

JsonOperationsHttpService

public JsonOperationsHttpService(com.fasterxml.jackson.databind.ObjectMapper mapper)

Method Details

doGet

public com.fasterxml.jackson.databind.JsonNode doGet(String type,
 String name,
 com.fasterxml.jackson.databind.JsonNode data,
 JsonRequest request)
                                              throws JsonException

Description copied from class: JsonHttpService

Respond to an HTTP GET request for the requested name.

If name is null, return a list of all objects for the given type, if appropriate.

This method should throw a 500 Internal Server Error if type is not recognized.

Specified by:

doGet in class JsonHttpService

Parameters:

type - the type of the requested object

name - the system name of the requested object

data - JSON data set of attributes of the requested object

request - the JSON request

Returns:

a JSON description of the requested object

Throws:

JsonException - if the named object does not exist or other error occurs

doPost

public com.fasterxml.jackson.databind.JsonNode doPost(String type,
 String name,
 com.fasterxml.jackson.databind.JsonNode data,
 JsonRequest request)
                                               throws JsonException

Description copied from class: JsonHttpService

Respond to an HTTP POST request for the requested name.

This method should throw a 400 Invalid Request error if the named object does not exist.

Specified by:

doPost in class JsonHttpService

Parameters:

type - the type of the requested object

name - the system name of the requested object

data - JSON data set of attributes of the requested object to be updated

request - the JSON request

Returns:

a JSON description of the requested object after updates have been applied

Throws:

JsonException - if the named object does not exist or other error occurs

doPut

public com.fasterxml.jackson.databind.JsonNode doPut(String type,
 String name,
 com.fasterxml.jackson.databind.JsonNode data,
 JsonRequest request)
                                              throws JsonException

Description copied from class: JsonHttpService

Respond to an HTTP PUT request for the requested name.

Throw an HTTP 405 Method Not Allowed exception if new objects of the type are not intended to be addable.

Overrides:

doPut in class JsonHttpService

Parameters:

type - the type of the requested object

name - the system name of the requested object

data - JSON data set of attributes of the requested object to be created or updated

request - the JSON request

Returns:

a JSON description of the requested object

Throws:

JsonException - if the method is not allowed or other error occurs

doGetList

public com.fasterxml.jackson.databind.JsonNode doGetList(String type,
 com.fasterxml.jackson.databind.JsonNode data,
 JsonRequest request)
                                                  throws JsonException

Description copied from class: JsonHttpService

Respond to an HTTP GET request for a list of items of type.

This is called by the JsonServlet to handle get requests for a type, but no name. Services that do not have named objects, such as the JsonTimeHttpService should respond to this with a list containing a single JSON object. Services that can't return a list may throw a 400 Bad Request JsonException in this case.

Specified by:

doGetList in class JsonHttpService

Parameters:

type - the type of the requested list

data - JSON data set of attributes of the requested objects

request - the JSON request

Returns:

a JSON list or message containing type "list", the list as data, and the passed in id

Throws:

JsonException - may be thrown by concrete implementations

doDelete

public void doDelete(String type,
 String name,
 com.fasterxml.jackson.databind.JsonNode data,
 JsonRequest request)
              throws JsonException

Description copied from class: JsonHttpService

Respond to an HTTP DELETE request for the requested name.

Throw an HTTP 405 Method Not Allowed exception if the object is not intended to be removable.

Do not throw an error if the requested object does not exist.

Overrides:

doDelete in class JsonHttpService

Parameters:

type - the type of the deleted object

name - the system name of the deleted object

data - additional data

request - the JSON request

Throws:

JsonException - if this method is not allowed or other error occurs

getCars

public com.fasterxml.jackson.databind.node.ArrayNode getCars(Locale locale,
 int id)

getEngines

public com.fasterxml.jackson.databind.node.ArrayNode getEngines(Locale locale,
 int id)

getLocations

public com.fasterxml.jackson.databind.JsonNode getLocations(Locale locale,
 int id)

getTrains

public com.fasterxml.jackson.databind.JsonNode getTrains(Locale locale,
 int id)

setTrain

public void setTrain(String name,
 com.fasterxml.jackson.databind.JsonNode data,
 Locale locale,
 int id)
              throws JsonException

Set the properties in the data parameter for the train with the given id.

Currently only moves the train to the location given with the key LOCATION. If the move cannot be completed, throws error code 428.

Parameters:

name - id of the train

data - train data to change

locale - locale to throw exceptions in

id - message id set by client

Throws:

JsonException - if the train cannot move to the location in data.

postLocation

public com.fasterxml.jackson.databind.node.ObjectNode postLocation(String name,
 com.fasterxml.jackson.databind.JsonNode data,
 Locale locale,
 int id)
                                                            throws JsonException

Throws:

JsonException

postLocation

public com.fasterxml.jackson.databind.node.ObjectNode postLocation(Location location,
 com.fasterxml.jackson.databind.JsonNode data,
 Locale locale,
 int id)
                                                            throws JsonException

Throws:

JsonException

postTrack

public com.fasterxml.jackson.databind.node.ObjectNode postTrack(String name,
 com.fasterxml.jackson.databind.JsonNode data,
 Locale locale,
 int id)
                                                         throws JsonException

Throws:

JsonException

postTrack

public com.fasterxml.jackson.databind.node.ObjectNode postTrack(Track track,
 com.fasterxml.jackson.databind.JsonNode data,
 Locale locale,
 int id)
                                                         throws JsonException

Throws:

JsonException

postCar

public com.fasterxml.jackson.databind.node.ObjectNode postCar(String name,
 com.fasterxml.jackson.databind.JsonNode data,
 Locale locale,
 int id)
                                                       throws JsonException

Set the properties in the data parameter for the given car.

Note returns the modified car because changing the road or number of a car changes its name in the JSON representation.

Parameters:

name - the operations id of the car to change

data - car data to change

locale - locale to throw exceptions in

id - message id set by client

Returns:

the JSON representation of the car

Throws:

JsonException - if a car by name cannot be found

postCar

public com.fasterxml.jackson.databind.node.ObjectNode postCar(@Nonnull
 Car car,
 com.fasterxml.jackson.databind.JsonNode data,
 Locale locale,
 int id)
                                                       throws JsonException

Set the properties in the data parameter for the given car.

Note returns the modified car because changing the road or number of a car changes its name in the JSON representation.

Parameters:

car - the car to change

data - car data to change

locale - locale to throw exceptions in

id - message id set by client

Returns:

the JSON representation of the car

Throws:

JsonException - if unable to set location

postEngine

public com.fasterxml.jackson.databind.node.ObjectNode postEngine(String name,
 com.fasterxml.jackson.databind.JsonNode data,
 Locale locale,
 int id)
                                                          throws JsonException

Set the properties in the data parameter for the given engine.

Note returns the modified engine because changing the road or number of an engine changes its name in the JSON representation.

Parameters:

name - the operations id of the engine to change

data - engine data to change

locale - locale to throw exceptions in

id - message id set by client

Returns:

the JSON representation of the engine

Throws:

JsonException - if a engine by name cannot be found

postEngine

public com.fasterxml.jackson.databind.node.ObjectNode postEngine(@Nonnull
 Engine engine,
 com.fasterxml.jackson.databind.JsonNode data,
 Locale locale,
 int id)
                                                          throws JsonException

Set the properties in the data parameter for the given engine.

Note returns the modified engine because changing the road or number of an engine changes its name in the JSON representation.

Parameters:

engine - the engine to change

data - engine data to change

locale - locale to throw exceptions in

id - message id set by client

Returns:

the JSON representation of the engine

Throws:

JsonException - if unable to set location

postRollingStock

public com.fasterxml.jackson.databind.node.ObjectNode postRollingStock(@Nonnull
 RollingStock rs,
 com.fasterxml.jackson.databind.JsonNode data,
 Locale locale,
 int id)
                                                                throws JsonException

Set the properties in the data parameter for the given rolling stock.

Note returns the modified rolling stock because changing the road or number of a rolling stock changes its name in the JSON representation.

Parameters:

rs - the rolling stock to change

data - rolling stock data to change

locale - locale to throw exceptions in

id - message id set by client

Returns:

the JSON representation of the rolling stock

Throws:

JsonException - if unable to set location

deleteCar

public void deleteCar(@Nonnull
 String name,
 @Nonnull
 Locale locale,
 int id)
               throws JsonException

Throws:

JsonException

deleteEngine

public void deleteEngine(@Nonnull
 String name,
 @Nonnull
 Locale locale,
 int id)
                  throws JsonException

Throws:

JsonException

deleteLocation

public void deleteLocation(@Nonnull
 String name,
 @Nonnull
 Locale locale,
 int id)
                    throws JsonException

Throws:

JsonException

deleteTrack

public void deleteTrack(@Nonnull
 String name,
 @Nonnull
 com.fasterxml.jackson.databind.JsonNode data,
 @Nonnull
 Locale locale,
 int id)
                 throws JsonException

Throws:

JsonException

getCarByName

@Nonnull
protected Car getCarByName(@Nonnull
 String name,
 @Nonnull
 Locale locale,
 int id)
                    throws JsonException

Throws:

JsonException

getEngineByName

@Nonnull
protected Engine getEngineByName(@Nonnull
 String name,
 @Nonnull
 Locale locale,
 int id)
                          throws JsonException

Throws:

JsonException

getLocationByName

@Nonnull
protected Location getLocationByName(@Nonnull
 String name,
 @Nonnull
 Locale locale,
 int id)
                              throws JsonException

Throws:

JsonException

getTrackByName

@Nonnull
protected Track getTrackByName(@Nonnull
 String name,
 @Nonnull
 com.fasterxml.jackson.databind.JsonNode data,
 @Nonnull
 Locale locale,
 int id)
                        throws JsonException

Throws:

JsonException

carManager

protected CarManager carManager()

engineManager

protected EngineManager engineManager()

locationManager

protected LocationManager locationManager()

trainManager

protected TrainManager trainManager()

doSchema

public com.fasterxml.jackson.databind.JsonNode doSchema(String type,
 boolean server,
 JsonRequest request)
                                                 throws JsonException

Description copied from class: JsonHttpService

Get the JSON Schema for the data property of the requested type of JSON object. It is a invalid for implementations to not return a valid schema that clients can use to validate a request to or response from the JSON services.

Note that a schema must be contained in a standard object as:

{"type":"schema", "data":{"schema":<em>schema</em>, "server":boolean}}

If using JsonHttpService.doSchema(String, boolean, String, String, int), an implementation can be as simple as: return doSchema(type, server, "path/to/client/schema.json", "path/to/server/schema.json", id);

Specified by:

doSchema in class JsonHttpService

Parameters:

type - the type for which a schema is requested

server - true if the schema is for a message from the server; false if the schema is for a message from the client

request - the JSON request

Returns:

a JSON Schema valid for the type

Throws:

JsonException - if an error occurs preparing schema; if type is is not a type handled by this service, this must be thrown with an error code of 500 and the localized message ERROR_UNKNOWN_TYPE