io.nats.service

Class ServiceMessage

java.lang.Object

io.nats.service.ServiceMessage

All Implemented Interfaces:

Message

public class ServiceMessage
extends java.lang.Object
implements Message

SERVICE IS AN EXPERIMENTAL API SUBJECT TO CHANGE

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NATS_SERVICE_ERROR
static java.lang.String	NATS_SERVICE_ERROR_CODE

Method Summary

Modifier and Type	Method and Description
void	ack() ack acknowledges a JetStream messages received from a Consumer, indicating the message should not be received again later.
void	ackSync(java.time.Duration timeout) ack acknowledges a JetStream messages received from a Consumer, indicating the message should not be received again later.
Connection	getConnection()
byte[]	getData()
io.nats.client.impl.Headers	getHeaders()
java.lang.String	getReplyTo()
java.lang.String	getSID()
Status	getStatus()
java.lang.String	getSubject()
Subscription	getSubscription()
boolean	hasHeaders()
void	inProgress() Indicates that this message is being worked on and reset redelivery timer in the server.
boolean	isJetStream() Checks if a message is from Jetstream or is a standard message.
boolean	isStatusMessage()
boolean	isUtf8mode()
io.nats.client.impl.AckType	lastAck() the last ack that was done with this message
io.nats.client.impl.NatsJetStreamMetaData	metaData() Gets the metadata associated with a JetStream message.
void	nak() nak acknowledges a JetStream message has been received but indicates that the message is not completely processed and should be sent again later.
void	nakWithDelay(java.time.Duration nakDelay) nak acknowledges a JetStream message has been received but indicates that the message is not completely processed and should be sent again later, after at least the delay amount.
void	nakWithDelay(long nakDelayMillis) nak acknowledges a JetStream message has been received but indicates that the message is not completely processed and should be sent again later, after at least the delay amount.
void	respond(Connection conn, byte[] response)
void	respond(Connection conn, byte[] response, io.nats.client.impl.Headers headers)
void	respond(Connection conn, JsonSerializable response)
void	respond(Connection conn, JsonSerializable response, io.nats.client.impl.Headers headers)
void	respond(Connection conn, java.lang.String response)
void	respond(Connection conn, java.lang.String response, io.nats.client.impl.Headers headers)
void	respondStandardError(Connection conn, java.lang.String errorMessage, int errorCode)
void	term() term prevents this message from every being delivered regardless of maxDeliverCount.

Methods inherited from class java.lang.Object

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

Field Detail

NATS_SERVICE_ERROR

public static final java.lang.String NATS_SERVICE_ERROR

See Also:

Constant Field Values

NATS_SERVICE_ERROR_CODE

public static final java.lang.String NATS_SERVICE_ERROR_CODE

See Also:

Constant Field Values

Method Detail

respond

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

respond

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

respond

public void respond(Connection conn,
                    JsonSerializable response)

respond

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

respond

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

respond

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

respondStandardError

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

getSubject

public java.lang.String getSubject()

Specified by:

getSubject in interface Message

Returns:

the subject that this message was sent to

getReplyTo

public java.lang.String getReplyTo()

Specified by:

getReplyTo in interface Message

Returns:

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

hasHeaders

public boolean hasHeaders()

Specified by:

hasHeaders in interface Message

Returns:

true if there are headers

getHeaders

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

Specified by:

getHeaders in interface Message

Returns:

the headers object the message

isStatusMessage

public boolean isStatusMessage()

Specified by:

isStatusMessage in interface Message

Returns:

true if there is status

getStatus

public Status getStatus()

Specified by:

getStatus in interface Message

Returns:

the status object message

getData

public byte[] getData()

Specified by:

getData in interface Message

Returns:

the data from the message

isUtf8mode

public boolean isUtf8mode()

Specified by:

isUtf8mode in interface Message

Returns:

if is utf8Mode

getSubscription

public Subscription getSubscription()

Specified by:

getSubscription in interface Message

Returns:

the Subscription associated with this message, may be owned by a Dispatcher

getSID

public java.lang.String getSID()

Specified by:

getSID in interface Message

Returns:

the id associated with the subscription, used by the connection when processing an incoming message from the server

getConnection

public Connection getConnection()

Specified by:

getConnection in interface Message

Returns:

the connection which can be used for publishing, will be null if the subscription is null

metaData

public io.nats.client.impl.NatsJetStreamMetaData metaData()

Description copied from interface: Message

Gets the metadata associated with a JetStream message.

Specified by:

metaData in interface Message

Returns:

metadata or null if the message is not a JetStream message.

lastAck

public io.nats.client.impl.AckType lastAck()

Description copied from interface: Message

the last ack that was done with this message

Specified by:

lastAck in interface Message

Returns:

the last ack or null

ack

public void ack()

Description copied from interface: Message

ack acknowledges a JetStream messages received from a Consumer, indicating the message should not be received again later.

Specified by:

ack in interface Message

ackSync

public void ackSync(java.time.Duration timeout)
             throws java.util.concurrent.TimeoutException,
                    java.lang.InterruptedException

Description copied from interface: Message

ack acknowledges a JetStream messages received from a Consumer, indicating the message should not be received again later. Duration.ZERO does not confirm the acknowledgement.

Specified by:

ackSync in interface Message

Parameters:

timeout - the duration to wait for an ack confirmation

Throws:

java.util.concurrent.TimeoutException - if a timeout was specified and the NATS server does not return a response

java.lang.InterruptedException - if the thread is interrupted

nak

public void nak()

Description copied from interface: Message

nak acknowledges a JetStream message has been received but indicates that the message is not completely processed and should be sent again later.

Specified by:

nak in interface Message

nakWithDelay

public void nakWithDelay(java.time.Duration nakDelay)

Description copied from interface: Message

nak acknowledges a JetStream message has been received but indicates that the message is not completely processed and should be sent again later, after at least the delay amount.

Specified by:

nakWithDelay in interface Message

Parameters:

nakDelay - tell the server how long to delay before processing the ack

nakWithDelay

public void nakWithDelay(long nakDelayMillis)

Description copied from interface: Message

nak acknowledges a JetStream message has been received but indicates that the message is not completely processed and should be sent again later, after at least the delay amount.

Specified by:

nakWithDelay in interface Message

Parameters:

nakDelayMillis - tell the server how long to delay before processing the ack

term

public void term()

Description copied from interface: Message

term prevents this message from every being delivered regardless of maxDeliverCount.

Specified by:

term in interface Message

inProgress

public void inProgress()

Description copied from interface: Message

Indicates that this message is being worked on and reset redelivery timer in the server.

Specified by:

inProgress in interface Message

isJetStream

public boolean isJetStream()

Description copied from interface: Message

Checks if a message is from Jetstream or is a standard message.

Specified by:

isJetStream in interface Message

Returns:

true if the message is from JetStream.