Package com.helger.phase4.incoming

Class AS4IncomingMessageState

java.lang.Object

java.util.AbstractMap<String,Object>

java.util.HashMap<String,Object>

java.util.LinkedHashMap<String,Object>

com.helger.commons.collection.impl.CommonsLinkedHashMap<String,Object>

com.helger.commons.collection.attr.AttributeContainer<String,Object>

com.helger.commons.collection.attr.AttributeContainerAny<String>

com.helger.phase4.incoming.AS4IncomingMessageState

All Implemented Interfaces:

com.helger.commons.collection.attr.IAttributeContainer<String,Object>, com.helger.commons.collection.attr.IAttributeContainerAny<String>, com.helger.commons.collection.impl.ICommonsMap<String,Object>, com.helger.commons.collection.impl.ICommonsOrderedMap<String,Object>, com.helger.commons.lang.ICloneable<com.helger.commons.collection.impl.ICommonsMap<String,Object>>, com.helger.commons.traits.IGetterByKeyTrait<String>, IAS4IncomingMessageState, Serializable, Cloneable, Map<String,Object>, SequencedMap<String,Object>

@NotThreadSafe
public final class AS4IncomingMessageState
extends com.helger.commons.collection.attr.AttributeContainerAny<String>
implements IAS4IncomingMessageState

This class keeps track of the status of an incoming message. It is basically a String to any map.
Keys starting with phase4. are reserved for internal use.
Instances of this object are only modified in the SOAP header handlers.
Old name before v3: AS4MessageState

Author:

Philip Helger

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface com.helger.commons.collection.attr.IAttributeContainer

com.helger.commons.collection.attr.IAttributeContainer.IAfterSetValueCallback<KEYTYPE,VALUETYPE>, com.helger.commons.collection.attr.IAttributeContainer.IBeforeSetValueCallback<KEYTYPE,VALUETYPE>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor	Description
AS4IncomingMessageState(ESoapVersion eSoapVersion, AS4ResourceHelper aResHelper, Locale aLocale)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
IAS4Profile	getAS4Profile()
com.helger.commons.collection.impl.ICommonsMap<String,EAS4CompressionMode>	getCompressedAttachmentIDs()
IAS4CryptoFactory	getCryptoFactoryCrypt()
IAS4CryptoFactory	getCryptoFactorySign()
com.helger.commons.collection.impl.ICommonsList<WSS4JAttachment>	getDecryptedAttachments()
Document	getDecryptedSoapDocument()
X509Certificate	getDecryptingCertificate()
PModeLeg	getEffectivePModeLeg()
int	getEffectivePModeLegNumber()
String	getInitiatorID()
Locale	getLocale()
String	getMessageID()
com.helger.commons.datetime.XMLOffsetDateTime	getMessageTimestamp()
Ebms3Messaging	getMessaging()
IMPC	getMPC()
com.helger.commons.collection.impl.ICommonsList<WSS4JAttachment>	getOriginalAttachments()
Document	getOriginalSoapDocument()
IPMode	getPMode()
OffsetDateTime	getReceiptDT()
String	getRefToMessageID()
AS4ResourceHelper	getResourceHelper()
String	getResponderID()
X509Certificate	getSigningCertificate()
Node	getSoapBodyPayloadNode()
ESoapVersion	getSoapVersion()
Exception	getSoapWSS4JException()
int	getSoapWSS4JSecurityActions()
X509Certificate	getUsedCertificate()	Deprecated, for removal: This API element is subject to removal in a future version.
int	hashCode()
boolean	isPingMessage()
boolean	isSoapBodyPayloadPresent()
boolean	isSoapDecrypted()
boolean	isSoapHeaderElementProcessingSuccessful()
boolean	isSoapSignatureChecked()
void	setAS4Profile(IAS4Profile aProfile)	Set the AS4 profile of the message.
void	setCompressedAttachmentIDs(com.helger.commons.collection.impl.ICommonsMap<String,EAS4CompressionMode> aIDs)
void	setCryptoFactoryCrypt(IAS4CryptoFactory aCryptoFactoryCrypt)
void	setCryptoFactorySign(IAS4CryptoFactory aCryptoFactorySign)
void	setDecryptedAttachments(com.helger.commons.collection.impl.ICommonsList<WSS4JAttachment> aAttachments)
void	setDecryptedSoapDocument(Document aDocument)
void	setDecryptingCertificate(X509Certificate aCert)
void	setEffectivePModeLeg(int nLegNumber, PModeLeg aEffectiveLeg)
void	setInitiatorID(String sInitiatorID)
void	setMessageID(String sMessageID)	Set the AS4 message ID of the current message.
void	setMessageTimestamp(com.helger.commons.datetime.XMLOffsetDateTime aMessageTimestamp)	Set the AS4 message timestamp of the current message.
void	setMessaging(Ebms3Messaging aMessaging)
void	setMPC(IMPC aMPC)
void	setOriginalAttachments(com.helger.commons.collection.impl.ICommonsList<WSS4JAttachment> aAttachments)
void	setOriginalSoapDocument(Document aDocument)
void	setPingMessage(boolean bIsPingMessage)
void	setPMode(IPMode aPMode)	Set the PMode to be used.
void	setRefToMessageID(String sRefMessageID)	Set the AS4 "reference to message ID" from the current message.
void	setResponderID(String sResponderID)
void	setSigningCertificate(X509Certificate aCert)
void	setSoapBodyPayloadNode(Node aPayloadNode)
void	setSoapBodyPayloadPresent(boolean bHasSoapBodyPayload)
void	setSoapHeaderElementProcessingSuccessful(boolean bSuccess)
void	setSoapWSS4JException(Exception aException)
void	setSoapWSS4JSecurityActions(int nSecurityActions)
void	setUsedCertificate(X509Certificate aCert)	Deprecated, for removal: This API element is subject to removal in a future version.

