com.helger.as4.servlet

Class AS4MessageState

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

java.util.LinkedHashMap<KEYTYPE,VALUETYPE>

com.helger.commons.collection.impl.CommonsLinkedHashMap<KEYTYPE,VALUETYPE>

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

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

com.helger.as4.servlet.AS4MessageState

All Implemented Interfaces:

IAS4MessageState, 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>, Serializable, Cloneable, Map<String,Object>

@NotThreadSafe
public class AS4MessageState
extends com.helger.commons.collection.attr.AttributeContainerAny<String>
implements IAS4MessageState

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

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 and Description
AS4MessageState(com.helger.as4.soap.ESOAPVersion eSOAPVersion, com.helger.as4.util.AS4ResourceManager aResMgr)

Method Summary

Modifier and Type	Method and Description
com.helger.commons.collection.impl.ICommonsMap<String,com.helger.as4.attachment.EAS4CompressionMode>	getCompressedAttachmentIDs()
com.helger.commons.collection.impl.ICommonsList<com.helger.as4.attachment.WSS4JAttachment>	getDecryptedAttachments()
Document	getDecryptedSOAPDocument()
com.helger.as4.model.pmode.leg.PModeLeg	getEffectivePModeLeg()
int	getEffectivePModeLegNumber()
String	getInitiatorID()
com.helger.as4lib.ebms3header.Ebms3Messaging	getMessaging()
com.helger.as4.model.mpc.IMPC	getMPC()
com.helger.commons.collection.impl.ICommonsList<com.helger.as4.attachment.WSS4JAttachment>	getOriginalAttachments()
com.helger.as4.model.pmode.IPMode	getPMode()
LocalDateTime	getReceiptDT()
com.helger.as4.util.AS4ResourceManager	getResourceMgr()
String	getResponderID()
com.helger.as4.soap.ESOAPVersion	getSOAPVersion()
X509Certificate	getUsedCertificate()
boolean	isSoapBodyPayloadPresent()
boolean	isSoapDecrypted()
boolean	isSoapSignatureChecked()
void	setCompressedAttachmentIDs(com.helger.commons.collection.impl.ICommonsMap<String,com.helger.as4.attachment.EAS4CompressionMode> aIDs)
void	setDecryptedAttachments(com.helger.commons.collection.impl.ICommonsList<com.helger.as4.attachment.WSS4JAttachment> aAttachments)
void	setDecryptedSOAPDocument(Document aDocument)
void	setEffectivePModeLeg(int nLegNumber, com.helger.as4.model.pmode.leg.PModeLeg aEffectiveLeg)
void	setInitiatorID(String sInitiatorID)
void	setMessaging(com.helger.as4lib.ebms3header.Ebms3Messaging aMessaging)
void	setMPC(com.helger.as4.model.mpc.IMPC aMPC)
void	setOriginalAttachments(com.helger.commons.collection.impl.ICommonsList<com.helger.as4.attachment.WSS4JAttachment> aAttachments)
void	setPMode(com.helger.as4.model.pmode.IPMode aPMode) Set the PMode to be used.
void	setResponderID(String sResponderID)
void	setSoapBodyPayloadPresent(boolean bHasSoapBodyPayload)
void	setSoapDecrypted(boolean bDecrypted)
void	setSoapSignatureChecked(boolean bSignatureChecked)
void	setUsedCertificate(X509Certificate aCert)

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

getClone

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

afterSetValueCallbacks, beforeSetValueCallbacks, equals, hashCode, 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, removeEldestEntry, replaceAll, values

Methods inherited from class java.util.HashMap

clone, compute, computeIfAbsent, computeIfPresent, containsKey, isEmpty, merge, 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.as4.servlet.IAS4MessageState

containsCompressedAttachmentID, getAttachmentCompressionMode, getRefToMessageID, hasCompressedAttachmentIDs, hasDecryptedAttachments, hasDecryptedSOAPDocument, hasOriginalAttachments

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

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

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

addAll, containsAnyEntry, containsAnyKey, containsAnyValue, copyOfEntrySet, copyOfKeySet, copyOfKeySet, copyOfValues, copyOfValues, copyOfValuesMapped, copyOfValuesMapped, createInstance, 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 java.util.Map

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

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 com.helger.commons.collection.attr.IAttributeContainerAny

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

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

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

Constructor Detail

AS4MessageState

public AS4MessageState(@Nonnull
                       com.helger.as4.soap.ESOAPVersion eSOAPVersion,
                       @Nonnull
                       com.helger.as4.util.AS4ResourceManager aResMgr)

Method Detail

getReceiptDT

@Nonnull
public final LocalDateTime getReceiptDT()

Specified by:

getReceiptDT in interface IAS4MessageState

Returns:

Date and time when the receipt started. This is constantly set in the constructor and never null.

