com.helger.phase4.client

Class AS4ClientReceiptMessage

java.lang.Object

com.helger.phase4.client.BasicHttpPoster

com.helger.phase4.client.AbstractAS4Client<IMPLTYPE>

com.helger.phase4.client.AbstractAS4ClientSignalMessage<AS4ClientReceiptMessage>

com.helger.phase4.client.AS4ClientReceiptMessage

All Implemented Interfaces:

com.helger.commons.traits.IGenericImplTrait<AS4ClientReceiptMessage>

public class AS4ClientReceiptMessage
extends AbstractAS4ClientSignalMessage<AS4ClientReceiptMessage>

AS4 client for AS4ReceiptMessage objects.

Author:

Philip Helger

Field Summary

Fields inherited from class com.helger.phase4.client.AbstractAS4Client

DEFAULT_MAX_RETRIES, DEFAULT_RETRY_INTERVAL_MS

Constructor Summary

Constructors

Constructor and Description
AS4ClientReceiptMessage(AS4ResourceHelper aResHelper)

Method Summary

Modifier and Type	Method and Description
AS4ClientBuiltMessage	buildMessage(String sMessageID, IAS4ClientBuildMessageCallback aCallback) Build the AS4 message to be sent.
Ebms3UserMessage	getEbms3UserMessage()
Node	getSoapDocument()
boolean	isNonRepudiation() Default value is false
boolean	isReceiptShouldBeSigned()
AS4ClientReceiptMessage	setEbms3UserMessage(Ebms3UserMessage aEbms3UserMessage) Needs to be set to refer to the message which this receipt is the response and if non-repudiation is not used, to fill the receipt content
AS4ClientReceiptMessage	setNonRepudiation(boolean bNonRepudiation)
AS4ClientReceiptMessage	setReceiptShouldBeSigned(boolean bReceiptShouldBeSigned)
AS4ClientReceiptMessage	setSoapDocument(Node aSoapDocument) As node set the usermessage if it is signed, so the references can be counted and used in non repudiation.

Methods inherited from class com.helger.phase4.client.AbstractAS4ClientSignalMessage

any

Methods inherited from class com.helger.phase4.client.AbstractAS4Client

createDefaultMessageIDFactory, createMessageID, cryptParams, getAS4CryptoFactory, getAS4ResourceHelper, getMaxRetries, getMessageIDFactory, getRefToMessageID, getRetryIntervalMS, getSoapVersion, hasRefToMessageID, internalCreateCryptoFactory, sendMessageAndGetMicroDocument, sendMessageWithRetries, sendMessageWithRetries, setAS4CryptoFactory, setMaxRetries, setMessageID, setMessageIDFactory, setRefToMessageID, setRetryIntervalMS, setSoapVersion, setValuesFromPMode, signingParams

Methods inherited from class com.helger.phase4.client.BasicHttpPoster

createDefaultHttpClientFactory, getHttpClientFactory, getHttpCustomizer, isQuoteHttpHeaders, sendGenericMessage, sendGenericMessageWithRetries, setHttpClientFactory, setHttpCustomizer, setQuoteHttpHeaders, toString

Methods inherited from class java.lang.Object

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

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

thisAsT

Constructor Detail

AS4ClientReceiptMessage

public AS4ClientReceiptMessage(@Nonnull @WillNotClose
                               AS4ResourceHelper aResHelper)

Method Detail

isNonRepudiation

public final boolean isNonRepudiation()

Default value is false

Returns:

if non-repudiation is used or not

setNonRepudiation

@Nonnull
public final AS4ClientReceiptMessage setNonRepudiation(boolean bNonRepudiation)

getSoapDocument

@Nullable
public final Node getSoapDocument()

setSoapDocument

@Nonnull
public final AS4ClientReceiptMessage setSoapDocument(@Nullable
                                                               Node aSoapDocument)

As node set the usermessage if it is signed, so the references can be counted and used in non repudiation.

Parameters:

aSoapDocument - Signed UserMessage

Returns:

this for chaining

getEbms3UserMessage

@Nullable
public final Ebms3UserMessage getEbms3UserMessage()

setEbms3UserMessage

@Nonnull
public final AS4ClientReceiptMessage setEbms3UserMessage(@Nullable
                                                                   Ebms3UserMessage aEbms3UserMessage)

Needs to be set to refer to the message which this receipt is the response and if non-repudiation is not used, to fill the receipt content

Parameters:

aEbms3UserMessage - UserMessage which this receipt should be the response for

Returns:

this for chaining

isReceiptShouldBeSigned

public final boolean isReceiptShouldBeSigned()

setReceiptShouldBeSigned

@Nonnull
public final AS4ClientReceiptMessage setReceiptShouldBeSigned(boolean bReceiptShouldBeSigned)

buildMessage

public AS4ClientBuiltMessage buildMessage(@Nonnull @Nonempty
                                          String sMessageID,
                                          @Nullable
                                          IAS4ClientBuildMessageCallback aCallback)
                                   throws Exception

Description copied from class: AbstractAS4Client

Build the AS4 message to be sent. It uses all the attributes of this class to build the final message. Compression, signing and encryption happens in this methods.

Specified by:

buildMessage in class AbstractAS4Client<AS4ClientReceiptMessage>

Parameters:

sMessageID - The message ID to be used. Neither null nor empty.

aCallback - Optional callback for in-between states. May be null.

Returns:

The HTTP entity to be sent. Never null.

Throws:

Exception - in case something goes wrong