Merge branch '1.x' of ssh://authdev.it.ohio-state.edu/~scantor/git/cpp-xmltooling...

[shibboleth/cpp-xmltooling.git] / xmltooling / util / ReplayCache.h

diff --git a/xmltooling/util/ReplayCache.h b/xmltooling/util/ReplayCache.h
index 1300d89..6c95ee7 100644 (file)
--- a/xmltooling/util/ReplayCache.h
+++ b/xmltooling/util/ReplayCache.h
@@ -1,17 +1,21 @@
-/*
- *  Copyright 2001-2006 Internet2
- * 
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
+/**
+ * Licensed to the University Corporation for Advanced Internet
+ * Development, Inc. (UCAID) under one or more contributor license
+ * agreements. See the NOTICE file distributed with this work for
+ * additional information regarding copyright ownership.
+ *
+ * UCAID licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License. You may obtain a copy of the
+ * License at
  *
- *     http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
  *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the License.
  */
 
 /**
@@ -20,27 +24,32 @@
  * Helper class on top of StorageService for detecting message replay.
  */
 
-#ifndef __xmltooling_replay_h__
+#if !defined(__xmltooling_replay_h__) && !defined(XMLTOOLING_LITE)
 #define __xmltooling_replay_h__
 
-#include <xmltooling/util/StorageService.h>
+#include <xmltooling/base.h>
 
 namespace xmltooling {
 
+    class XMLTOOL_API StorageService;
+
     /**
      * Helper class on top of StorageService for detecting message replay.
      */
     class XMLTOOL_API ReplayCache
     {
-        MAKE_NONCOPYABLE(ReplayCache);
+    MAKE_NONCOPYABLE(ReplayCache);
     public:
         
         /**
          * Creates a replay cache on top of a particular StorageService.
+         *
+         * The lifetime of the StorageService <strong>MUST</strong> be longer than
+         * the lifetime of the ReplayCache.
          * 
-         * @param storage       pointer to a StorageService, or NULL to keep cache in memory
+         * @param storage       pointer to a StorageService, or nullptr to keep cache in memory
          */
-        ReplayCache(StorageService* storage=NULL);
+        ReplayCache(StorageService* storage=nullptr);
 
         virtual ~ReplayCache();
         
@@ -53,12 +62,17 @@ namespace xmltooling {
          */
         virtual bool check(const char* context, const char* s, time_t expires);
     
-        bool check(const char* context, const XMLCh* str, time_t expires) {
-            auto_ptr_char temp(str);
-            return check(context, temp.get(), expires);
-        }
+        /**
+         * Returns true iff the check value is not found in the cache, and stores it.
+         * 
+         * @param context   a context label to subdivide the cache
+         * @param s         value to check
+         * @param expires   time for disposal of value from cache
+         */
+        bool check(const char* context, const XMLCh* s, time_t expires);
         
     private:
+        bool m_owned;
         StorageService* m_storage;
     };
 };