shibsp/metadata/MetadataProviderCriteria.h

   1 /*
   2  *  Copyright 2001-2008 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 shibsp/metadata/MetadataProviderCriteria.h
  19  *
  20  * Extended criteria for metadata lookup for Shibboleth-aware metadata providers.
  21  */
  22
  23 #ifndef __shibsp_metaprovcrit_h__
  24 #define __shibsp_metaprovcrit_h__
  25
  26 #include <shibsp/Application.h>
  27 #include <saml/saml2/metadata/MetadataProvider.h>
  28
  29 namespace shibsp {
  30
  31     /**
  32      * Extended criteria for metadata lookup for Shibboleth-aware metadata providers.
  33      */
  34     struct SHIBSP_API MetadataProviderCriteria : public opensaml::saml2md::MetadataProvider::Criteria
  35     {
  36         /**
  37          * Constructor.
  38          *
  39          * @param app   application performing the lookup
  40          * @param id    entityID to lookup
  41          * @param q     element/type of role, if any
  42          * @param prot  protocol support constant, if any
  43          * @param valid true iff stale metadata should be ignored
  44          */
  45         MetadataProviderCriteria(const Application& app, const XMLCh* id, const xmltooling::QName* q=NULL, const XMLCh* prot=NULL, bool valid=true)
  46             : opensaml::saml2md::MetadataProvider::Criteria(id, q, prot, valid), application(app) {
  47         }
  48
  49         /**
  50          * Constructor.
  51          *
  52          * @param app   application performing the lookup
  53          * @param id    entityID to lookup
  54          * @param q     element/type of role, if any
  55          * @param prot  protocol support constant, if any
  56          * @param valid true iff stale metadata should be ignored
  57          */
  58         MetadataProviderCriteria(const Application& app, const char* id, const xmltooling::QName* q=NULL, const XMLCh* prot=NULL, bool valid=true)
  59             : opensaml::saml2md::MetadataProvider::Criteria(id, q, prot, valid), application(app) {
  60         }
  61
  62         /**
  63          * Constructor.
  64          *
  65          * @param app   application performing the lookup
  66          * @param a     artifact to lookup
  67          * @param q     element/type of role, if any
  68          * @param prot  protocol support constant, if any
  69          * @param valid true iff stale metadata should be ignored
  70          */
  71         MetadataProviderCriteria(const Application& app, const opensaml::SAMLArtifact* a, const xmltooling::QName* q=NULL, const XMLCh* prot=NULL, bool valid=true)
  72             : opensaml::saml2md::MetadataProvider::Criteria(a, q, prot, valid), application(app) {
  73         }
  74
  75         /** Controls whether stale metadata is ignored. */
  76         const Application& application;
  77     };
  78 };
  79
  80 #endif /* __shibsp_metaprovcrit_h__ */