io.smallrye.reactive.messaging.jms

Class IncomingJmsMessage<T>

java.lang.Object

io.smallrye.reactive.messaging.jms.IncomingJmsMessage<T>

All Implemented Interfaces:

Message<T>

public class IncomingJmsMessage<T>
extends Object
implements Message<T>

Field Summary

Fields inherited from interface org.eclipse.microprofile.reactive.messaging.Message

LOGGER

Method Summary

Modifier and Type	Method and Description
CompletionStage<Void>	ack() Acknowledge this message.
Supplier<CompletionStage<Void>>	getAck()
Metadata	getMetadata()
T	getPayload()
<C> C	unwrap(Class<C> unwrapType) Returns an object of the specified type to allow access to the connector-specific Message implementation, and other classes.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.microprofile.reactive.messaging.Message

addMetadata, getMetadata, getNack, nack, nack, of, of, of, of, of, of, of, of, of, withAck, withMetadata, withMetadata, withNack, withPayload

Method Detail

getPayload

public T getPayload()

Specified by:

getPayload in interface Message<T>

Returns:

The payload for this message.

getAck

public Supplier<CompletionStage<Void>> getAck()

Specified by:

getAck in interface Message<T>

Returns:

the supplier used to retrieve the acknowledgement CompletionStage.

ack

public CompletionStage<Void> ack()

Description copied from interface: Message

Acknowledge this message.

Specified by:

ack in interface Message<T>

Returns:

a completion stage completed when the message is acknowledged. If the acknowledgement fails, the completion stage propagates the failure.

getMetadata

public Metadata getMetadata()

Specified by:

getMetadata in interface Message<T>

Returns:

The set of metadata attached to this message, potentially empty.

unwrap

public <C> C unwrap(Class<C> unwrapType)

Description copied from interface: Message

Returns an object of the specified type to allow access to the connector-specific Message implementation, and other classes. For example, a Kafka connector could implement this method to allow unwrapping to a specific Kafka message implementation, or to ConsumerRecord and ProducerRecord. If the Message implementation does not support the target class, an IllegalArgumentException should be raised.

The default implementation tries to cast the current Message instance to the target class. When a connector provides its own Message implementation, it should override this method to support specific types.

Specified by:

unwrap in interface Message<T>

Type Parameters:

C - the target type

Parameters:

unwrapType - the class of the object to be returned, must not be null

Returns:

an instance of the specified class