Methods inherited from class com.helger.commons.collection.attr.AttributeContainerAny

getClone

Methods inherited from class com.helger.commons.collection.attr.AttributeContainer

afterSetValueCallbacks, beforeSetValueCallbacks, toString

Methods inherited from class com.helger.commons.collection.impl.CommonsLinkedHashMap

createInstance

Methods inherited from class java.util.LinkedHashMap

clear, containsValue, entrySet, forEach, get, getOrDefault, keySet, newLinkedHashMap, putFirst, putLast, removeEldestEntry, replaceAll, reversed, sequencedEntrySet, sequencedKeySet, sequencedValues, values

Methods inherited from class java.util.HashMap

clone, compute, computeIfAbsent, computeIfPresent, containsKey, isEmpty, merge, newHashMap, put, putAll, putIfAbsent, remove, remove, replace, replace, size

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.helger.phase4.incoming.IAS4IncomingMessageState

containsCompressedAttachmentID, getAttachmentCompressionMode, getEbmsError, getEbmsPullRequest, getEbmsReceipt, getEbmsSignalMessage, getEbmsUserMessage, getEffectiveDecryptedSoapDocument, getProfileID, hasCompressedAttachmentIDs, hasDecryptedAttachments, hasDecryptedSoapDocument, hasDecryptingCertificate, hasInitiatorID, hasMPC, hasOriginalAttachments, hasOriginalSoapDocument, hasResponderID, hasSigningCertificate, hasSoapWSS4JException, hasUsedCertificate

Methods inherited from interface com.helger.commons.collection.attr.IAttributeContainer

afterSetValueCallbacks, beforeSetValueCallbacks, getAsBoolean, getAsDouble, getAsFloat, getAsInt, getAsLong, getValue, putAllIn, putIn

Methods inherited from interface com.helger.commons.collection.attr.IAttributeContainerAny

getAndSetFlag, putIn, putIn, putIn, putIn, putIn, putIn

Methods inherited from interface com.helger.commons.collection.impl.ICommonsMap

