Package com.priint.pubserverapi.servermessages

Record Class ServerMessageRequest

java.lang.Object
java.lang.Record
com.priint.pubserverapi.servermessages.ServerMessageRequest
Record Components:
messagingCenter - identifier of the messaging center responsible for routing the message (e.g. "priint:planner")
topic - topic within the messaging center used to categorize the message (e.g. "rendering-status")
subject - short title or subject of the message
content - main textual content of the message
senderComponent - name of the server component that generated the message (e.g. "rendering-service")
recipientUserIds - list of user IDs that should receive the message
processReference - optional information about the BPM process that sent the message; references the associated ProcessReference
senderLogin - login of the user who initiated the process which sent the message
externalId - optional external identifier for correlating the message with object identifier
public record ServerMessageRequest(String messagingCenter, String topic, String subject, String content, String senderComponent, List<String> recipientUserIds, ProcessReference processReference, String senderLogin, String externalId) extends Record
Request object used to send a message to the messaging system.

This record represents a message generated by a server-side component that should be delivered to one or more users through a specific messaging center and topic.

Typical usage includes system notifications such as rendering status, processing updates, warnings, or informational messages.

  • Constructor Details

    • ServerMessageRequest

      public ServerMessageRequest(String messagingCenter, String topic, String subject, String content, String senderComponent, List<String> recipientUserIds, ProcessReference processReference, String senderLogin, String externalId)
      Creates an instance of a ServerMessageRequest record class.
      Parameters:
      messagingCenter - the value for the messagingCenter record component
      topic - the value for the topic record component
      subject - the value for the subject record component
      content - the value for the content record component
      senderComponent - the value for the senderComponent record component
      recipientUserIds - the value for the recipientUserIds record component
      processReference - the value for the processReference record component
      senderLogin - the value for the senderLogin record component
      externalId - the value for the externalId record component

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

    • messagingCenter

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

    • topic

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

    • subject

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

    • content

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

    • senderComponent

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

    • recipientUserIds

      public List<String> recipientUserIds()
      Returns the value of the recipientUserIds record component.
      Returns:
      the value of the recipientUserIds record component

    • processReference

      public ProcessReference processReference()
      Returns the value of the processReference record component.
      Returns:
      the value of the processReference record component

    • senderLogin

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

    • externalId

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