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.
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
12 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 * @file saml/saml2/metadata/EntityMatcher.h
24 * Applies a set of matching rules to an entity.
27 #include <saml/base.h>
29 #ifndef __saml2_entitymatcher_h__
30 #define __saml2_entitymatcher_h__
35 class SAML_API EntityDescriptor;
38 * An entity matcher is a predicate that evaluates an entity against a set of matching rules.
40 class SAML_API EntityMatcher
42 MAKE_NONCOPYABLE(EntityMatcher);
46 virtual ~EntityMatcher();
49 * Applies the instance's matching rule(s) against an entity.
51 * @param entity the entity to evaluate
52 * @return true iff the entity is matched
54 virtual bool matches(const EntityDescriptor& entity) const=0;
58 * Registers EntityMatcher classes into the runtime.
60 void SAML_API registerEntityMatchers();
62 /** EntityMatcher that matches based on name. */
63 #define NAME_ENTITY_MATCHER "Name"
65 /** EntityMatcher that applies a set of input attributes. */
66 #define ENTITYATTR_ENTITY_MATCHER "EntityAttributes"
70 #endif /* __saml2_entitymatcher_h__ */