addAll, containsAnyEntry, containsAnyKey, containsAnyValue, copyOfValues, copyOfValues, copyOfValuesMapped, copyOfValuesMapped, findFirstEntry, findFirstKey, findFirstValue, forEach, forEachKey, forEachKey, forEachValue, forEachValue, getAsUnmodifiable, getFirstEntry, getFirstEntry, getFirstKey, getFirstKey, getFirstValue, getFirstValue, getSortedByKey, getSortedByValue, getSwappedKeyValues, isNotEmpty, put, putAll, putAll, putAllMapped, putAllMapped, putAllMapped, putIf, putIfNotNull, removeAll, removeIf, removeIfKey, removeIfValue, removeObject, setAll

Methods inherited from interface com.helger.commons.collection.impl.ICommonsOrderedMap

copyOfEntrySet, copyOfKeySet, copyOfKeySet, getLastKey, getLastKey, getLastValue, getLastValue

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

containsNonNullValue, containsNullValue, getAsBigDecimal, getAsBigDecimal, getAsBigInteger, getAsBigInteger, getAsBoolean, getAsBooleanObj, getAsByte, getAsByte, getAsByteArray, getAsByteObj, getAsChar, getAsChar, getAsCharArray, getAsCharArray, getAsCharObj, getAsDouble, getAsDoubleObj, getAsFloat, getAsFloatObj, getAsInt, getAsIntObj, getAsLocalDate, getAsLocalDate, getAsLocalDate, getAsLocalDateTime, getAsLocalDateTime, getAsLocalDateTime, getAsLocalTime, getAsLocalTime, getAsLocalTime, getAsLong, getAsLongObj, getAsShort, getAsShort, getAsShortObj, getAsSqlBlob, getAsSqlClob, getAsSqlDate, getAsSqlNClob, getAsSqlRowId, getAsSqlTime, getAsSqlTimestamp, getAsString, getAsString, getAsStringList, getAsStringList, getAsStringSet, getAsStringSet, getCastedValue, getCastedValue, getCastedValue, getCastedValue, getConvertedValue, getConvertedValue, getSafeCastedValue, getSafeCastedValue, getValueClass, hasStringValue, hasStringValue, onSafeCastError

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from interface java.util.SequencedMap

firstEntry, lastEntry, pollFirstEntry, pollLastEntry

Constructor Details

AS4IncomingMessageState

public AS4IncomingMessageState(@Nonnull
 ESoapVersion eSoapVersion,
 @Nonnull @WillNotClose
 AS4ResourceHelper aResHelper,
 @Nonnull
 Locale aLocale)

Method Details

getReceiptDT

@Nonnull
public OffsetDateTime getReceiptDT()

Specified by:

getReceiptDT in interface IAS4IncomingMessageState

Returns:

Date and time when the receipt started. This must be set in the implementation and never null.

getSoapVersion

@Nonnull
public ESoapVersion getSoapVersion()

Specified by:

getSoapVersion in interface IAS4IncomingMessageState

Returns:

The SOAP version of the current request as specified in the constructor. Never null.

getResourceHelper

@Nonnull
public AS4ResourceHelper getResourceHelper()

Specified by:

getResourceHelper in interface IAS4IncomingMessageState

Returns:

The resource manager as specified in the constructor. Never null.

getLocale

@Nonnull
public Locale getLocale()

Specified by:

getLocale in interface IAS4IncomingMessageState

Returns:

The request locale to use. Never null.

getMessaging

@Nullable
public Ebms3Messaging getMessaging()

Specified by:

getMessaging in interface IAS4IncomingMessageState

Returns:

The parent of the user message/signal message for further evaluation.

setMessaging

public void setMessaging(@Nullable
 Ebms3Messaging aMessaging)

getPMode

@Nullable
public IPMode getPMode()

Specified by:

getPMode in interface IAS4IncomingMessageState

Returns:

the PMode that is used with the current message. May be null if none was found.

setPMode

public void setPMode(@Nullable
 IPMode aPMode)

Set the PMode to be used. Called only from Ebms3 header processor

Parameters:

aPMode - PMode Config. May be null.

getOriginalSoapDocument

@Nullable
public Document getOriginalSoapDocument()

Specified by:

getOriginalSoapDocument in interface IAS4IncomingMessageState

