saml/saml2/metadata/EntityMatcher.h

   1 /**
   2  * Licensed to the University Corporation for Advanced Internet
   3  * Development, Inc. (UCAID) under one or more contributor license
   4  * agreements. See the NOTICE file distributed with this work for
   5  * additional information regarding copyright ownership.
   6  *
   7  * UCAID licenses this file to you under the Apache License,
   8  * Version 2.0 (the "License"); you may not use this file except
   9  * in compliance with the License. You may obtain a copy of the
  10  * License at
  11  *
  12  * http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing,
  15  * software distributed under the License is distributed on an
  16  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
  17  * either express or implied. See the License for the specific
  18  * language governing permissions and limitations under the License.
  19  */
  20
  21 /**
  22  * @file saml/saml2/metadata/EntityMatcher.h
  23  *
  24  * Applies a set of matching rules to an entity.
  25  */
  26
  27 #include <saml/base.h>
  28
  29 #ifndef __saml2_entitymatcher_h__
  30 #define __saml2_entitymatcher_h__
  31
  32 namespace opensaml {
  33     namespace saml2md {
  34
  35         class SAML_API EntityDescriptor;
  36
  37         /**
  38          * An entity matcher is a predicate that evaluates an entity against a set of matching rules.
  39          */
  40         class SAML_API EntityMatcher
  41         {
  42             MAKE_NONCOPYABLE(EntityMatcher);
  43         protected:
  44             EntityMatcher();
  45         public:
  46             virtual ~EntityMatcher();
  47
  48             /**
  49              * Applies the instance's matching rule(s) against an entity.
  50              *
  51              * @param entity the entity to evaluate
  52              * @return  true iff the entity is matched
  53              */
  54             virtual bool matches(const EntityDescriptor& entity) const=0;
  55         };
  56
  57         /**
  58          * Registers EntityMatcher classes into the runtime.
  59          */
  60         void SAML_API registerEntityMatchers();
  61
  62         /** EntityMatcher that matches based on name. */
  63         #define NAME_ENTITY_MATCHER "Name"
  64
  65         /** EntityMatcher that applies a set of input attributes. */
  66         #define ENTITYATTR_ENTITY_MATCHER "EntityAttributes"
  67     };
  68 };
  69
  70 #endif /* __saml2_entitymatcher_h__ */