com.helger.as4.servlet

Interface IAS4MessageState

All Superinterfaces:

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

All Known Implementing Classes:

AS4MessageState

public interface IAS4MessageState
extends com.helger.commons.collection.attr.IAttributeContainer<String,Object>

Read-only AS4 message state.

Author:

Philip Helger

Nested Class Summary

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>

Method Summary

Modifier and Type	Method and Description
default boolean	containsCompressedAttachmentID(String sID)
default com.helger.as4.attachment.EAS4CompressionMode	getAttachmentCompressionMode(String sID)
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()
default String	getRefToMessageID()
com.helger.as4.util.AS4ResourceManager	getResourceMgr()
String	getResponderID()
com.helger.as4.soap.ESOAPVersion	getSOAPVersion()
X509Certificate	getUsedCertificate()
default boolean	hasCompressedAttachmentIDs()
default boolean	hasDecryptedAttachments()
default boolean	hasDecryptedSOAPDocument()
default boolean	hasOriginalAttachments()
boolean	isSoapBodyPayloadPresent()
boolean	isSoapDecrypted()
boolean	isSoapSignatureChecked()

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

Method Detail

getReceiptDT

@Nonnull
LocalDateTime getReceiptDT()

Returns:

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

getSOAPVersion

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

Returns:

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

getResourceMgr

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

Returns:

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

getMessaging

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

Returns:

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

getRefToMessageID

@Nullable
default String getRefToMessageID()

getPMode

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

Returns:

the PMode that is used with the current message

getOriginalAttachments

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

Returns:

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

hasOriginalAttachments

default boolean hasOriginalAttachments()

getDecryptedSOAPDocument

@Nullable
Document getDecryptedSOAPDocument()

Returns:

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

hasDecryptedSOAPDocument

default boolean hasDecryptedSOAPDocument()

getDecryptedAttachments

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

Returns:

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

hasDecryptedAttachments

default boolean hasDecryptedAttachments()

getCompressedAttachmentIDs

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

Returns:

IDs from all compressed attachments and/or payload

hasCompressedAttachmentIDs

default boolean hasCompressedAttachmentIDs()

getAttachmentCompressionMode

@Nullable
default com.helger.as4.attachment.EAS4CompressionMode getAttachmentCompressionMode(@Nullable
                                                                                              String sID)

Parameters:

sID - id to look up

Returns:

Looks up if a compression mode with the id sID exists and returns the mode else null

containsCompressedAttachmentID

default boolean containsCompressedAttachmentID(@Nullable
                                               String sID)

Parameters:

sID - the id to look up

Returns:

looks up if the compressed attachment contain the given ID

getMPC

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

Returns:

the MPC that is used in the current message exchange

isSoapBodyPayloadPresent

boolean isSoapBodyPayloadPresent()

Returns:

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

getInitiatorID

@Nullable
String getInitiatorID()

Returns:

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

getResponderID

@Nullable
String getResponderID()

Returns:

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

getUsedCertificate

@Nullable
X509Certificate getUsedCertificate()

Returns:

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

getEffectivePModeLeg

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

Returns:

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

See Also:

getPMode()

getEffectivePModeLegNumber

@CheckForSigned
int getEffectivePModeLegNumber()

Returns:

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

isSoapSignatureChecked

boolean isSoapSignatureChecked()

Returns:

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

isSoapDecrypted

boolean isSoapDecrypted()

Returns:

true if the incoming message was decrypted, false otherwise.