*/
#include "internal.h"
+#include "logging.h"
+#include "security/SecurityHelper.h"
#include "util/ReplayCache.h"
-#include "util/StorageService.h"
+using namespace xmltooling::logging;
using namespace xmltooling;
using namespace std;
-ReplayCache::ReplayCache(StorageService* storage) : m_owned(storage==nullptr), m_storage(storage)
+ReplayCache::ReplayCache(StorageService* storage)
+ : m_owned(storage==nullptr),
+ m_storage(storage ? storage : XMLToolingConfig::getConfig().StorageServiceManager.newPlugin(MEMORY_STORAGE_SERVICE, nullptr)),
+ m_storageCaps(m_storage->getCapabilities())
{
- if (!m_storage)
- m_storage = XMLToolingConfig::getConfig().StorageServiceManager.newPlugin(MEMORY_STORAGE_SERVICE, nullptr);
}
ReplayCache::~ReplayCache()
bool ReplayCache::check(const char* context, const char* s, time_t expires)
{
+ if (strlen(context) > m_storageCaps.getContextSize()) {
+ // This is a design/coding failure.
+ Category::getInstance(XMLTOOLING_LOGCAT".ReplayCache").error(
+ "context (%s) too long for StorageService (limit %u)", context, m_storageCaps.getContextSize()
+ );
+ return false;
+ }
+ else if (strlen(s) > m_storageCaps.getKeySize()) {
+ // This is something to work around with a hash.
+#ifndef XMLTOOLING_NO_XMLSEC
+ string h = SecurityHelper::doHash("SHA1", s, strlen(s));
+ // In storage already?
+ if (m_storage->readString(context, h.c_str()))
+ return false;
+ m_storage->createString(context, h.c_str(), "x", expires);
+ return true;
+#else
+ Category::getInstance(XMLTOOLING_LOGCAT".ReplayCache").error(
+ "key (%s) too long for StorageService (limit %u)", s, m_storageCaps.getKeySize()
+ );
+ return false;
+#endif
+ }
+
// In storage already?
if (m_storage->readString(context, s))
return false;
* Keys need to be unique only within a given context, so multiple
* components can share a single storage service safely as long as they
* use different labels.
+ *
+ * <p>The allowable sizes for contexts, keys, and short values can vary
+ * and be reported by the implementation to callers, but MUST be at least
+ * 255 bytes.
*/
class XMLTOOL_API StorageService
{
MAKE_NONCOPYABLE(StorageService);
public:
virtual ~StorageService();
+
+ class XMLTOOL_API Capabilities {
+ MAKE_NONCOPYABLE(Capabilities);
+ unsigned int m_contextSize, m_keySize, m_stringSize;
+ public:
+ /**
+ * Constructor.
+ *
+ * @param contextSize max size of context labels in characters
+ * @param keysize max size of keys in characters
+ * @param stringSize max size of string values in characters
+ */
+ Capabilities(unsigned int contextSize, unsigned int keySize, unsigned int stringSize);
+ ~Capabilities();
+
+ /**
+ * Returns max size of context labels in characters
+ * @return max size of context labels in characters
+ */
+ unsigned int getContextSize() const;
+
+ /**
+ * Returns max size of keys in characters
+ * @return max size of keys in characters
+ */
+ unsigned int getKeySize() const;
+
+ /**
+ * Returns max size of string values in characters
+ * @return max size of string values in characters
+ */
+ unsigned int getStringSize() const;
+ };
/**
+ * Returns the capabilities of the underlying service.
+ * <p>If implementations support only the 255 character minimum, the default
+ * implementation of this method will suffice.
+ *
+ * @return a reference to an interface to access the service's capabilities
+ */
+ virtual const Capabilities& getCapabilities() const;
+
+ /**
* Creates a new "short" record in the storage service.
*
- * @param context a storage context label of up to 255 bytes
- * @param key null-terminated unique key of up to 255 bytes
- * @param value null-terminated value of up to 255 bytes to store
+ * @param context a storage context label
+ * @param key null-terminated unique key
+ * @param value null-terminated value
* @param expiration an expiration timestamp, after which the record can be purged
* @return true iff record was inserted, false iff a duplicate was found
*
*
* <p>The version parameter can be set for "If-Modified-Since" semantics.
*
- * @param context a storage context label of up to 255 bytes
- * @param key null-terminated unique key of up to 255 bytes
+ * @param context a storage context label
+ * @param key null-terminated unique key
* @param pvalue location in which to return the record value
* @param pexpiration location in which to return the expiration timestamp
* @param version if > 0, only copy back data if newer than supplied version
/**
* Updates an existing "short" record in the storage service.
*
- * @param context a storage context label of up to 255 bytes
- * @param key null-terminated unique key of up to 255 bytes
- * @param value null-terminated value of up to 255 bytes to store, or nullptr to leave alone
+ * @param context a storage context label
+ * @param key null-terminated unique key
+ * @param value null-terminated value to store, or nullptr to leave alone
* @param expiration a new expiration timestamp, or 0 to leave alone
* @param version if > 0, only update if the current version matches this value
* @return the version of the record after update, 0 if no record exists, or -1 if the version
/**
* Deletes an existing "short" record from the storage service.
*
- * @param context a storage context label of up to 255 bytes
- * @param key null-terminated unique key of up to 255 bytes
+ * @param context a storage context label
+ * @param key null-terminated unique key
* @return true iff the record existed and was deleted
*
* @throws IOException raised if errors occur in the deletion process
/**
* Creates a new "long" record in the storage service.
*
- * @param context a storage context label of up to 255 bytes
- * @param key null-terminated unique key of up to 255 bytes
+ * @param context a storage context label
+ * @param key null-terminated unique key
* @param value null-terminated value of arbitrary length
* @param expiration an expiration timestamp, after which the record can be purged
* @return true iff record was inserted, false iff a duplicate was found
*
* <p>The version parameter can be set for "If-Modified-Since" semantics.
*
- * @param context a storage context label of up to 255 bytes
- * @param key null-terminated unique key of up to 255 bytes
+ * @param context a storage context label
+ * @param key null-terminated unique key
* @param pvalue location in which to return the record value
* @param pexpiration location in which to return the expiration timestamp
* @param version if > 0, only copy back data if newer than supplied version
/**
* Updates an existing "long" record in the storage service.
*
- * @param context a storage context label of up to 255 bytes
- * @param key null-terminated unique key of up to 255 bytes
+ * @param context a storage context label
+ * @param key null-terminated unique key
* @param value null-terminated value of arbitrary length to store, or nullptr to leave alone
* @param expiration a new expiration timestamp, or 0 to leave alone
* @param version if > 0, only update if the current version matches this value
/**
* Deletes an existing "long" record from the storage service.
*
- * @param context a storage context label of up to 255 bytes
- * @param key null-terminated unique key of up to 255 bytes
+ * @param context a storage context label
+ * @param key null-terminated unique key
* @return true iff the record existed and was deleted
*
* @throws IOException raised if errors occur in the deletion process