Returns:

get the original SOAP document, only the entire document no attachment. This might by encrypted.

See Also:

• IAS4IncomingMessageState.hasDecryptedSoapDocument()
• IAS4IncomingMessageState.getDecryptedSoapDocument()

setOriginalSoapDocument

public void setOriginalSoapDocument(@Nullable
 Document aDocument)

getOriginalAttachments

@Nullable
public com.helger.commons.collection.impl.ICommonsList<WSS4JAttachment> getOriginalAttachments()

Specified by:

getOriginalAttachments in interface IAS4IncomingMessageState

Returns:

has saved the original attachment, can be encrypted or not depends if encryption is used or not.

See Also:

• IAS4IncomingMessageState.hasDecryptedAttachments()
• IAS4IncomingMessageState.getDecryptedAttachments()

setOriginalAttachments

public void setOriginalAttachments(@Nullable
 com.helger.commons.collection.impl.ICommonsList<WSS4JAttachment> aAttachments)

getDecryptedSoapDocument

@Nullable
public Document getDecryptedSoapDocument()

Specified by:

getDecryptedSoapDocument in interface IAS4IncomingMessageState

Returns:

get the decrypted SOAP document, only the entire document no attachment

See Also:

• IAS4IncomingMessageState.hasOriginalSoapDocument()
• IAS4IncomingMessageState.getOriginalSoapDocument()

setDecryptedSoapDocument

public void setDecryptedSoapDocument(@Nullable
 Document aDocument)

getDecryptedAttachments

@Nullable
public com.helger.commons.collection.impl.ICommonsList<WSS4JAttachment> getDecryptedAttachments()

Specified by:

getDecryptedAttachments in interface IAS4IncomingMessageState

Returns:

Getting decrypted attachment, if there were encrypted attachments to begin with. May be null.

See Also:

• IAS4IncomingMessageState.getOriginalAttachments()

setDecryptedAttachments

public void setDecryptedAttachments(@Nullable
 com.helger.commons.collection.impl.ICommonsList<WSS4JAttachment> aAttachments)

getCompressedAttachmentIDs

@Nullable
public com.helger.commons.collection.impl.ICommonsMap<String,EAS4CompressionMode> getCompressedAttachmentIDs()

Specified by:

getCompressedAttachmentIDs in interface IAS4IncomingMessageState

Returns:

IDs from all compressed attachments and/or payload. May be null.

setCompressedAttachmentIDs

public void setCompressedAttachmentIDs(@Nullable
 com.helger.commons.collection.impl.ICommonsMap<String,EAS4CompressionMode> aIDs)

getMPC

@Nullable
public IMPC getMPC()

Specified by:

getMPC in interface IAS4IncomingMessageState

Returns:

the MPC that is used in the current message exchange. May be null.

setMPC

public void setMPC(@Nullable
 IMPC aMPC)

isSoapBodyPayloadPresent

public boolean isSoapBodyPayloadPresent()

Specified by:

isSoapBodyPayloadPresent in interface IAS4IncomingMessageState

Returns:

true if a payload in the soap body is present, else false

See Also:

• IAS4IncomingMessageState.getSoapBodyPayloadNode()

setSoapBodyPayloadPresent

public void setSoapBodyPayloadPresent(boolean bHasSoapBodyPayload)

getInitiatorID

@Nullable
public String getInitiatorID()

Specified by:

getInitiatorID in interface IAS4IncomingMessageState

Returns:

initiator set in the usermessage if the incoming message is a UserMessage. This is the content of the FromParty/PartyId element and in Peppol reflects the C2. May be null.

setInitiatorID

public void setInitiatorID(@Nullable
 String sInitiatorID)

getResponderID

@Nullable
public String getResponderID()

Specified by:

getResponderID in interface IAS4IncomingMessageState

Returns:

responder set in the usermessage if the incoming message is a UserMessage. This is the content of the ToParty/PartyId element and in Peppol reflects the C3. May be null.

setResponderID

public void setResponderID(@Nullable
 String sResponderID)

getUsedCertificate

