Package com.helger.phase4.sender

Class AbstractAS4UserMessageBuilderMIMEPayload<IMPLTYPE extends AbstractAS4UserMessageBuilderMIMEPayload<IMPLTYPE>>

java.lang.Object

com.helger.phase4.sender.AbstractAS4MessageBuilder<IMPLTYPE>

com.helger.phase4.sender.AbstractAS4UserMessageBuilder<IMPLTYPE>

com.helger.phase4.sender.AbstractAS4UserMessageBuilderMIMEPayload<IMPLTYPE>

Type Parameters:

IMPLTYPE - The implementation type

All Implemented Interfaces:

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

Direct Known Subclasses:

Phase4Sender.BuilderUserMessage

@NotThreadSafe
public abstract class AbstractAS4UserMessageBuilderMIMEPayload<IMPLTYPE extends AbstractAS4UserMessageBuilderMIMEPayload<IMPLTYPE>>
extends AbstractAS4UserMessageBuilder<IMPLTYPE>

Abstract builder base class for a user messages that put the payload in a MIME part.

Since:

0.10.0

Author:

Philip Helger

Nested Class Summary

Nested classes/interfaces inherited from class com.helger.phase4.sender.AbstractAS4UserMessageBuilder

AbstractAS4UserMessageBuilder.ESimpleUserMessageSendResult

Field Summary

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

m_aAttachments, m_aMessageProperties, m_aPMode, m_aReceiverCertificate, m_aSignalMsgConsumer, m_sAction, m_sAgreementRef, 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_aCryptoFactory, m_aCustomHttpPoster, m_aHttpClientFactory, m_aHttpRetrySettings, m_aIncomingDumper, m_aLocale, m_aOutgoingDumper, m_aResponseConsumer, m_aRetryCallback, m_aSendingDateTime, m_eSoapVersion, m_sMessageID, m_sRefToMessageID

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractAS4UserMessageBuilderMIMEPayload()	Create a new builder, with the some fields already set as outlined in AbstractAS4UserMessageBuilder()

Method Summary

Modifier and Type	Method	Description
boolean	isEveryRequiredFieldSet()
protected final void	mainSendMessage()	Synchronously send the AS4 message.
final IMPLTYPE	payload(Phase4OutgoingAttachment aPayload)	Set the payload to be send out.
final IMPLTYPE	payload(Phase4OutgoingAttachment.Builder aBuilder)	Set the payload to be send out.

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

action, addAttachment, addAttachment, addMessageProperty, addMessageProperty, addMessageProperty, agreementRef, applyToUserMessage, attachment, attachment, attachments, attachments, conversationID, endpointURL, fromPartyID, fromPartyIDType, fromRole, messageProperties, messageProperties, messageProperty, messageProperty, messageProperty, pmode, pmode, pmodeID, receiverCertificate, sendMessageAndCheckForReceipt, sendMessageAndCheckForReceipt, service, service, signalMsgConsumer, toPartyID, toPartyIDType, toRole

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

buildMessageCallback, cryptoFactory, cryptoFactory, customHttpPoster, customHttpPoster, customizeBeforeSending, finishFields, httpClientFactory, httpClientFactory, httpClientFactory, httpRetrySettings, incomingAttachmentFactory, incomingAttachmentFactory, incomingDumper, incomingProfileSelector, incomingProfileSelector, locale, messageID, outgoingDumper, pmodeResolver, pmodeResolver, rawResponseConsumer, refToMessageID, retryCallback, senderInterrupt, senderInterrupt, sendingDateTime, sendMessage, soapVersion, soapVersion

Methods inherited from class java.lang.Object

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

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

thisAsT

Constructor Details

AbstractAS4UserMessageBuilderMIMEPayload

protected AbstractAS4UserMessageBuilderMIMEPayload()

Create a new builder, with the some fields already set as outlined in AbstractAS4UserMessageBuilder()

Method Details

payload

@Nonnull
public final IMPLTYPE payload(@Nullable
 Phase4OutgoingAttachment.Builder aBuilder)

Set the payload to be send out.

Parameters:

aBuilder - The payload builder to be used. May be null.

Returns:

this for chaining

payload

@Nonnull
public final IMPLTYPE payload(@Nullable
 Phase4OutgoingAttachment aPayload)

Set the payload to be send out.

Parameters:

aPayload - The payload to be used. May be null.

Returns:

this for chaining

isEveryRequiredFieldSet

@OverridingMethodsMustInvokeSuper
public boolean isEveryRequiredFieldSet()

Overrides:

isEveryRequiredFieldSet in class AbstractAS4UserMessageBuilder<IMPLTYPE extends AbstractAS4UserMessageBuilderMIMEPayload<IMPLTYPE>>

mainSendMessage

protected final void mainSendMessage()
                              throws Phase4Exception

Description copied from class: AbstractAS4MessageBuilder

Synchronously send the AS4 message. This method may only be called by AbstractAS4MessageBuilder.sendMessage()

Specified by:

mainSendMessage in class AbstractAS4MessageBuilder<IMPLTYPE extends AbstractAS4UserMessageBuilderMIMEPayload<IMPLTYPE>>

Throws:

Phase4Exception - In case of any error