Package com.helger.phase4.model.message

Interface IAS4Message

All Known Implementing Classes:
AbstractAS4Message, AS4ErrorMessage, AS4PullRequestMessage, AS4ReceiptMessage, AS4UserMessage
public interface IAS4Message
Base interface for an AS4 message.
Author:
Philip Helger

  • Method Details

    • getSoapVersion

      @Nonnull ESoapVersion getSoapVersion()
      Returns:
      The SOAP version to use. May not be null.
      Since:
      v0.9.8

    • getMessageType

      @Nonnull EAS4MessageType getMessageType()
      Returns:
      The type of the underlying message. Never null.

    • getMessagingID

      @Nonnull @Nonempty String getMessagingID()
      Returns:
      The ID of the "Messaging" element for referencing in signing. Should not be null. This is NOT the AS4 Message ID.

    • setMustUnderstand

      @Nonnull IAS4Message setMustUnderstand(boolean bMustUnderstand)
      Set the "mustUnderstand" value depending on the used SOAP version.
      Parameters:
      bMustUnderstand - true for must understand, false otherwise.
      Returns:
      this for chaining

    • getAsSoapDocument

      @Nonnull default Document getAsSoapDocument()
      Create a SOAP document from this message without a SOAP body payload.
      Returns:
      The created DOM document
      Since:
      v0.9.8
      See Also:

    • getAsSoapDocument

      @Nonnull Document getAsSoapDocument(@Nullable Node aSoapBodyPayload)
      Create a SOAP document from this message with the specified optional SOAP body payload. Attachments are not handled by this method.
      Parameters:
      aSoapBodyPayload - The payload to be added into the SOAP body. May be null.
      Returns:
      The created DOM document.
      Since:
      v0.9.8
      See Also: