JmsMessageConsumer

All Superinterfaces:: AutoCloseable, JmsPropertyContext, JmsReadablePropertyContext, Map<String,Object>, jakarta.jms.MessageConsumer, Serializable

All Known Subinterfaces:: JmsQueueReceiver, JmsTopicSubscriber

All Known Implementing Classes:: MQMessageConsumer, MQQueueReceiver, MQTopicSubscriber

public interface JmsMessageConsumer extends JmsPropertyContext, jakarta.jms.MessageConsumer

The JmsMessageConsumer interface adds properties to a jakarta.jms.MessageConsumer.

JmsMessageConsumer is the parent interface for all message consumers. A client uses a message consumer to receive messages from a Destination.

Note: Although this class extends a class which implements the Serializable Interface, it is not itself Serializable.

Nested Class Summary

Nested classes/interfaces inherited from interface Map
Map.Entry<K,V>
Method Summary

Modifier and Type

Method

Description

boolean

getNoLocal()

Indicates whether locally published messages are inhibited.

Methods inherited from interface JmsPropertyContext
setBatchProperties, setBooleanProperty, setByteProperty, setBytesProperty, setCharProperty, setDoubleProperty, setFloatProperty, setIntProperty, setLongProperty, setObjectProperty, setShortProperty, setStringProperty, toJson

Methods inherited from interface JmsReadablePropertyContext
getBooleanProperty, getByteProperty, getBytesProperty, getCharProperty, getDoubleProperty, getFloatProperty, getIntProperty, getLongProperty, getObjectProperty, getPropertyNames, getShortProperty, getStringProperty, propertyExists, stringifyMe

Methods inherited from interface Map
clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from interface jakarta.jms.MessageConsumer
close, getMessageListener, getMessageSelector, receive, receive, receiveNoWait, setMessageListener

Method Details
- getNoLocal
  
  boolean getNoLocal() throws jakarta.jms.JMSException
  
  Indicates whether locally published messages are inhibited.
  
  Returns:
  
  true means that locally published messages are inhibited.
  
  Throws:
  
  jakarta.jms.JMSException - if the message consumer is closed.