io.nats.service

Class ServiceMessage

java.lang.Object

io.nats.service.ServiceMessage

public class ServiceMessage
extends java.lang.Object

Service Message is service specific object that exposes the service relevant parts of a NATS Message.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NATS_SERVICE_ERROR Standard header name used to report the text of an error
static java.lang.String	NATS_SERVICE_ERROR_CODE Standard header name used to report the code of an error

Method Summary

Modifier and Type	Method and Description
byte[]	getData() the data from the message
io.nats.client.impl.Headers	getHeaders() the headers object for the message
java.lang.String	getReplyTo() the subject the application is expected to send a reply message on
java.lang.String	getSubject() the subject that this message was sent to
boolean	hasHeaders() true if there are headers
void	respond(Connection conn, byte[] response) Respond to a service request message.
void	respond(Connection conn, byte[] response, io.nats.client.impl.Headers headers) Respond to a service request message with a response and custom headers.
void	respond(Connection conn, io.nats.client.support.JsonSerializable response) Respond to a service request message.
void	respond(Connection conn, io.nats.client.support.JsonSerializable response, io.nats.client.impl.Headers headers) Respond to a service request message.
void	respond(Connection conn, java.lang.String response) Respond to a service request message.
void	respond(Connection conn, java.lang.String response, io.nats.client.impl.Headers headers) Respond to a service request message with a response and custom headers.
void	respondStandardError(Connection conn, java.lang.String errorText, int errorCode) Respond to a service request message with a standard error.

Methods inherited from class java.lang.Object

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

Field Detail

NATS_SERVICE_ERROR

public static final java.lang.String NATS_SERVICE_ERROR

Standard header name used to report the text of an error

See Also:

Constant Field Values

NATS_SERVICE_ERROR_CODE

public static final java.lang.String NATS_SERVICE_ERROR_CODE

Standard header name used to report the code of an error

See Also:

Constant Field Values

Method Detail

respond

public void respond(Connection conn,
                    byte[] response)

Respond to a service request message.

Parameters:

conn - the NATS connection

response - the response payload in the form of a byte array

respond

public void respond(Connection conn,
                    java.lang.String response)

Respond to a service request message.

Parameters:

conn - the NATS connection

response - the response payload in the form of a string

respond

public void respond(Connection conn,
                    io.nats.client.support.JsonSerializable response)

Respond to a service request message.

Parameters:

conn - the NATS connection

response - the response payload in the form of a JsonSerializable object

respond

public void respond(Connection conn,
                    byte[] response,
                    io.nats.client.impl.Headers headers)

Respond to a service request message with a response and custom headers.

Parameters:

conn - the NATS connection

response - the response payload in the form of a byte array

headers - the custom headers

respond

public void respond(Connection conn,
                    java.lang.String response,
                    io.nats.client.impl.Headers headers)

Respond to a service request message with a response and custom headers.

Parameters:

conn - the NATS connection

response - the response payload in the form of a string

headers - the custom headers

respond

public void respond(Connection conn,
                    io.nats.client.support.JsonSerializable response,
                    io.nats.client.impl.Headers headers)

Respond to a service request message.

Parameters:

conn - the NATS connection

response - the response payload in the form of a JsonSerializable object

headers - the custom headers

respondStandardError

public void respondStandardError(Connection conn,
                                 java.lang.String errorText,
                                 int errorCode)

Respond to a service request message with a standard error.

Parameters:

conn - the NATS connection

errorText - the error message text

errorCode - the error message code

getSubject

public java.lang.String getSubject()

the subject that this message was sent to

Returns:

the subject that this message was sent to

getReplyTo

public java.lang.String getReplyTo()

the subject the application is expected to send a reply message on

Returns:

the subject the application is expected to send a reply message on

hasHeaders

public boolean hasHeaders()

true if there are headers

Returns:

true if there are headers

getHeaders

public io.nats.client.impl.Headers getHeaders()

the headers object for the message

Returns:

the headers object for the message

getData

public byte[] getData()

the data from the message

Returns:

the data from the message