Package com.helger.phase4.peppol

Class Phase4PeppolSender.PeppolUserMessageSBDHBuilder

java.lang.Object

com.helger.phase4.sender.AbstractAS4MessageBuilder<Phase4PeppolSender.PeppolUserMessageSBDHBuilder>

com.helger.phase4.sender.AbstractAS4UserMessageBuilder<Phase4PeppolSender.PeppolUserMessageSBDHBuilder>

com.helger.phase4.sender.AbstractAS4UserMessageBuilderMIMEPayload<Phase4PeppolSender.PeppolUserMessageSBDHBuilder>

com.helger.phase4.peppol.Phase4PeppolSender.AbstractPeppolUserMessageBuilder<Phase4PeppolSender.PeppolUserMessageSBDHBuilder>

com.helger.phase4.peppol.Phase4PeppolSender.PeppolUserMessageSBDHBuilder

All Implemented Interfaces:

com.helger.base.trait.IGenericImplTrait<Phase4PeppolSender.PeppolUserMessageSBDHBuilder>

Enclosing class:

Phase4PeppolSender

@NotThreadSafe
public static class Phase4PeppolSender.PeppolUserMessageSBDHBuilder
extends Phase4PeppolSender.AbstractPeppolUserMessageBuilder<Phase4PeppolSender.PeppolUserMessageSBDHBuilder>

A builder class for sending AS4 messages using Peppol specifics. Use AbstractAS4MessageBuilder.sendMessage() or AbstractAS4UserMessageBuilder.sendMessageAndCheckForReceipt() to trigger the main transmission.
This builder class assumes, that the SBDH was created outside, therefore no validation can occur.

Since:

0.9.6

Author:

Philip Helger

Field Summary

Fields inherited from class com.helger.phase4.peppol.Phase4PeppolSender.AbstractPeppolUserMessageBuilder

DEFAULT_CHECK_RECEIVER_AP_CERTIFICATE, DEFAULT_COMPRESS_PAYLOAD, m_aCAChecker, m_aDocTypeID, m_aEndpointDetailProvider, m_aPayloadMimeType, m_aProcessID, m_aReceiverID, m_aSenderID, m_bCompressPayload, m_sCountryC1, m_sPayloadContentID

Fields inherited from class com.helger.phase4.sender.AbstractAS4UserMessageBuilderMIMEPayload

m_aPayload

Fields inherited from class com.helger.phase4.sender.AbstractAS4UserMessageBuilder

m_aAttachments, m_aMessageProperties, m_aPMode, m_aSignalMsgConsumer, m_aSignalMsgValidationResultHdl, m_bForceMimeMessage, m_sAction, m_sAgreementRef, m_sAgreementType, m_sConversationID, m_sEndpointURL, m_sFromPartyID, m_sFromPartyIDType, m_sFromRole, m_sPModeID, m_sService, m_sServiceType, m_sToPartyID, m_sToPartyIDType, m_sToRole

Fields inherited from class com.helger.phase4.sender.AbstractAS4MessageBuilder

DEFAULT_LOCALE, m_aBuildMessageCallback, m_aCryptoFactoryCrypt, m_aCryptoFactorySign, m_aCryptParams, m_aCustomHttpPoster, m_aDecryptParameterModifier, m_aHttpClientFactory, m_aHttpRetrySettings, m_aIncomingDumper, m_aLocale, m_aOutgoingDumper, m_aResponseConsumer, m_aRetryCallback, m_aSendingDateTime, m_aSendingDTConsumer, m_aSigningParams, m_eSoapVersion, m_sAS4ProfileID, m_sMessageID, m_sRefToMessageID

Constructor Summary

Constructors

Constructor	Description
PeppolUserMessageSBDHBuilder()	Create a new builder with the defaults from AbstractPeppolUserMessageBuilder()

Method Summary

Modifier and Type	Method	Description
protected com.helger.base.state.ESuccess	finishFields(@NonNull com.helger.phase4.util.AS4ResourceHelper aResHelper)
boolean	isEveryRequiredFieldSet()
@NonNull Phase4PeppolSender.PeppolUserMessageSBDHBuilder	payload(byte @NonNull [] aSBDHBytes)	Set the SBDH payload to be used as a byte array.
@NonNull Phase4PeppolSender.PeppolUserMessageSBDHBuilder	payloadAndMetadata(@NonNull com.helger.peppol.sbdh.PeppolSBDHData aSBDH)	Set the payload, the sender participant ID, the receiver participant ID, the document type ID and the process ID.

Methods inherited from class com.helger.phase4.peppol.Phase4PeppolSender.AbstractPeppolUserMessageBuilder

apCacheRevocationCheckResult, apRevocationCheckMode, apRevocationSoftFail, certificateConsumer, checkReceiverAPCertificate, compressPayload, countryC1, createAndStorePeppolReportingItemAfterSending, createPeppolReportingItemAfterSending, customizeBeforeSending, documentTypeID, documentTypeID, effectiveSendingDateTime, endpointDetailProvider, endpointURLConsumer, isEndpointDetailProviderUsable, payloadContentID, payloadMimeType, peppolAP_CAChecker, processID, processID, receiverEndpointDetails, receiverEndpointDetails, receiverParticipantID, senderParticipantID, senderPartyID, smpClient, technicalContactConsumer

Methods inherited from class com.helger.phase4.sender.AbstractAS4UserMessageBuilderMIMEPayload

createMainAttachment, createOtherAttachment, mainSendMessage, payload, payload, payload

