xmltooling/util/ReplayCache.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 xmltooling/util/ReplayCache.h
  23  *
  24  * Helper class on top of StorageService for detecting message replay.
  25  */
  26
  27 #if !defined(__xmltooling_replay_h__) && !defined(XMLTOOLING_LITE)
  28 #define __xmltooling_replay_h__
  29
  30 #include <xmltooling/base.h>
  31
  32 namespace xmltooling {
  33
  34     class XMLTOOL_API StorageService;
  35
  36     /**
  37      * Helper class on top of StorageService for detecting message replay.
  38      */
  39     class XMLTOOL_API ReplayCache
  40     {
  41     MAKE_NONCOPYABLE(ReplayCache);
  42     public:
  43
  44         /**
  45          * Creates a replay cache on top of a particular StorageService.
  46          *
  47          * The lifetime of the StorageService <strong>MUST</strong> be longer than
  48          * the lifetime of the ReplayCache.
  49          *
  50          * @param storage       pointer to a StorageService, or nullptr to keep cache in memory
  51          */
  52         ReplayCache(StorageService* storage=nullptr);
  53
  54         virtual ~ReplayCache();
  55
  56         /**
  57          * Returns true iff the check value is not found in the cache, and stores it.
  58          *
  59          * @param context   a context label to subdivide the cache
  60          * @param s         value to check
  61          * @param expires   time for disposal of value from cache
  62          */
  63         virtual bool check(const char* context, const char* s, time_t expires);
  64
  65         /**
  66          * Returns true iff the check value is not found in the cache, and stores it.
  67          *
  68          * @param context   a context label to subdivide the cache
  69          * @param s         value to check
  70          * @param expires   time for disposal of value from cache
  71          */
  72         bool check(const char* context, const XMLCh* s, time_t expires);
  73
  74     private:
  75         bool m_owned;
  76         StorageService* m_storage;
  77     };
  78 };
  79
  80 #endif /* __xmltooling_replay_h__ */