saml/util/CommonDomainCookie.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/util/CommonDomainCookie.h
  23  *
  24  * Helper class for maintaining discovery cookie.
  25  */
  26
  27 #ifndef __saml_cdc_h__
  28 #define __saml_cdc_h__
  29
  30 #include <saml/base.h>
  31
  32 #include <string>
  33 #include <vector>
  34
  35 #if defined (_MSC_VER)
  36     #pragma warning( push )
  37     #pragma warning( disable : 4250 4251 )
  38 #endif
  39
  40 namespace opensaml {
  41     /**
  42      * Helper class for maintaining discovery cookie.
  43      */
  44     class SAML_API CommonDomainCookie {
  45         MAKE_NONCOPYABLE(CommonDomainCookie);
  46     public:
  47         /**
  48          * Parses a cookie for reading or writing.
  49          *
  50          * @param cookie    the raw cookie value
  51          */
  52         CommonDomainCookie(const char* cookie);
  53
  54         ~CommonDomainCookie();
  55
  56         /**
  57          * Returns list of IdPs stored in cookie.
  58          *
  59          * @return  reference to vector of entityIDs
  60          */
  61         const std::vector<std::string>& get() const;
  62
  63         /**
  64          * Adds/moves an IdP to the front of the list.
  65          *
  66          * @param entityID  name of IdP to add
  67          * @return new value of cookie
  68          */
  69         const char* set(const char* entityID);
  70
  71         /** Name of cookie ("_saml_idp") */
  72         static const char CDCName[];
  73
  74     private:
  75         std::string m_encoded;
  76         std::vector<std::string> m_list;
  77     };
  78 };
  79
  80 #if defined (_MSC_VER)
  81     #pragma warning( pop )
  82 #endif
  83
  84 #endif /* __saml_cdc_h__ */