Methods inherited from class com.helger.phase4.sender.AbstractAS4UserMessageBuilder

action, action, addAttachment, addAttachment, addEbmsProperties, addMessageProperty, addMessageProperty, addMessageProperty, agreementRef, agreementRef, agreementType, agreementType, applyToUserMessage, attachment, attachment, attachments, attachments, attachments, conversationID, conversationID, endpointURL, endpointURL, forceMimeMessage, forceMimeMessage, fromPartyID, fromPartyID, fromPartyIDType, fromPartyIDType, fromRole, fromRole, getAllAttachments, getAllMessageProperties, messageProperties, messageProperties, messageProperties, messageProperty, messageProperty, messageProperty, pmode, pmode, pmodeID, pmodeID, receiverCertificate, receiverCertificateAlias, sendMessageAndCheckForReceipt, sendMessageAndCheckForReceipt, service, service, service, serviceType, signalMsgConsumer, signalMsgConsumer, signalMsgValidationResultHdl, signalMsgValidationResultHdl, toPartyID, toPartyID, toPartyIDType, toPartyIDType, toRole, toRole

Methods inherited from class com.helger.phase4.sender.AbstractAS4MessageBuilder

afterSuccessfulSending, as4ProfileID, as4ProfileID, buildMessageCallback, buildMessageCallback, cryptoFactory, cryptoFactoryCrypt, cryptoFactoryCrypt, cryptoFactorySign, cryptoFactorySign, cryptParams, customHttpPoster, customHttpPoster, decryptRequestDataModifier, decryptRequestDataModifier, httpClientFactory, httpClientFactory, httpClientFactory, httpRetrySettings, httpRetrySettings, incomingAttachmentFactory, incomingAttachmentFactory, incomingDumper, incomingDumper, incomingProfileSelector, incomingProfileSelector, locale, locale, messageID, messageID, outgoingDumper, outgoingDumper, pmodeResolver, pmodeResolver, rawResponseConsumer, rawResponseConsumer, refToMessageID, refToMessageID, retryCallback, retryCallback, senderInterrupt, senderInterrupt, sendingDateTime, sendingDateTime, sendingDateTimeConsumer, sendingDateTimeConsumer, sendMessage, signingParams, soapVersion, soapVersion, withCryptParams, withSigningParams

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.base.trait.IGenericImplTrait

thisAsT

Constructor Details

PeppolUserMessageSBDHBuilder

public PeppolUserMessageSBDHBuilder()

Create a new builder with the defaults from AbstractPeppolUserMessageBuilder()

Method Details

payload

public @NonNull Phase4PeppolSender.PeppolUserMessageSBDHBuilder payload(byte @NonNull [] aSBDHBytes)

Set the SBDH payload to be used as a byte array. This means, that you need to pass in all other mandatory fields manually (sender participant ID, receiver participant ID, document Type ID, process ID and country C1).

Parameters:

aSBDHBytes - The SBDH bytes to be used. May not be null.

Returns:

this for chaining

See Also:

• Phase4PeppolSender.AbstractPeppolUserMessageBuilder.senderParticipantID(IParticipantIdentifier)
• Phase4PeppolSender.AbstractPeppolUserMessageBuilder.receiverParticipantID(IParticipantIdentifier)
• Phase4PeppolSender.AbstractPeppolUserMessageBuilder.documentTypeID(IDocumentTypeIdentifier)
• Phase4PeppolSender.AbstractPeppolUserMessageBuilder.processID(IProcessIdentifier)
• Phase4PeppolSender.AbstractPeppolUserMessageBuilder.countryC1(String)

payloadAndMetadata

public @NonNull Phase4PeppolSender.PeppolUserMessageSBDHBuilder payloadAndMetadata(@NonNull com.helger.peppol.sbdh.PeppolSBDHData aSBDH)

Set the payload, the sender participant ID, the receiver participant ID, the document type ID and the process ID.

Parameters:

aSBDH - The SBDH to use. May not be null.

Returns:

this for chaining

Since:

0.10.2

See Also:

• payload(byte[])
• Phase4PeppolSender.AbstractPeppolUserMessageBuilder.senderParticipantID(IParticipantIdentifier)
• Phase4PeppolSender.AbstractPeppolUserMessageBuilder.receiverParticipantID(IParticipantIdentifier)
• Phase4PeppolSender.AbstractPeppolUserMessageBuilder.documentTypeID(IDocumentTypeIdentifier)
• Phase4PeppolSender.AbstractPeppolUserMessageBuilder.processID(IProcessIdentifier)
• Phase4PeppolSender.AbstractPeppolUserMessageBuilder.countryC1(String)

isEveryRequiredFieldSet

@OverridingMethodsMustInvokeSuper
public boolean isEveryRequiredFieldSet()

Overrides:

isEveryRequiredFieldSet in class Phase4PeppolSender.AbstractPeppolUserMessageBuilder<Phase4PeppolSender.PeppolUserMessageSBDHBuilder>

finishFields

@OverridingMethodsMustInvokeSuper
protected com.helger.base.state.ESuccess finishFields(@NonNull com.helger.phase4.util.AS4ResourceHelper aResHelper)
                                               throws com.helger.phase4.util.Phase4Exception

Overrides:

finishFields in class Phase4PeppolSender.AbstractPeppolUserMessageBuilder<Phase4PeppolSender.PeppolUserMessageSBDHBuilder>

Throws:

com.helger.phase4.util.Phase4Exception