@Nullable
@Deprecated(forRemoval=true,
            since="3.0.5")
public X509Certificate getUsedCertificate()

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

Specified by:

getUsedCertificate in interface IAS4IncomingMessageState

Returns:

The first provided certificate in the incoming message. Usually the certificate that was used for signing. May be null.

See Also:

• IAS4IncomingMessageState.hasUsedCertificate()
• IAS4IncomingMessageState.getSigningCertificate()
• IAS4IncomingMessageState.getDecryptingCertificate()

setUsedCertificate

@Deprecated(forRemoval=true,
            since="3.0.5")
public void setUsedCertificate(@Nullable
 X509Certificate aCert)

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

getSigningCertificate

@Nullable
public X509Certificate getSigningCertificate()

Specified by:

getSigningCertificate in interface IAS4IncomingMessageState

Returns:

The signing certificate in the incoming message. May be null.

See Also:

• IAS4IncomingMessageState.hasSigningCertificate()

setSigningCertificate

public void setSigningCertificate(@Nullable
 X509Certificate aCert)

getDecryptingCertificate

@Nullable
public X509Certificate getDecryptingCertificate()

Specified by:

getDecryptingCertificate in interface IAS4IncomingMessageState

Returns:

The decrypting certificate in the incoming message. May be null.

See Also:

• IAS4IncomingMessageState.hasDecryptingCertificate()

setDecryptingCertificate

public void setDecryptingCertificate(@Nullable
 X509Certificate aCert)

getEffectivePModeLeg

@Nullable
public PModeLeg getEffectivePModeLeg()

Specified by:

getEffectivePModeLeg in interface IAS4IncomingMessageState

Returns:

The effective leg to use. May be leg 1 or leg 2 of the PMode. If no PMode was found, no PModeLeg is present.

See Also:

• IAS4IncomingMessageState.getPMode()

getEffectivePModeLegNumber

@CheckForSigned
public int getEffectivePModeLegNumber()

Specified by:

getEffectivePModeLegNumber in interface IAS4IncomingMessageState

Returns:

1 or 2, depending on the used leg. Any other value indicates "undefined". If no PMode was found, no PModeLeg is present.

See Also:

• IAS4IncomingMessageState.getEffectivePModeLeg()

setEffectivePModeLeg

public void setEffectivePModeLeg(@Nonnegative
 int nLegNumber,
 @Nullable
 PModeLeg aEffectiveLeg)

getSoapWSS4JSecurityActions

public int getSoapWSS4JSecurityActions()

Specified by:

getSoapWSS4JSecurityActions in interface IAS4IncomingMessageState

Returns:

A bit set of the WSS4J security action tags found. 0 for nothing. See class org.apache.wss4j.dom.WSContants line 326ff for the constants.

setSoapWSS4JSecurityActions

public void setSoapWSS4JSecurityActions(int nSecurityActions)

isSoapSignatureChecked

public boolean isSoapSignatureChecked()

Specified by:

isSoapSignatureChecked in interface IAS4IncomingMessageState

Returns:

true if the incoming message was signed and the signature was verified, false otherwise.

isSoapDecrypted

public boolean isSoapDecrypted()

Specified by:

isSoapDecrypted in interface IAS4IncomingMessageState

Returns:

true if the incoming message was decrypted, false otherwise.

getSoapWSS4JException

@Nullable
public Exception getSoapWSS4JException()

Specified by:

getSoapWSS4JException in interface IAS4IncomingMessageState

Returns:

An Exception that occurred during processing the incoming SOAP WS-Security handler. If this is a org.apache.wss4j.common.ext.WSSecurityException exception something happened on the security level.

setSoapWSS4JException

public void setSoapWSS4JException(@Nullable
 Exception aException)

getAS4Profile

@Nullable
public IAS4Profile getAS4Profile()

Specified by:

getAS4Profile in interface IAS4IncomingMessageState

Returns:

The phase4 profile to be used. May be null in case it could not be determined.

setAS4Profile

public void setAS4Profile(@Nullable
 IAS4Profile aProfile)

Set the AS4 profile of the message.

