Package org.opensaml.messaging.handler.impl

Class AbstractMessageChannelSecurity

  • All Implemented Interfaces:
    net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.InitializableComponent, org.opensaml.messaging.handler.MessageHandler
    Direct Known Subclasses:
    StaticMessageChannelSecurity, URLEvaluatingMessageChannelSecurity
    public abstract class AbstractMessageChannelSecurity
extends org.opensaml.messaging.handler.AbstractMessageHandler
    Abstract base class for message handlers which populate a MessageChannelSecurityContext on a BaseContext, where the latter is located using a lookup strategy.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private org.opensaml.messaging.context.BaseContext parentContext
      Parent for eventual context.
      private Function<org.opensaml.messaging.context.MessageContext,​org.opensaml.messaging.context.BaseContext> parentContextLookupStrategy
      Strategy used to look up the parent BaseContext on which the MessageChannelSecurityContext will be populated.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected boolean doPreInvoke​(org.opensaml.messaging.context.MessageContext messageContext)
      protected org.opensaml.messaging.context.BaseContext getParentContext()
      Get the parent context on which the MessageChannelSecurityContext will be populated.
      void setParentContextLookupStrategy​(Function<org.opensaml.messaging.context.MessageContext,​org.opensaml.messaging.context.BaseContext> strategy)
      Set the strategy used to look up the parent BaseContext on which the MessageChannelSecurityContext will be populated.

      • Methods inherited from class org.opensaml.messaging.handler.AbstractMessageHandler

        doInvoke, doPostInvoke, doPostInvoke, getActivationCondition, getLogPrefix, invoke, setActivationCondition

      • Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

        destroy, doDestroy, doInitialize, initialize, isDestroyed, isInitialized

      • Methods inherited from interface net.shibboleth.utilities.java.support.component.InitializableComponent

        initialize, isInitialized

    • Field Detail

      • parentContextLookupStrategy

        @Nonnull
private Function<org.opensaml.messaging.context.MessageContext,​org.opensaml.messaging.context.BaseContext> parentContextLookupStrategy
        Strategy used to look up the parent BaseContext on which the MessageChannelSecurityContext will be populated.

      • parentContext

        @Nullable
private org.opensaml.messaging.context.BaseContext parentContext
        Parent for eventual context.

    • Constructor Detail

      • AbstractMessageChannelSecurity

        public AbstractMessageChannelSecurity()
        Constructor.

    • Method Detail

      • setParentContextLookupStrategy

        public void setParentContextLookupStrategy​(@Nonnull
                                           Function<org.opensaml.messaging.context.MessageContext,​org.opensaml.messaging.context.BaseContext> strategy)
        Set the strategy used to look up the parent BaseContext on which the MessageChannelSecurityContext will be populated.
        Parameters:
        strategy - strategy used to look up the parent BaseContext on which to populate the MessageChannelSecurityContext

      • doPreInvoke

        protected boolean doPreInvoke​(@Nonnull
                              org.opensaml.messaging.context.MessageContext messageContext)
                       throws org.opensaml.messaging.handler.MessageHandlerException
        Overrides:
        doPreInvoke in class org.opensaml.messaging.handler.AbstractMessageHandler
        Throws:
        org.opensaml.messaging.handler.MessageHandlerException

      • getParentContext

        protected org.opensaml.messaging.context.BaseContext getParentContext()
        Get the parent context on which the MessageChannelSecurityContext will be populated.
        Returns:
        the parent context