Package org.opensaml.soap.messaging

Class AbstractHeaderGeneratingMessageHandler

java.lang.Object
net.shibboleth.shared.component.AbstractInitializableComponent
org.opensaml.messaging.handler.AbstractMessageHandler
org.opensaml.soap.messaging.AbstractHeaderGeneratingMessageHandler
All Implemented Interfaces:
Component, DestructableComponent, InitializableComponent, MessageHandler
public abstract class AbstractHeaderGeneratingMessageHandler extends AbstractMessageHandler
Abstract base class for message handlers that generate SOAP headers.

  • Field Details

    • mustUnderstand

      private boolean mustUnderstand
      The statically configured value for mustUnderstand.

    • mustUnderstandStrategy

      @Nullable private Predicate<MessageContext> mustUnderstandStrategy
      Predicate strategy for evaluating mustUnderstand from the message context.

    • effectiveMustUnderstand

      private boolean effectiveMustUnderstand
      The effective mustUnderstand value to use.

    • targetNode

      @Nullable private String targetNode
      The statically configured value for target node (SOAP 1.1 actor or SOAP 1.2 role).

    • targetNodeStrategy

      @Nullable private Function<MessageContext,String> targetNodeStrategy
      Function strategy for resolving target node from the message context.

    • effectiveTargetNode

      @Nullable private String effectiveTargetNode
      The effective target node value to use.

  • Constructor Details

    • AbstractHeaderGeneratingMessageHandler

      public AbstractHeaderGeneratingMessageHandler()

  • Method Details

    • setMustUnderstand

      public void setMustUnderstand(boolean flag)
      Set the statically configured value for mustUnderstand.
      Parameters:
      flag - true if header must be understood, false if not

    • setMustUnderstandStrategy

      public void setMustUnderstandStrategy(@Nullable Predicate<MessageContext> strategy)
      Set the predicate strategy for evaluating mustUnderstand from the message context.
      Parameters:
      strategy - the predicate strategy

    • isEffectiveMustUnderstand

      protected boolean isEffectiveMustUnderstand()
      Get the effective value for mustUnderstand.
      Returns:
      the effective value for mustUnderstand.

    • setTargetNode

      public void setTargetNode(@Nullable String node)
      Set the statically configured value for target node (SOAP 1.1 actor or SOAP 1.2 role).
      Parameters:
      node - the target node, may be null

    • setTargetNodeStrategy

      public void setTargetNodeStrategy(@Nullable Function<MessageContext,String> strategy)
      Set the predicate strategy for evaluating mustUnderstand from the message context.
      Parameters:
      strategy - the predicate strategy

    • getEffectiveTargetNode

      protected String getEffectiveTargetNode()
      Get the effective value for target node (SOAP 1.1 actor or SOAP 1.2 role).
      Returns:
      the effective value for target node

    • doPreInvoke

      protected boolean doPreInvoke(@Nonnull MessageContext messageContext) throws MessageHandlerException
      Overrides:
      doPreInvoke in class AbstractMessageHandler
      Throws:
      MessageHandlerException

    • decorateGeneratedHeader

      protected void decorateGeneratedHeader(@Nonnull MessageContext messageContext, @Nonnull XMLObject header)
      Decorate the header based on configured and/or resolved values.
      Parameters:
      messageContext - the current message context
      header - the header to decorate