Package com.helger.phase4.peppol

Class Phase4PeppolSender

java.lang.Object

com.helger.phase4.peppol.Phase4PeppolSender

@Immutable
public final class Phase4PeppolSender
extends Object

This class contains all the specifics to send AS4 messages to the Peppol Network. See sendAS4Message as the main method to trigger the sending, with all potential customization.

Author:

Philip Helger

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Phase4PeppolSender.AbstractPeppolUserMessageBuilder<IMPLTYPE extends Phase4PeppolSender.AbstractPeppolUserMessageBuilder<IMPLTYPE>>	Abstract builder base class with the minimum requirements configuration
static class	Phase4PeppolSender.PeppolUserMessageBuilder	The builder class for sending AS4 messages using Peppol specifics.
static class	Phase4PeppolSender.PeppolUserMessageSBDHBuilder	A builder class for sending AS4 messages using Peppol specifics.

Field Summary

Fields

Modifier and Type	Field	Description
static final com.helger.peppolid.factory.PeppolIdentifierFactory	IF
static final String	REGEX_SEAT_ID	Deprecated, for removal: This API element is subject to removal in a future version.
static final com.helger.smpclient.url.IPeppolURLProvider	URL_PROVIDER

Method Summary

Modifier and Type	Method	Description
static @NonNull Phase4PeppolSender.PeppolUserMessageBuilder	builder()
static @Nullable org.unece.cefact.namespaces.sbdh.StandardBusinessDocument	createSBDH(@NonNull com.helger.peppolid.IParticipantIdentifier aSenderID, @NonNull com.helger.peppolid.IParticipantIdentifier aReceiverID, @NonNull com.helger.peppolid.IDocumentTypeIdentifier aDocTypeID, @NonNull com.helger.peppolid.IProcessIdentifier aProcID, @Nullable String sCountryC1, @Nullable String sInstanceIdentifier, @Nullable String sStandard, @Nullable String sTypeVersion, @Nullable String sType, @NonNull Element aPayloadElement)
static @NonNull Phase4PeppolSender.PeppolUserMessageSBDHBuilder	sbdhBuilder()

Methods inherited from class java.lang.Object

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

Field Details

IF

public static final com.helger.peppolid.factory.PeppolIdentifierFactory IF

URL_PROVIDER

public static final com.helger.smpclient.url.IPeppolURLProvider URL_PROVIDER

REGEX_SEAT_ID

@Deprecated(forRemoval=true,
            since="4.3.0")
public static final String REGEX_SEAT_ID

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

Method Details

createSBDH

public static @Nullable org.unece.cefact.namespaces.sbdh.StandardBusinessDocument createSBDH(@NonNull com.helger.peppolid.IParticipantIdentifier aSenderID,
 @NonNull com.helger.peppolid.IParticipantIdentifier aReceiverID,
 @NonNull com.helger.peppolid.IDocumentTypeIdentifier aDocTypeID,
 @NonNull com.helger.peppolid.IProcessIdentifier aProcID,
 @Nullable String sCountryC1,
 @Nullable String sInstanceIdentifier,
 @Nullable String sStandard,
 @Nullable String sTypeVersion,
 @Nullable String sType,
 @NonNull Element aPayloadElement)

Parameters:

aSenderID - Sender participant ID. May not be null.

aReceiverID - Receiver participant ID. May not be null.

aDocTypeID - Document type ID. May not be null.

aProcID - Process ID. May not be null.

sCountryC1 - Country code of C1. May be null.

sInstanceIdentifier - SBDH instance identifier. May be null to create a random ID.

sStandard - SBDH standard (e.g. the XML payload root element namespace URI). May be null to use the default.

sTypeVersion - SBDH syntax version ID (e.g. "2.1" for OASIS UBL 2.1). May be null to use the default.

sType - SBDH type (e.g. the XML payload root element local name). May be null to use the default.

aPayloadElement - Payload element to be wrapped. May not be null.

Returns:

The domain object representation of the created SBDH or null if not all parameters are present.

Since:

3.1.0

builder

public static @NonNull Phase4PeppolSender.PeppolUserMessageBuilder builder()

Returns:

Create a new Builder for AS4 messages if the payload is present and the SBDH is always created internally by phase4. Never null.

Since:

0.9.4

See Also:

• if you already have a ready Standard Business Document

sbdhBuilder

public static @NonNull Phase4PeppolSender.PeppolUserMessageSBDHBuilder sbdhBuilder()

Returns:

Create a new Builder for AS4 messages if the SBDH payload is already present. This builder is slightly more limited, because it doesn't offer validation, as it is expected to be done before. Use this builder e.g. for the Peppol Testbed messages. Never null.

Since:

0.9.6

See Also:

• if you want phase4 to create the Standard Business Document