Parameters:

aProfile - The internal AS4 profile. May be null.

getMessageID

@Nullable
public String getMessageID()

Specified by:

getMessageID in interface IAS4IncomingMessageState

Returns:

The AS4 message ID. Source is the MessageInfo element. May be null.

setMessageID

public void setMessageID(@Nullable
 String sMessageID)

Set the AS4 message ID of the current message.

Parameters:

sMessageID - The ID to be set. May be null.

getRefToMessageID

@Nullable
public String getRefToMessageID()

Specified by:

getRefToMessageID in interface IAS4IncomingMessageState

Returns:

The AS4 "reference to message ID". This value is optional in the headers. Source is the MessageInfo element. May be null.

setRefToMessageID

public void setRefToMessageID(@Nullable
 String sRefMessageID)

Set the AS4 "reference to message ID" from the current message.

Parameters:

sRefMessageID - The ID to be set. May be null.

Since:

1.2.0

getMessageTimestamp

@Nullable
public com.helger.commons.datetime.XMLOffsetDateTime getMessageTimestamp()

Specified by:

getMessageTimestamp in interface IAS4IncomingMessageState

Returns:

The AS4 provided message timestamp. This value is mandatory in the source MessageInfo element. May be null.

setMessageTimestamp

public void setMessageTimestamp(@Nullable
 com.helger.commons.datetime.XMLOffsetDateTime aMessageTimestamp)

Set the AS4 message timestamp of the current message.

Parameters:

aMessageTimestamp - The timestamp to be set. May be null.

Since:

1.2.0

isPingMessage

public boolean isPingMessage()

Specified by:

isPingMessage in interface IAS4IncomingMessageState

Returns:

true if the incoming message is an AS4 ping message, false otherwise.

setPingMessage

public void setPingMessage(boolean bIsPingMessage)

getSoapBodyPayloadNode

@Nullable
public Node getSoapBodyPayloadNode()

Specified by:

getSoapBodyPayloadNode in interface IAS4IncomingMessageState

Returns:

The child of the SOAP Body node or null. That is always decrypted.

setSoapBodyPayloadNode

public void setSoapBodyPayloadNode(@Nullable
 Node aPayloadNode)

isSoapHeaderElementProcessingSuccessful

public boolean isSoapHeaderElementProcessingSuccessful()

Specified by:

isSoapHeaderElementProcessingSuccessful in interface IAS4IncomingMessageState

Returns:

true if SOAP header element processing was successful, false if not. If not, than many other values are also not set and at least one error is in the error list.

setSoapHeaderElementProcessingSuccessful

public void setSoapHeaderElementProcessingSuccessful(boolean bSuccess)

getCryptoFactorySign

@Nullable
public IAS4CryptoFactory getCryptoFactorySign()

Specified by:

getCryptoFactorySign in interface IAS4IncomingMessageState

Returns:

The crypto factory that was used to verify an eventually contained signature. May be null. If this is non-null it is NO indicator, whether a message was signed or not.

See Also:

• IAS4IncomingMessageState.isSoapSignatureChecked()

setCryptoFactorySign

@Nullable
public void setCryptoFactorySign(@Nullable
 IAS4CryptoFactory aCryptoFactorySign)

getCryptoFactoryCrypt

@Nullable
public IAS4CryptoFactory getCryptoFactoryCrypt()

Specified by:

getCryptoFactoryCrypt in interface IAS4IncomingMessageState

Returns:

The crypto factory that was used to decrypt an eventually encrypted message. May be null. If this is non-null it is NO indicator, whether a message was encrypted or not.

See Also:

• IAS4IncomingMessageState.isSoapDecrypted()

setCryptoFactoryCrypt

@Nullable
public void setCryptoFactoryCrypt(@Nullable
 IAS4CryptoFactory aCryptoFactoryCrypt)

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<String,Object>

Overrides:

equals in class com.helger.commons.collection.attr.AttributeContainer<String,Object>

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<String,Object>

Overrides:

hashCode in class com.helger.commons.collection.attr.AttributeContainer<String,Object>