com.helger.phase4.client

Class AbstractAS4Client<IMPLTYPE extends AbstractAS4Client<IMPLTYPE>>

java.lang.Object

com.helger.phase4.client.BasicHttpPoster

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

Type Parameters:

IMPLTYPE - Implementation type

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractAS4ClientSignalMessage, AS4ClientUserMessage

public abstract class AbstractAS4Client<IMPLTYPE extends AbstractAS4Client<IMPLTYPE>>
extends BasicHttpPoster
implements com.helger.commons.traits.IGenericImplTrait<IMPLTYPE>

Abstract AS4 client based on HTTP client

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_RETRIES
static long	DEFAULT_RETRY_INTERVAL_MS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAS4Client(AS4ResourceHelper aResHelper)

Method Summary

Modifier and Type	Method and Description
abstract AS4ClientBuiltMessage	buildMessage(String sMessageID, IAS4ClientBuildMessageCallback aCallback) Build the AS4 message to be sent.
static com.helger.commons.functional.ISupplier<String>	createDefaultMessageIDFactory()
String	createMessageID()
AS4CryptParams	cryptParams()
IAS4CryptoFactory	getAS4CryptoFactory()
AS4ResourceHelper	getAS4ResourceHelper()
int	getMaxRetries()
com.helger.commons.functional.ISupplier<String>	getMessageIDFactory()
String	getRefToMessageID()
long	getRetryIntervalMS()
ESoapVersion	getSoapVersion()
boolean	hasRefToMessageID()
protected IAS4CryptoFactory	internalCreateCryptoFactory()
com.helger.xml.microdom.IMicroDocument	sendMessageAndGetMicroDocument(String sURL)
<T> AS4ClientSentMessage<T>	sendMessageWithRetries(String sURL, org.apache.http.client.ResponseHandler<? extends T> aResponseHandler, IAS4ClientBuildMessageCallback aCallback) Deprecated. Use the version with the dumper directory. Since v0.9.9
<T> AS4ClientSentMessage<T>	sendMessageWithRetries(String sURL, org.apache.http.client.ResponseHandler<? extends T> aResponseHandler, IAS4ClientBuildMessageCallback aCallback, IAS4OutgoingDumper aOutgoingDumper) Send the AS4 client message created by buildMessage(String, IAS4ClientBuildMessageCallback) to the provided URL.
IMPLTYPE	setAS4CryptoFactory(IAS4CryptoFactory aCryptoFactory) Set all the crypto properties at once.
IMPLTYPE	setMaxRetries(int nMaxRetries) Set the maximum number of retries to be used.
IMPLTYPE	setMessageID(String sMessageID) Set a constant message ID
IMPLTYPE	setMessageIDFactory(com.helger.commons.functional.ISupplier<String> aMessageIDFactory) Set the factory that creates message IDs.
IMPLTYPE	setRefToMessageID(String sRefToMessageID)
IMPLTYPE	setRetryIntervalMS(long nRetryIntervalMS) Set the interval in milliseconds between retries.
IMPLTYPE	setSoapVersion(ESoapVersion eSoapVersion) This method sets the SOAP Version.
void	setValuesFromPMode(IPMode aPMode, PModeLeg aLeg)
AS4SigningParams	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

Field Detail

DEFAULT_MAX_RETRIES

public static final int DEFAULT_MAX_RETRIES

See Also:

Constant Field Values

DEFAULT_RETRY_INTERVAL_MS

public static final long DEFAULT_RETRY_INTERVAL_MS

See Also:

Constant Field Values

Constructor Detail

AbstractAS4Client

protected AbstractAS4Client(@Nonnull @WillNotClose
                            AS4ResourceHelper aResHelper)

Method Detail

createDefaultMessageIDFactory

@Nonnull
public static com.helger.commons.functional.ISupplier<String> createDefaultMessageIDFactory()

Returns:

The default message ID factory to be used.

Since:

0.8.3

getAS4ResourceHelper

@Nonnull
public final AS4ResourceHelper getAS4ResourceHelper()

Returns:

The resource helper provided in the constructor. Never null.

getAS4CryptoFactory

@Nullable
public final IAS4CryptoFactory getAS4CryptoFactory()

Returns:

The currently set crypto factory. null by default.

setAS4CryptoFactory

@Nonnull
public final IMPLTYPE setAS4CryptoFactory(@Nullable
                                                    IAS4CryptoFactory aCryptoFactory)

Set all the crypto properties at once.

Parameters:

aCryptoFactory - The crypto factory to be used. May be null.

Returns:

this for chaining

signingParams

@Nonnull
 @ReturnsMutableObject
public final AS4SigningParams signingParams()

Returns:

The signing algorithm to use. Never null.

Since:

0.9.0

cryptParams

@Nonnull
 @ReturnsMutableObject
public final AS4CryptParams cryptParams()

Returns:

The encrypt and decrypt parameters to use. Never null null.

Since:

0.9.0

getMessageIDFactory

@Nonnull
public final com.helger.commons.functional.ISupplier<String> getMessageIDFactory()

Returns:

The Message ID factory to be used. May not be null.

setMessageID

@Nonnull
public final IMPLTYPE setMessageID(@Nonnull @Nonempty
                                             String sMessageID)

Set a constant message ID

Parameters:

sMessageID - Message to be used. May neither be null nor empty.

Returns:

this for chaining

setMessageIDFactory

@Nonnull
public final IMPLTYPE setMessageIDFactory(@Nonnull
                                                    com.helger.commons.functional.ISupplier<String> aMessageIDFactory)

Set the factory that creates message IDs. By default a random UUID is used.

Parameters:

aMessageIDFactory - Factory to be used. May not be null.

Returns:

this for chaining

createMessageID

@Nonnull
 @Nonempty
public final String createMessageID()

Returns:

A new message ID created by the contained factory. Neither null nor empty.

getRefToMessageID

@Nullable
public final String getRefToMessageID()

hasRefToMessageID

public final boolean hasRefToMessageID()

setRefToMessageID

@Nonnull
public final IMPLTYPE setRefToMessageID(@Nullable
                                                  String sRefToMessageID)

getSoapVersion

@Nonnull
public final ESoapVersion getSoapVersion()

Returns:

The SOAP version to be used. May not be null.

Since:

v0.9.8

setSoapVersion

@Nonnull
public final IMPLTYPE setSoapVersion(@Nonnull
                                               ESoapVersion eSoapVersion)

This method sets the SOAP Version. AS4 - Profile default is SOAP 1.2

Parameters:

eSoapVersion - SOAP version which should be set. May not be null.

Returns:

this for chaining

Since:

v0.9.8

getMaxRetries

@Nonnegative
public final int getMaxRetries()

Returns:

The maximum number of retries. Only values > 0 imply a retry. The default value is DEFAULT_MAX_RETRIES.

Since:

0.9.0

setMaxRetries

@Nonnull
public final IMPLTYPE setMaxRetries(@Nonnegative
                                              int nMaxRetries)

Set the maximum number of retries to be used.

Parameters:

nMaxRetries - Retry count. A value of 0 means "no retries". Must be ≥ 0.

Returns:

this for chaining

Since:

0.9.0

getRetryIntervalMS

@Nonnegative
public final long getRetryIntervalMS()

Returns:

The interval in milliseconds between retries. Must be ≥ 0. The default value is DEFAULT_RETRY_INTERVAL_MS.

Since:

0.9.0

setRetryIntervalMS

@Nonnull
public final IMPLTYPE setRetryIntervalMS(@Nonnegative
                                                   long nRetryIntervalMS)

Set the interval in milliseconds between retries.

Parameters:

nRetryIntervalMS - Retry interval in milliseconds. Must be ≥ 0.

Returns:

this for chaining

Since:

0.9.0

internalCreateCryptoFactory

@Nonnull
protected IAS4CryptoFactory internalCreateCryptoFactory()

setValuesFromPMode

public final void setValuesFromPMode(@Nullable
                                     IPMode aPMode,
                                     @Nullable
                                     PModeLeg aLeg)

buildMessage

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

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.

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

sendMessageWithRetries

@Deprecated
 @Nonnull
public final <T> AS4ClientSentMessage<T> sendMessageWithRetries(@Nonnull
                                                                                        String sURL,
                                                                                        @Nonnull
                                                                                        org.apache.http.client.ResponseHandler<? extends T> aResponseHandler,
                                                                                        @Nullable
                                                                                        IAS4ClientBuildMessageCallback aCallback)
                                                                                 throws Exception

Deprecated. Use the version with the dumper directory. Since v0.9.9

Send the AS4 client message created by buildMessage(String, IAS4ClientBuildMessageCallback) to the provided URL. This methods does take retries into account. It synchronously handles the retries and only returns after the last retry.

Type Parameters:

T - The response data type

Parameters:

sURL - The URL to send the HTTP POST to

aResponseHandler - The response handler that converts the HTTP response to a domain object. May not be null.

aCallback - The optional callback that is invoked during the creation of the AS4ClientBuiltMessage. It can be used to access several states of message creation. May be null.

Returns:

The sent message that contains

Throws:

Exception - in case of error when building or sending the message

sendMessageWithRetries

@Nonnull
public final <T> AS4ClientSentMessage<T> sendMessageWithRetries(@Nonnull
                                                                          String sURL,
                                                                          @Nonnull
                                                                          org.apache.http.client.ResponseHandler<? extends T> aResponseHandler,
                                                                          @Nullable
                                                                          IAS4ClientBuildMessageCallback aCallback,
                                                                          @Nullable
                                                                          IAS4OutgoingDumper aOutgoingDumper)
                                                                   throws Exception

Send the AS4 client message created by buildMessage(String, IAS4ClientBuildMessageCallback) to the provided URL. This methods does take retries into account. It synchronously handles the retries and only returns after the last retry.

Type Parameters:

T - The response data type

Parameters:

sURL - The URL to send the HTTP POST to

aResponseHandler - The response handler that converts the HTTP response to a domain object. May not be null.

aOutgoingDumper - An outgoing dumper to be used. Maybe null. If null the global outgoing dumper from AS4DumpManager is used.

Returns:

The sent message that contains

Throws:

Exception - in case of error when building or sending the message

Since:

0.9.6

sendMessageAndGetMicroDocument

@Nullable
public com.helger.xml.microdom.IMicroDocument sendMessageAndGetMicroDocument(@Nonnull
                                                                                        String sURL)
                                                                                 throws Exception

Throws:

Exception