Package com.helger.phase4.servlet.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
com.helger.commons.state.ESuccess	processHeaderElement(Document aSOAPDoc, Element aHeaderElement, com.helger.commons.collection.impl.ICommonsList<WSS4JAttachment> aAttachments, AS4MessageState aState, com.helger.commons.collection.impl.ICommonsList<Ebms3Error> aProcessingErrorMessagesTarget)	Process the passed header element.

Method Details

processHeaderElement

@Nonnull
com.helger.commons.state.ESuccess processHeaderElement(@Nonnull
 Document aSOAPDoc,
 @Nonnull
 Element aHeaderElement,
 @Nonnull
 com.helger.commons.collection.impl.ICommonsList<WSS4JAttachment> aAttachments,
 @Nonnull
 AS4MessageState aState,
 @Nonnull
 com.helger.commons.collection.impl.ICommonsList<Ebms3Error> 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.

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