saml/binding/MessageRoutingRule.h

   1 /*
   2  *  Copyright 2001-2006 Internet2
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /**
  18  * @file saml/binding/MessageRoutingRule.h
  19  *
  20  * Routing rule that enforces message delivery to an intended destination
  21  */
  22
  23 #include <saml/binding/SecurityPolicyRule.h>
  24
  25
  26 namespace opensaml {
  27     /**
  28      * Routing rule that enforces message delivery to an intended destination
  29      *
  30      * Subclasses can provide support for additional message types
  31      * by overriding the destination derivation method.
  32      */
  33     class SAML_API MessageRoutingRule : public SecurityPolicyRule
  34     {
  35     public:
  36         /**
  37          * Constructor.
  38          *
  39          * If an XML attribute named mandatory is set to "true" or "1", then
  40          * a destination address <strong>MUST</strong> be present in the message.
  41          *
  42          * @param e DOM tree to initialize rule
  43          */
  44         MessageRoutingRule(const DOMElement* e);
  45         virtual ~MessageRoutingRule() {}
  46
  47         std::pair<saml2::Issuer*,const saml2md::RoleDescriptor*> evaluate(
  48             const GenericRequest& request,
  49             const xmltooling::XMLObject& message,
  50             const saml2md::MetadataProvider* metadataProvider,
  51             const xmltooling::QName* role,
  52             const TrustEngine* trustEngine
  53             ) const;
  54
  55         /**
  56          * Controls whether rule insists on presence of destination address in
  57          * the message.
  58          *
  59          * @param mandatory  flag value to set
  60          */
  61         void setMandatory(bool mandatory) {
  62             m_mandatory = mandatory;
  63         }
  64
  65     protected:
  66         /**
  67          * Examines the message and/or its contents and extracts the destination
  68          * address/URL, if specified.
  69          *
  70          * @param message       message to examine
  71          * @return  the destination address/URL, or NULL
  72          */
  73         virtual const XMLCh* getDestination(const xmltooling::XMLObject& message) const;
  74
  75     private:
  76         bool m_mandatory;
  77     };
  78
  79 };