Package com.helger.phase4.profile

Interface IAS4Profile

All Superinterfaces:

com.helger.commons.name.IHasDisplayName, com.helger.commons.id.IHasID<String>

All Known Implementing Classes:

AS4Profile

@MustImplementEqualsAndHashcode
public interface IAS4Profile
extends com.helger.commons.id.IHasID<String>, com.helger.commons.name.IHasDisplayName

Base interface for an AS4 profile - a group of settings that outline what features of AS4 are used.

Author:

Philip Helger

Method Summary

Modifier and Type	Method	Description
PMode	createPModeTemplate(String sInitiatorID, String sResponderID, String sAddress)	Create a PMode for the provided parameters.
IPModeIDProvider	getPModeIDProvider()
IAS4ProfileValidator	getValidator()
boolean	isDeprecated()
boolean	isInvokeSPIForPingMessage()

Methods inherited from interface com.helger.commons.name.IHasDisplayName

getDisplayName

Methods inherited from interface com.helger.commons.id.IHasID

getID

Method Details

getValidator

@Nullable
IAS4ProfileValidator getValidator()

Returns:

An optional validator. May be null.

createPModeTemplate

@Nonnull
PMode createPModeTemplate(@Nonnull @Nonempty
 String sInitiatorID,
 @Nonnull @Nonempty
 String sResponderID,
 @Nullable
 String sAddress)

Create a PMode for the provided parameters.

Parameters:

sInitiatorID - Initiator ID

sResponderID - Responder ID

sAddress - Address string

Returns:

A PMode that is NOT yet in the manager and is not complete! The following information is most likely not contained: URLs, certificates.

getPModeIDProvider

@Nonnull
IPModeIDProvider getPModeIDProvider()

Returns:

The PMode ID provider to be used for this profile. May not be null.

isDeprecated

boolean isDeprecated()

Returns:

true if this AS4 profile is deprecated and should therefore not be used, or false if not.

isInvokeSPIForPingMessage

boolean isInvokeSPIForPingMessage()

Returns:

true if this profile wants to handle Ping messages inside the custom SPI handler. This was introduced for sole usage in BDEW profile.

Since:

v2.5.3