com.helger.phase4.messaging.domain

Interface IAS4Message

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbstractAS4Message, AS4ErrorMessage, AS4PullRequestMessage, AS4ReceiptMessage, AS4UserMessage

public interface IAS4Message
extends Serializable

Base interface for an AS4 message.

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
default Document	getAsSoapDocument() Create a SOAP document from this message without a payload.
Document	getAsSoapDocument(Node aPayload) Create a SOAP document from this message with the specified optional payload.
EAS4MessageType	getMessageType()
String	getMessagingID()
ESoapVersion	getSoapVersion()
IAS4Message	setMustUnderstand(boolean bMustUnderstand) Set the "mustUnderstand" value depending on the used SOAP version.

Method Detail

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.

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

Returns:

The created DOM document

Since:

v0.9.8

getAsSoapDocument

@Nonnull
Document getAsSoapDocument(@Nullable
                                     Node aPayload)

Create a SOAP document from this message with the specified optional payload. Attachments are not handled by this method.

Parameters:

aPayload - The payload to be added into the SOAP body. May be null.

Returns:

The created DOM document.

Since:

v0.9.8