Package org.opensaml.saml.common.binding.security.impl

Class BaseSAMLXMLSignatureSecurityHandler

  • 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:
    SAMLProtocolMessageXMLSignatureSecurityHandler
    public abstract class BaseSAMLXMLSignatureSecurityHandler
extends org.opensaml.security.messaging.impl.BaseTrustEngineSecurityHandler<org.opensaml.xmlsec.signature.Signature>
    Base class for SAML security message handlers which evaluate a signature with a signature trust engine.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private org.opensaml.saml.common.messaging.context.SAMLPeerEntityContext peerContext
      The context representing the SAML peer entity.
      private org.opensaml.saml.common.messaging.context.SAMLProtocolContext samlProtocolContext
      The SAML protocol context in operation.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected net.shibboleth.utilities.java.support.resolver.CriteriaSet buildCriteriaSet​(String entityID, org.opensaml.messaging.context.MessageContext messageContext)
      protected boolean doPreInvoke​(org.opensaml.messaging.context.MessageContext messageContext)
      protected org.opensaml.saml.common.messaging.context.SAMLPeerEntityContext getSAMLPeerEntityContext()
      Get the SAMLPeerEntityContext associated with the message.
      protected org.opensaml.saml.common.messaging.context.SAMLProtocolContext getSAMLProtocolContext()
      Get the SAMLProtocolContext associated with the message.
      protected org.opensaml.security.trust.TrustEngine<org.opensaml.xmlsec.signature.Signature> resolveTrustEngine​(org.opensaml.messaging.context.MessageContext messageContext)

      • Methods inherited from class org.opensaml.security.messaging.impl.BaseTrustEngineSecurityHandler

        evaluate, evaluate, getTrustEngine

      • 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

      • peerContext

        @Nullable
private org.opensaml.saml.common.messaging.context.SAMLPeerEntityContext peerContext
        The context representing the SAML peer entity.

      • samlProtocolContext

        @Nullable
private org.opensaml.saml.common.messaging.context.SAMLProtocolContext samlProtocolContext
        The SAML protocol context in operation.

    • Constructor Detail

      • BaseSAMLXMLSignatureSecurityHandler

        public BaseSAMLXMLSignatureSecurityHandler()

    • Method Detail

      • getSAMLPeerEntityContext

        @Nullable
protected org.opensaml.saml.common.messaging.context.SAMLPeerEntityContext getSAMLPeerEntityContext()
        Get the SAMLPeerEntityContext associated with the message.
        Returns:
        the peer context

      • getSAMLProtocolContext

        @Nullable
protected org.opensaml.saml.common.messaging.context.SAMLProtocolContext getSAMLProtocolContext()
        Get the SAMLProtocolContext associated with the message.
        Returns:
        the protocol context

      • doPreInvoke

        protected boolean doPreInvoke​(@Nonnull
                              org.opensaml.messaging.context.MessageContext messageContext)
                       throws org.opensaml.messaging.handler.MessageHandlerException
        Overrides:
        doPreInvoke in class org.opensaml.security.messaging.impl.BaseTrustEngineSecurityHandler<org.opensaml.xmlsec.signature.Signature>
        Throws:
        org.opensaml.messaging.handler.MessageHandlerException

      • resolveTrustEngine

        @Nullable
protected org.opensaml.security.trust.TrustEngine<org.opensaml.xmlsec.signature.Signature> resolveTrustEngine​(@Nonnull
                                                                                                              org.opensaml.messaging.context.MessageContext messageContext)
        Specified by:
        resolveTrustEngine in class org.opensaml.security.messaging.impl.BaseTrustEngineSecurityHandler<org.opensaml.xmlsec.signature.Signature>

      • buildCriteriaSet

        @Nonnull
protected net.shibboleth.utilities.java.support.resolver.CriteriaSet buildCriteriaSet​(@Nullable
                                                                                      String entityID,
                                                                                      @Nonnull
                                                                                      org.opensaml.messaging.context.MessageContext messageContext)
                                                                               throws org.opensaml.messaging.handler.MessageHandlerException
        Specified by:
        buildCriteriaSet in class org.opensaml.security.messaging.impl.BaseTrustEngineSecurityHandler<org.opensaml.xmlsec.signature.Signature>
        Throws:
        org.opensaml.messaging.handler.MessageHandlerException