saml/saml2/metadata/MetadataCredentialCriteria.h

   1 /*
   2  *  Copyright 2001-2009 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/saml2/metadata/MetadataCredentialCriteria.h
  19  *
  20  * Metadata-based CredentialCriteria subclass.
  21  */
  22
  23 #ifndef __saml_metacrit_h__
  24 #define __saml_metacrit_h__
  25
  26 #include <saml/base.h>
  27 #include <xmltooling/security/CredentialCriteria.h>
  28
  29 namespace opensaml {
  30     namespace saml2md {
  31
  32         /**
  33          * Metadata-based CredentialCriteria subclass.
  34          */
  35         class SAML_API MetadataCredentialCriteria : public xmltooling::CredentialCriteria
  36         {
  37         public:
  38             /**
  39              * Constructor.
  40              *
  41              * @param role      source of metadata-supplied credentials
  42              */
  43             MetadataCredentialCriteria(const RoleDescriptor& role);
  44
  45             virtual ~MetadataCredentialCriteria() {}
  46
  47             /**
  48              * Return the metadata role associated with the credentials.
  49              *
  50              * @return the associated metadata role
  51              */
  52             const RoleDescriptor& getRole() const {
  53                 return m_role;
  54             }
  55
  56             void reset();
  57             bool matches(const xmltooling::Credential& credential) const;
  58
  59         private:
  60             const RoleDescriptor& m_role;
  61         };
  62     };
  63 };
  64
  65 #endif /* __saml_metacrit_h__ */