Package io.smallrye.reactive.messaging.jms

Interface JmsProperties

All Known Implementing Classes:
ImmutableJmsProperties, IncomingJmsMessageMetadata, JmsPropertiesBuilder.OutgoingJmsProperties
public interface JmsProperties
Structure handling JMS Message properties. Instances of this interface must be immutable.

  • Method Details

    • builder

      static JmsPropertiesBuilder builder()
      Creates a builder object to create JMS Properties
      Returns:
      the builder.

    • propertyExists

      boolean propertyExists(String name)
      Indicates whether a property value exists.
      Parameters:
      name - the name of the property to test
      Returns:
      true if the property exists

    • getBooleanProperty

      boolean getBooleanProperty(String name)
      Returns the value of the boolean property with the specified name.
      Parameters:
      name - the name of the boolean property
      Returns:
      the boolean property value for the specified name

    • getByteProperty

      byte getByteProperty(String name)
      Returns the value of the byte property with the specified name.
      Parameters:
      name - the name of the byte property
      Returns:
      the byte property value for the specified name

    • getShortProperty

      short getShortProperty(String name)
      Returns the value of the short property with the specified name.
      Parameters:
      name - the name of the short property
      Returns:
      the short property value for the specified name

    • getIntProperty

      int getIntProperty(String name)
      Returns the value of the int property with the specified name.
      Parameters:
      name - the name of the int property
      Returns:
      the int property value for the specified name

    • getLongProperty

      long getLongProperty(String name)
      Returns the value of the long property with the specified name.
      Parameters:
      name - the name of the long property
      Returns:
      the long property value for the specified name

    • getFloatProperty

      float getFloatProperty(String name)
      Returns the value of the float property with the specified name.
      Parameters:
      name - the name of the float property
      Returns:
      the float property value for the specified name

    • getDoubleProperty

      double getDoubleProperty(String name)
      Returns the value of the double property with the specified name.
      Parameters:
      name - the name of the double property
      Returns:
      the double property value for the specified name

    • getStringProperty

      String getStringProperty(String name)
      Returns the value of the String property with the specified name.
      Parameters:
      name - the name of the String property
      Returns:
      the String property value for the specified name; if there is no property by this name, a null value is returned

    • getObjectProperty

      Object getObjectProperty(String name)
      Returns the value of the Java object property with the specified name.

      This method can be used to return, in objectified format, an object that has been stored as a property in the message with the equivalent setObjectProperty method call, or its equivalent primitive settypeProperty method.

      Parameters:
      name - the name of the Java object property
      Returns:
      the Java object property value with the specified name, in objectified format (for example, if the property was set as an int, an Integer is returned); if there is no property by this name, a null value is returned

    • getPropertyNames

      Enumeration<String> getPropertyNames()
      Returns an Enumeration of all the property names.

      Note that Jakarta Messaging standard header fields are not considered properties and are not returned in this enumeration.

      Returns:
      an enumeration of all the names of property values