Package com.helger.phase4.sender

Class AbstractAS4PullRequestBuilder<IMPLTYPE extends AbstractAS4PullRequestBuilder<IMPLTYPE>>

java.lang.Object

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

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

Type Parameters:

IMPLTYPE - The implementation type

All Implemented Interfaces:

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

Direct Known Subclasses:

AS4Sender.BuilderPullRequest

@NotThreadSafe
public abstract class AbstractAS4PullRequestBuilder<IMPLTYPE extends AbstractAS4PullRequestBuilder<IMPLTYPE>>
extends AbstractAS4MessageBuilder<IMPLTYPE>

Abstract builder base class for a Pull Request.

Since:

0.12.0

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field	Description
protected IAS4UserMessageConsumer	m_aUserMsgConsumer
protected String	m_sEndpointURL
protected String	m_sMPC

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_sMessageID, m_sRefToMessageID

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractAS4PullRequestBuilder()	Create a new builder, with the following fields already set:

Method Summary

Modifier and Type	Method	Description
protected final void	applyToPullRequest(AS4ClientPullRequestMessage aPullRequestMsg)	This method applies all builder parameters onto the Pull Request, except the attachments.
final IMPLTYPE	endpointURL(String sEndointURL)	Set an receiver AS4 endpoint URL, independent of its usability.
boolean	isEveryRequiredFieldSet()
protected final void	mainSendMessage()	Synchronously send the AS4 message.
final IMPLTYPE	mpc(String sMPC)	Set the MPC to be used in the Pull Request.
final IMPLTYPE	userMsgConsumer(IAS4UserMessageConsumer aUserMsgConsumer)	Set an optional Ebms3 User Message Consumer.

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

afterSuccessfulSending, buildMessageCallback, cryptoFactory, cryptoFactory, cryptoFactoryCrypt, cryptoFactoryCrypt, cryptoFactorySign, cryptoFactorySign, cryptParams, customHttpPoster, customHttpPoster, customizeBeforeSending, decryptRequestDataModifier, finishFields, httpClientFactory, httpClientFactory, httpClientFactory, httpRetrySettings, incomingAttachmentFactory, incomingAttachmentFactory, incomingDumper, incomingProfileSelector, incomingProfileSelector, locale, messageID, outgoingDumper, pmodeResolver, pmodeResolver, rawResponseConsumer, refToMessageID, retryCallback, senderInterrupt, senderInterrupt, 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.commons.traits.IGenericImplTrait

thisAsT

Field Details

m_sMPC

protected String m_sMPC

m_sEndpointURL

protected String m_sEndpointURL

m_aUserMsgConsumer

protected IAS4UserMessageConsumer m_aUserMsgConsumer

Constructor Details

AbstractAS4PullRequestBuilder

protected AbstractAS4PullRequestBuilder()

Create a new builder, with the following fields already set:

Method Details

mpc

@Nonnull
public final IMPLTYPE mpc(@Nullable
 String sMPC)

Set the MPC to be used in the Pull Request.

Parameters:

sMPC - The MPC to use. May be null.

Returns:

this for chaining

endpointURL

@Nonnull
public final IMPLTYPE endpointURL(@Nullable
 String sEndointURL)

Set an receiver AS4 endpoint URL, independent of its usability.

Parameters:

sEndointURL - The endpoint URL to be used. May be null.

Returns:

this for chaining

userMsgConsumer

@Nonnull
public final IMPLTYPE userMsgConsumer(@Nullable
 IAS4UserMessageConsumer aUserMsgConsumer)

Set an optional Ebms3 User Message Consumer. This method is optional and must not be called prior to sending.

Parameters:

aUserMsgConsumer - The optional User Message consumer. May be null.

Returns:

this for chaining

isEveryRequiredFieldSet

@OverridingMethodsMustInvokeSuper
public boolean isEveryRequiredFieldSet()

Overrides:

isEveryRequiredFieldSet in class AbstractAS4MessageBuilder<IMPLTYPE extends AbstractAS4PullRequestBuilder<IMPLTYPE>>

applyToPullRequest

protected final void applyToPullRequest(@Nonnull
 AS4ClientPullRequestMessage aPullRequestMsg)

This method applies all builder parameters onto the Pull Request, except the attachments.

Parameters:

aPullRequestMsg - The Pull request the parameters should be applied to. May not be null.

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 AbstractAS4PullRequestBuilder<IMPLTYPE>>

Throws:

Phase4Exception - In case of any error