Package io.axoniq.framework.springcloud.command

Record Class CommandDispatchRequest

java.lang.Object
java.lang.Record
io.axoniq.framework.springcloud.command.CommandDispatchRequest
Record Components:
identifier - the identifier of the command
type - the string form of the command's type, carrying both qualified name and version.
payload - the command's payload as its converter wrote it, or null when it has none
metadata - the metadata of the command
routingKey - the routing key of the command, or null when it has none
priority - the priority of the command, or null when it has none
public record CommandDispatchRequest(String identifier, String type, @Nullable String payload, Map<String,@Nullable String> metadata, @Nullable String routingKey, @Nullable Integer priority) extends Record
The wire representation of a CommandMessage being sent to another member of the cluster.

Fields mirror what the command bus needs on the far side to reconstruct an equivalent message: the identifier, the type, the payload, the metadata, and the routing key and priority the sending member resolved. The routing key travels along even though the receiving member has already been selected, because a handler may read it, and the priority travels along because the receiving member's own priority executor orders work by it.

The payload arrives here already written as text by the PayloadConvertingCommandBusConnector wrapped around the connector, and travels as it stands.

Since:
5.4.0
Author:
Allard Buijze

  • Constructor Details

    • CommandDispatchRequest

      public CommandDispatchRequest(String identifier, String type, @Nullable String payload, Map<String,@Nullable String> metadata, @Nullable String routingKey, @Nullable Integer priority)
      Compact constructor requiring an identifier and type, and defaulting null metadata to empty so a request from a member that omits the field still reads.
      Parameters:
      identifier - the identifier of the command
      type - the string form of the command's type, carrying both qualified name and version
      payload - the payload of the command as text, or null when it has none
      metadata - the metadata of the command
      routingKey - the routing key of the command, or null when it has none
      priority - the priority of the command, or null when it has none

  • Method Details

    • 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.

    • identifier

      public String identifier()
      Returns the value of the identifier record component.
      Returns:
      the value of the identifier record component

    • type

      public String type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component

    • payload

      public @Nullable String payload()
      Returns the value of the payload record component.
      Returns:
      the value of the payload record component

    • metadata

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

    • routingKey

      public @Nullable String routingKey()
      Returns the value of the routingKey record component.
      Returns:
      the value of the routingKey record component

    • priority

      public @Nullable Integer priority()
      Returns the value of the priority record component.
      Returns:
      the value of the priority record component