Package jmri.server.json.message

Class JsonMessageServiceFactory

java.lang.Object

jmri.server.json.message.JsonMessageServiceFactory

All Implemented Interfaces:

JmriServiceProviderInterface, JsonServiceFactory<JsonMessageHttpService,JsonMessageSocketService>

public class JsonMessageServiceFactory
extends Object
implements JsonServiceFactory<JsonMessageHttpService,JsonMessageSocketService>

Service factory for the JSON messaging service.

Constructor Summary

Constructors

Constructor	Description
JsonMessageServiceFactory()

Method Summary

Modifier and Type	Method	Description
JsonMessageHttpService	getHttpService(com.fasterxml.jackson.databind.ObjectMapper mapper, String version)	Create a JSON HTTP service.
String[]	getSentTypes(String version)	Get the message type(s) services created by this factory send, if not also listed in JsonServiceFactory.getTypes(String).
JsonMessageSocketService	getSocketService(JsonConnection connection, String version)	Create a JSON service for the given connection.
String[]	getTypes(String version)	Get the service type(s) for services created by this factory respond to.

Methods inherited from class java.lang.Object

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

Methods inherited from interface jmri.spi.JsonServiceFactory

getReceivedTypes

Constructor Details

JsonMessageServiceFactory

public JsonMessageServiceFactory()

Method Details

getTypes

public String[] getTypes(String version)

Description copied from interface: JsonServiceFactory

Get the service type(s) for services created by this factory respond to. These type must have valid schemas for messages received from a client and sent to a client.

Types should be single words, in camelCase if needed, unless supporting a plural noun introduced in the JSON 1.x or 2.x protocols and exposed in the JSON 3.0 or newer protocol.

If a service returns no types, it will never be used.

Specified by:

getTypes in interface JsonServiceFactory<JsonMessageHttpService,JsonMessageSocketService>

Parameters:

version - The JSON protocol version major component identifier

Returns:

An array of types this service responds to

getSentTypes

public String[] getSentTypes(String version)

Description copied from interface: JsonServiceFactory

Get the message type(s) services created by this factory send, if not also listed in JsonServiceFactory.getTypes(String). These types must only have schemas for messages sent to a client.

Types should be single words, in camelCase if needed, unless supporting a plural noun introduced in the JSON 1.x or 2.x protocols and exposed in the JSON 3.0 or newer protocol.

Specified by:

getSentTypes in interface JsonServiceFactory<JsonMessageHttpService,JsonMessageSocketService>

Parameters:

version - The JSON protocol version major component identifier

Returns:

An array of types this service sends, but does not respond to

getSocketService

public JsonMessageSocketService getSocketService(JsonConnection connection,
 String version)

Description copied from interface: JsonServiceFactory

Create a JSON service for the given connection. This connection can be a WebSocket or raw socket.

Specified by:

getSocketService in interface JsonServiceFactory<JsonMessageHttpService,JsonMessageSocketService>

Parameters:

connection - The connection for this service to respond to

version - The JSON protocol version major component identifier

Returns:

A service or null if the service does not support sockets

getHttpService

public JsonMessageHttpService getHttpService(com.fasterxml.jackson.databind.ObjectMapper mapper,
 String version)

Description copied from interface: JsonServiceFactory

Create a JSON HTTP service.

Specified by:

getHttpService in interface JsonServiceFactory<JsonMessageHttpService,JsonMessageSocketService>

Parameters:

mapper - The object mapper for the HTTP service to use

version - The JSON protocol version major component identifier

Returns:

A servlet or null if the service does not support HTTP