Package com.helger.phase4.incoming.soap

Class SoapHeaderElementProcessorExtractEbms3Messaging

java.lang.Object

com.helger.phase4.incoming.soap.SoapHeaderElementProcessorExtractEbms3Messaging

All Implemented Interfaces:

ISoapHeaderElementProcessor

public class SoapHeaderElementProcessorExtractEbms3Messaging
extends Object
implements ISoapHeaderElementProcessor

This class manages the EBMS Messaging SOAP header element

Author:

Philip Helger, bayerlma, Gregor Scholtysik

Field Summary

Fields

Modifier and Type	Field	Description
static final QName	QNAME_MESSAGING	The QName for which this processor should be invoked

Constructor Summary

Constructors

Constructor	Description
SoapHeaderElementProcessorExtractEbms3Messaging(IAS4PModeResolver aPModeResolver, Consumer<? super IPMode> aPModeConsumer, IAS4IncomingReceiverConfiguration aIRC)	Ctor

Method Summary

Modifier and Type	Method	Description
com.helger.commons.state.ESuccess	processHeaderElement(Document aSoapDoc, Element aElement, com.helger.commons.collection.impl.ICommonsList<WSS4JAttachment> aAttachments, AS4IncomingMessageState aIncomingState, com.helger.commons.collection.impl.ICommonsList<Ebms3Error> aProcessingErrorMessagesTarget)	Process the passed header element.

Methods inherited from class java.lang.Object

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

Field Details

QNAME_MESSAGING

public static final QName QNAME_MESSAGING

The QName for which this processor should be invoked

Constructor Details

SoapHeaderElementProcessorExtractEbms3Messaging

public SoapHeaderElementProcessorExtractEbms3Messaging(@Nonnull
 IAS4PModeResolver aPModeResolver,
 @Nullable
 Consumer<? super IPMode> aPModeConsumer,
 @Nonnull
 IAS4IncomingReceiverConfiguration aIRC)

Ctor

Parameters:

aPModeResolver - The PMode resolver to be used. May not be null.

aPModeConsumer - An optional consumer that is invoked every time a PMode was successfully resolved. May be null.

aIRC - The incoming receiver configuration. May not be null. Since v3.0.0.

Method Details

processHeaderElement

@Nonnull
public com.helger.commons.state.ESuccess processHeaderElement(@Nonnull
 Document aSoapDoc,
 @Nonnull
 Element aElement,
 @Nonnull
 com.helger.commons.collection.impl.ICommonsList<WSS4JAttachment> aAttachments,
 @Nonnull
 AS4IncomingMessageState aIncomingState,
 @Nonnull
 com.helger.commons.collection.impl.ICommonsList<Ebms3Error> aProcessingErrorMessagesTarget)

Description copied from interface: ISoapHeaderElementProcessor

Process the passed header element.

Specified by:

processHeaderElement in interface ISoapHeaderElementProcessor

Parameters:

aSoapDoc - The complete SOAP document (logically no MIME parts are contained). Never null.

aElement - The DOM node with the header element. Never null.

aAttachments - Existing extracted attachments. Never null but maybe empty.

aIncomingState - The current processing state (mutable implementation version needed). Never null.

aProcessingErrorMessagesTarget - The error list to be filled in case there are processing errors. Never null. The list is always empty initially.

Returns:

Never null. If ESuccess.FAILURE than the header is treated as "not handled".