getSOAPVersion

@Nonnull
public final com.helger.as4.soap.ESOAPVersion getSOAPVersion()

Specified by:

getSOAPVersion in interface IAS4MessageState

Returns:

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

getResourceMgr

@Nonnull
public final com.helger.as4.util.AS4ResourceManager getResourceMgr()

Specified by:

getResourceMgr in interface IAS4MessageState

Returns:

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

setMessaging

public void setMessaging(@Nullable
                         com.helger.as4lib.ebms3header.Ebms3Messaging aMessaging)

getMessaging

@Nullable
public com.helger.as4lib.ebms3header.Ebms3Messaging getMessaging()

Specified by:

getMessaging in interface IAS4MessageState

Returns:

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

setPMode

public void setPMode(@Nullable
                     com.helger.as4.model.pmode.IPMode aPMode)

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

Parameters:

aPMode - PMode Config. May be null.

getPMode

@Nullable
public com.helger.as4.model.pmode.IPMode getPMode()

Specified by:

getPMode in interface IAS4MessageState

Returns:

the PMode that is used with the current message

setOriginalAttachments

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

getOriginalAttachments

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

Specified by:

getOriginalAttachments in interface IAS4MessageState

Returns:

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

setDecryptedSOAPDocument

public void setDecryptedSOAPDocument(@Nullable
                                     Document aDocument)

getDecryptedSOAPDocument

@Nullable
public Document getDecryptedSOAPDocument()

Specified by:

getDecryptedSOAPDocument in interface IAS4MessageState

Returns:

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

setDecryptedAttachments

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

getDecryptedAttachments

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

Specified by:

getDecryptedAttachments in interface IAS4MessageState

Returns:

getting decrypted attachment, if there were encrypted attachments to begin with

setCompressedAttachmentIDs

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

getCompressedAttachmentIDs

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

Specified by:

getCompressedAttachmentIDs in interface IAS4MessageState

Returns:

IDs from all compressed attachments and/or payload

setMPC

public void setMPC(@Nullable
                   com.helger.as4.model.mpc.IMPC aMPC)

getMPC

@Nullable
public com.helger.as4.model.mpc.IMPC getMPC()

Specified by:

getMPC in interface IAS4MessageState

Returns:

the MPC that is used in the current message exchange

setSoapBodyPayloadPresent

public void setSoapBodyPayloadPresent(boolean bHasSoapBodyPayload)

isSoapBodyPayloadPresent

public boolean isSoapBodyPayloadPresent()

Specified by:

isSoapBodyPayloadPresent in interface IAS4MessageState

Returns:

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

setInitiatorID

public void setInitiatorID(@Nullable
                           String sInitiatorID)

getInitiatorID

@Nullable
public String getInitiatorID()

Specified by:

getInitiatorID in interface IAS4MessageState

Returns:

initiator set in the usermessage if the incoming message is a usermessage

setResponderID

public void setResponderID(@Nullable
                           String sResponderID)

getResponderID

@Nullable
public String getResponderID()

Specified by:

getResponderID in interface IAS4MessageState

Returns:

responder set in the usermessage if the incoming message is a usermessage

setUsedCertificate

public void setUsedCertificate(@Nullable
                               X509Certificate aCert)

getUsedCertificate

@Nullable
public X509Certificate getUsedCertificate()

Specified by:

getUsedCertificate in interface IAS4MessageState

Returns:

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

setEffectivePModeLeg

public void setEffectivePModeLeg(@Nonnegative
                                 int nLegNumber,
                                 @Nullable
                                 com.helger.as4.model.pmode.leg.PModeLeg aEffectiveLeg)

getEffectivePModeLeg

@Nullable
public com.helger.as4.model.pmode.leg.PModeLeg getEffectivePModeLeg()

Specified by:

getEffectivePModeLeg in interface IAS4MessageState

Returns:

The effective leg to use. May be leg 1 or leg 2 of the PMode.

See Also:

IAS4MessageState.getPMode()

getEffectivePModeLegNumber

@CheckForSigned
public int getEffectivePModeLegNumber()

Specified by:

getEffectivePModeLegNumber in interface IAS4MessageState

Returns:

1 or 2, depending on the used leg. Any other value indicates "undefined".

setSoapSignatureChecked

public void setSoapSignatureChecked(boolean bSignatureChecked)

isSoapSignatureChecked

public boolean isSoapSignatureChecked()

Specified by:

isSoapSignatureChecked in interface IAS4MessageState

Returns:

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

setSoapDecrypted

public void setSoapDecrypted(boolean bDecrypted)

isSoapDecrypted

public boolean isSoapDecrypted()

Specified by:

isSoapDecrypted in interface IAS4MessageState

Returns:

true if the incoming message was decrypted, false otherwise.