Package jmri.server.json.message

Class JsonMessage

java.lang.Object

jmri.server.json.message.JsonMessage

public class JsonMessage
extends Object

A message to be sent by the JMRI JSON message service.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	JsonMessage.TYPE

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLIENT	"client"
static final String	CONTEXT	"context"
static final String	MESSAGE	"message"

Constructor Summary

Constructors

Constructor	Description
JsonMessage(String message, Locale locale)	Create a message with an JsonMessage.TYPE.INFO type to be sent to all JSON clients.
JsonMessage(JsonMessage.TYPE type, String message, String client, com.fasterxml.jackson.databind.JsonNode context, Locale locale)	Create a message to be sent to the specified JSON client with the specified context.
JsonMessage(JsonMessage.TYPE type, String message, String client, Locale locale)	Create a message to be sent to the specified JSON client.
JsonMessage(JsonMessage.TYPE type, String message, Locale locale)	Create a message to be sent to all JSON clients.

Method Summary

Modifier and Type	Method	Description
String	getClient()
com.fasterxml.jackson.databind.JsonNode	getContext()
Locale	getLocale()
String	getMessage()
String	getType()	Get the JSON token for each of the message types used in the constructors.
void	send()	Send the message using the default JsonMessageClientManager.
com.fasterxml.jackson.databind.JsonNode	toJSON(com.fasterxml.jackson.databind.ObjectMapper mapper)	Create a JSON node from this message.

Methods inherited from class java.lang.Object

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

Field Details

CLIENT

public static final String CLIENT

"client"

See Also:

• Constant Field Values

MESSAGE

public static final String MESSAGE

"message"

See Also:

• Constant Field Values

CONTEXT

public static final String CONTEXT

"context"

See Also:

• Constant Field Values

Constructor Details

JsonMessage

public JsonMessage(@Nonnull
 String message,
 @Nonnull
 Locale locale)

Create a message with an JsonMessage.TYPE.INFO type to be sent to all JSON clients.

Parameters:

message - the message to send

locale - the locale of the message

JsonMessage

public JsonMessage(JsonMessage.TYPE type,
 @Nonnull
 String message,
 @Nonnull
 Locale locale)

Create a message to be sent to all JSON clients.

Parameters:

type - the message type

message - the message to send

locale - the locale of the message

JsonMessage

public JsonMessage(JsonMessage.TYPE type,
 @Nonnull
 String message,
 @CheckForNull
 String client,
 @Nonnull
 Locale locale)

Create a message to be sent to the specified JSON client.

Parameters:

type - the message type

message - the message to send

client - the client to send the message to; if null, the message is sent to all clients

locale - the locale of the message

JsonMessage

public JsonMessage(JsonMessage.TYPE type,
 @Nonnull
 String message,
 @CheckForNull
 String client,
 @CheckForNull
 com.fasterxml.jackson.databind.JsonNode context,
 @Nonnull
 Locale locale)

Create a message to be sent to the specified JSON client with the specified context.

Parameters:

type - the message type

message - the message to send

client - the client to send the message to; if null, the message is sent to all clients

context - the context for the message; if null, no context is sent

locale - the locale of the message

Method Details

send

public void send()

Send the message using the default JsonMessageClientManager.

To send a message to an alternate JsonMessageClientManager, call that manager's JsonMessageClientManager.send(jmri.server.json.message.JsonMessage) method.

getClient

public String getClient()

getContext

public com.fasterxml.jackson.databind.JsonNode getContext()

getMessage

public String getMessage()

getLocale

public Locale getLocale()

getType

public String getType()

Get the JSON token for each of the message types used in the constructors.

Returns:

the token value

toJSON

public com.fasterxml.jackson.databind.JsonNode toJSON(com.fasterxml.jackson.databind.ObjectMapper mapper)

Create a JSON node from this message.

Parameters:

mapper - the instance used to create raw JSON nodes

Returns:

the JSON node