Package com.helger.phase4.incoming.soap

Interface ISoapHeaderElementProcessor

All Known Implementing Classes:

SoapHeaderElementProcessorExtractEbms3Messaging, SoapHeaderElementProcessorWSS4J

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface ISoapHeaderElementProcessor

Base interface for SOAP header processors that are invoked for incoming messages.

Author:

Philip Helger

Method Summary

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

Method Details

processHeaderElement

@NonNull com.helger.base.state.ESuccess processHeaderElement(@NonNull Document aSoapDoc,
 @NonNull Element aHeaderElement,
 @NonNull com.helger.collection.commons.ICommonsList<WSS4JAttachment> aAttachments,
 @NonNull AS4IncomingMessageState aIncomingState,
 @NonNull AS4ErrorList aProcessingErrorMessagesTarget)

Process the passed header element.

Parameters:

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

aHeaderElement - 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".