saml/binding/ReplayCache.h

   1 /*\r
   2  *  Copyright 2001-2006 Internet2\r
   3  * \r
   4  * Licensed under the Apache License, Version 2.0 (the "License");\r
   5  * you may not use this file except in compliance with the License.\r
   6  * You may obtain a copy of the License at\r
   7  *\r
   8  *     http://www.apache.org/licenses/LICENSE-2.0\r
   9  *\r
  10  * Unless required by applicable law or agreed to in writing, software\r
  11  * distributed under the License is distributed on an "AS IS" BASIS,\r
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  13  * See the License for the specific language governing permissions and\r
  14  * limitations under the License.\r
  15  */\r
  16 \r
  17 /**\r
  18  * @file saml/binding/ReplayCache.h\r
  19  * \r
  20  * Helper class on top of StorageService for detecting message replay.\r
  21  */\r
  22 \r
  23 #ifndef __saml_replay_h__\r
  24 #define __saml_replay_h__\r
  25 \r
  26 #include <saml/base.h>\r
  27 #include <xmltooling/util/StorageService.h>\r
  28 \r
  29 namespace opensaml {\r
  30 \r
  31     /**\r
  32      * Helper class on top of StorageService for detecting message replay.\r
  33      */\r
  34     class SAML_API ReplayCache\r
  35     {\r
  36         MAKE_NONCOPYABLE(ReplayCache);\r
  37     public:\r
  38         \r
  39         /**\r
  40          * Creates a replay cache on top of a particular StorageService.\r
  41          * \r
  42          * @param storage       pointer to a StorageService, or NULL to keep cache in memory\r
  43          */\r
  44         ReplayCache(xmltooling::StorageService* storage=NULL);\r
  45 \r
  46         virtual ~ReplayCache();\r
  47         \r
  48         /**\r
  49          * Returns true iff the check value is not found in the cache, and stores it.\r
  50          * \r
  51          * @param context   a context label to subdivide the cache\r
  52          * @param s         value to check\r
  53          * @param expires   time for disposal of value from cache\r
  54          */\r
  55         virtual bool check(const char* context, const char* s, time_t expires);\r
  56     \r
  57         bool check(const char* context, const XMLCh* str, time_t expires) {\r
  58             xmltooling::auto_ptr_char temp(str);\r
  59             return check(context, temp.get(), expires);\r
  60         }\r
  61         \r
  62     private:\r
  63         xmltooling::StorageService* m_storage;\r
  64     };\r
  65 };\r
  66 \r
  67 #endif /* __saml_replay_h__ */\r