Package com.helger.phase4.messaging.domain

Class AS4ReceiptMessage

java.lang.Object

com.helger.phase4.messaging.domain.AbstractAS4Message<AS4ReceiptMessage>

com.helger.phase4.messaging.domain.AS4ReceiptMessage

All Implemented Interfaces:

com.helger.commons.traits.IGenericImplTrait<AS4ReceiptMessage>, IAS4Message

public class AS4ReceiptMessage
extends AbstractAS4Message<AS4ReceiptMessage>

AS4 receipt message

Author:

Philip Helger

Field Summary

Fields inherited from class com.helger.phase4.messaging.domain.AbstractAS4Message

m_aMessaging

Constructor Summary

Constructors

Constructor	Description
AS4ReceiptMessage(ESoapVersion eSoapVersion, Ebms3SignalMessage aSignalMessage)

Method Summary

Modifier and Type	Method	Description
static AS4ReceiptMessage	create(ESoapVersion eSoapVersion, String sMessageID, Ebms3UserMessage aEbms3UserMessageToRespond, Node aSoapDocument, boolean bShouldUseNonRepudiation)	This method creates a receipt message.
static com.helger.commons.collection.impl.ICommonsList<Node>	getAllDSigReferenceNodes(Node aSoapDocument)	Extract all "ds:Reference" nodes from the passed SOAP document.
static com.helger.commons.collection.impl.ICommonsList<com.helger.xsds.xmldsig.ReferenceType>	getAllDSigReferences(Node aSoapDocument)	This is the typed version of getAllDSigReferenceNodes(Node)
final Ebms3SignalMessage	getEbms3SignalMessage()

Methods inherited from class com.helger.phase4.messaging.domain.AbstractAS4Message

getAsSoapDocument, getMessageType, getMessagingID, getSoapVersion, setMustUnderstand, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.helger.phase4.messaging.domain.IAS4Message

getAsSoapDocument

Methods inherited from interface com.helger.commons.traits.IGenericImplTrait

thisAsT

Constructor Details

AS4ReceiptMessage

public AS4ReceiptMessage(@Nonnull
 ESoapVersion eSoapVersion,
 @Nonnull
 Ebms3SignalMessage aSignalMessage)

Method Details

getEbms3SignalMessage

@Nonnull
public final Ebms3SignalMessage getEbms3SignalMessage()

Returns:

The Ebms3SignalMessage passed in the constructor. Never null.

getAllDSigReferenceNodes

@Nonnull
@ReturnsMutableCopy
public static com.helger.commons.collection.impl.ICommonsList<Node> getAllDSigReferenceNodes(@Nullable
 Node aSoapDocument)

Extract all "ds:Reference" nodes from the passed SOAP document. This method search ins "{soapDocument}/Envelop/Header/Security/Signature/SignedInfo".
Note: use XMLDSigReaderBuilder.dsigReference ().read (aRef) to read the content

Parameters:

aSoapDocument - The SOAP document to search in. May be null.

Returns:

A non-null but maybe empty list of Reference nodes.

See Also:

• getAllDSigReferences(Node)

getAllDSigReferences

@Nonnull
@ReturnsMutableCopy
public static com.helger.commons.collection.impl.ICommonsList<com.helger.xsds.xmldsig.ReferenceType> getAllDSigReferences(@Nullable
 Node aSoapDocument)

This is the typed version of getAllDSigReferenceNodes(Node)

Parameters:

aSoapDocument - The SOAP document to search in. May be null.

Returns:

A non-null but maybe empty list of ReferenceType object.

create

@Nonnull
public static AS4ReceiptMessage create(@Nonnull
 ESoapVersion eSoapVersion,
 @Nonnull @Nonempty
 String sMessageID,
 @Nullable
 Ebms3UserMessage aEbms3UserMessageToRespond,
 @Nullable
 Node aSoapDocument,
 boolean bShouldUseNonRepudiation)

This method creates a receipt message.

Parameters:

eSoapVersion - SOAP Version which should be used

sMessageID - Message ID to use. May neither be null nor empty.

aEbms3UserMessageToRespond - The received usermessage which should be responded too. May be null.

aSoapDocument - If the SOAPDocument has WSS4j elements and the following parameter is true NonRepudiation will be used if the message is signed

bShouldUseNonRepudiation - If NonRepudiation should be used or not

Returns:

AS4ReceiptMessage