Record Class MessageHeader

java.lang.Object
java.lang.Record
org.j7m.middleware.api.messaging.MessageHeader
Record Components:
metadata - safe metadata map
All Implemented Interfaces:
Serializable
public record MessageHeader(Map<String,String> metadata) extends Record implements Serializable
Safe public metadata attached to a durable queue message.

The record is immutable, serializable, and thread-safe. Implementations must preserve this metadata through durable enqueue, outbox recording, and recovery. Header keys and values are intended for routing and diagnostics and must not contain raw payload data or secrets.

See Also:

  • Constructor Details

    • MessageHeader

      public MessageHeader(Map<String,String> metadata)
      Creates validated message header metadata.
      Throws:
      IllegalArgumentException - when a key or value is blank, too long, or not log-safe

  • Method Details

    • empty

      public static MessageHeader empty()
      Returns an empty immutable header.
      Returns:
      empty header

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • metadata

      public Map<String,String> metadata()
      Returns the value of the metadata record component.
      Returns:
      the value of the metadata record component