-/*\r
- * Copyright 2001-2006 Internet2\r
- * \r
- * Licensed under the Apache License, Version 2.0 (the "License");\r
- * you may not use this file except in compliance with the License.\r
- * You may obtain a copy of the License at\r
- *\r
- * http://www.apache.org/licenses/LICENSE-2.0\r
- *\r
- * Unless required by applicable law or agreed to in writing, software\r
- * distributed under the License is distributed on an "AS IS" BASIS,\r
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
- * See the License for the specific language governing permissions and\r
- * limitations under the License.\r
- */\r
-\r
-/**\r
- * @file xmltooling/util/StorageService.h\r
- * \r
- * Generic data storage interface\r
- */\r
-\r
-#ifndef __xmltooling_storage_h__\r
-#define __xmltooling_storage_h__\r
-\r
-#include <xmltooling/XMLObject.h>\r
-\r
-#include <ctime>\r
-\r
-namespace xmltooling {\r
-\r
- /**\r
- * Generic data storage facility for use by services that require\r
- * some degree of persistence. Implementations will vary in how much\r
- * persistence they can supply.\r
- * \r
- * <p>Storage is divided into "contexts" identified by a string label.\r
- * Keys need to be unique only within a given context, so multiple\r
- * components can share a single storage service safely as long as they\r
- * use different labels.\r
- */\r
- class XMLTOOL_API StorageService\r
- {\r
- MAKE_NONCOPYABLE(StorageService);\r
- public:\r
- virtual ~StorageService() {}\r
- \r
- /**\r
- * Creates a new "short" record in the storage service.\r
- * \r
- * @param context a storage context label\r
- * @param key null-terminated unique key of up to 255 bytes\r
- * @param value null-terminated value of up to 255 bytes to store\r
- * @param expiration an expiration timestamp, after which the record can be purged\r
- * \r
- * @throws IOException raised if errors occur in the insertion process \r
- */\r
- virtual void createString(const char* context, const char* key, const char* value, time_t expiration)=0;\r
- \r
- /**\r
- * Returns an existing "short" record from the storage service.\r
- * \r
- * @param context a storage context label\r
- * @param key null-terminated unique key of up to 255 bytes\r
- * @param pvalue location in which to return the record value\r
- * @param pexpiration location in which to return the expiration timestamp\r
- * @return true iff a valid record exists and was returned \r
- * \r
- * @throws IOException raised if errors occur in the read process \r
- */\r
- virtual bool readString(const char* context, const char* key, std::string* pvalue=NULL, time_t* pexpiration=NULL)=0;\r
-\r
- /**\r
- * Updates an existing "short" record in the storage service.\r
- * \r
- * @param context a storage context label\r
- * @param key null-terminated unique key of up to 255 bytes\r
- * @param value null-terminated value of up to 255 bytes to store, or NULL to leave alone\r
- * @param expiration a new expiration timestamp, or 0 to leave alone\r
- * @return true iff the record exists and was updated\r
- * \r
- * @throws IOException raised if errors occur in the update process \r
- */\r
- virtual bool updateString(const char* context, const char* key, const char* value=NULL, time_t expiration=0)=0;\r
- \r
- /**\r
- * Deletes an existing "short" record from the storage service.\r
- * \r
- * @param context a storage context label\r
- * @param key null-terminated unique key of up to 255 bytes\r
- * @return true iff the record existed and was deleted\r
- * \r
- * @throws IOException raised if errors occur in the deletion process \r
- */\r
- virtual bool deleteString(const char* context, const char* key)=0;\r
- \r
- /**\r
- * Creates a new "long" record in the storage service.\r
- * \r
- * @param context a storage context label\r
- * @param key null-terminated unique key of up to 255 bytes\r
- * @param value null-terminated value of arbitrary length\r
- * @param expiration an expiration timestamp, after which the record can be purged\r
- * \r
- * @throws IOException raised if errors occur in the insertion process \r
- */\r
- virtual void createText(const char* context, const char* key, const char* value, time_t expiration)=0;\r
- \r
- /**\r
- * Returns an existing "long" record from the storage service.\r
- * \r
- * @param context a storage context label\r
- * @param key null-terminated unique key of up to 255 bytes\r
- * @param pvalue location in which to return the record value\r
- * @param pexpiration location in which to return the expiration timestamp\r
- * @return true iff a valid record exists and was returned \r
- * \r
- * @throws IOException raised if errors occur in the read process \r
- */\r
- virtual bool readText(const char* context, const char* key, std::string* pvalue=NULL, time_t* pexpiration=NULL)=0;\r
-\r
- /**\r
- * Updates an existing "long" record in the storage service.\r
- * \r
- * @param context a storage context label\r
- * @param key null-terminated unique key of up to 255 bytes\r
- * @param value null-terminated value of arbitrary length to store, or NULL to leave alone\r
- * @param expiration a new expiration timestamp, or 0 to leave alone\r
- * @return true iff the record exists and was updated\r
- * \r
- * @throws IOException raised if errors occur in the update process \r
- */\r
- virtual bool updateText(const char* context, const char* key, const char* value=NULL, time_t expiration=0)=0;\r
- \r
- /**\r
- * Deletes an existing "long" record from the storage service.\r
- * \r
- * @param context a storage context label\r
- * @param key null-terminated unique key of up to 255 bytes\r
- * @return true iff the record existed and was deleted\r
- * \r
- * @throws IOException raised if errors occur in the deletion process \r
- */\r
- virtual bool deleteText(const char* context, const char* key)=0;\r
- \r
- /**\r
- * Manually trigger a cleanup of expired records.\r
- * The method <strong>MAY</strong> return without guaranteeing that\r
- * cleanup has already occurred.\r
- * \r
- * @param context a storage context label\r
- */\r
- virtual void reap(const char* context)=0;\r
- \r
- /**\r
- * Forcibly removes all records in a given context along with any\r
- * associated resources devoted to maintaining the context.\r
- * \r
- * @param context a storage context label\r
- */\r
- virtual void deleteContext(const char* context)=0;\r
-\r
- protected:\r
- StorageService() {}\r
- };\r
-\r
- /**\r
- * Registers StorageService classes into the runtime.\r
- */\r
- void XMLTOOL_API registerStorageServices();\r
-\r
- /** StorageService based on in-memory caching. */\r
- #define MEMORY_STORAGE_SERVICE "org.opensaml.xmlooling.MemoryStorageService"\r
-};\r
-\r
-#endif /* __xmltooling_storage_h__ */\r
+/*
+ * 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
+ *
+ * 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.
+ */
+
+/**
+ * @file xmltooling/util/StorageService.h
+ *
+ * Generic data storage interface
+ */
+
+#ifndef __xmltooling_storage_h__
+#define __xmltooling_storage_h__
+
+#include <xmltooling/XMLObject.h>
+
+#include <ctime>
+
+namespace xmltooling {
+
+ /**
+ * Generic data storage facility for use by services that require
+ * some degree of persistence. Implementations will vary in how much
+ * persistence they can supply.
+ *
+ * <p>Storage is divided into "contexts" identified by a string label.
+ * 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.
+ */
+ class XMLTOOL_API StorageService
+ {
+ MAKE_NONCOPYABLE(StorageService);
+ public:
+ virtual ~StorageService() {}
+
+ /**
+ * Creates a new "short" record in the storage service.
+ *
+ * @param context a storage context label
+ * @param key null-terminated unique key of up to 255 bytes
+ * @param value null-terminated value of up to 255 bytes to store
+ * @param expiration an expiration timestamp, after which the record can be purged
+ *
+ * @throws IOException raised if errors occur in the insertion process
+ */
+ virtual void createString(const char* context, const char* key, const char* value, time_t expiration)=0;
+
+ /**
+ * Returns an existing "short" record from the storage service.
+ *
+ * @param context a storage context label
+ * @param key null-terminated unique key of up to 255 bytes
+ * @param pvalue location in which to return the record value
+ * @param pexpiration location in which to return the expiration timestamp
+ * @return true iff a valid record exists and was returned
+ *
+ * @throws IOException raised if errors occur in the read process
+ */
+ virtual bool readString(const char* context, const char* key, std::string* pvalue=NULL, time_t* pexpiration=NULL)=0;
+
+ /**
+ * Updates an existing "short" record in the storage service.
+ *
+ * @param context a storage context label
+ * @param key null-terminated unique key of up to 255 bytes
+ * @param value null-terminated value of up to 255 bytes to store, or NULL to leave alone
+ * @param expiration a new expiration timestamp, or 0 to leave alone
+ * @return true iff the record exists and was updated
+ *
+ * @throws IOException raised if errors occur in the update process
+ */
+ virtual bool updateString(const char* context, const char* key, const char* value=NULL, time_t expiration=0)=0;
+
+ /**
+ * Deletes an existing "short" record from the storage service.
+ *
+ * @param context a storage context label
+ * @param key null-terminated unique key of up to 255 bytes
+ * @return true iff the record existed and was deleted
+ *
+ * @throws IOException raised if errors occur in the deletion process
+ */
+ virtual bool deleteString(const char* context, const char* key)=0;
+
+ /**
+ * Creates a new "long" record in the storage service.
+ *
+ * @param context a storage context label
+ * @param key null-terminated unique key of up to 255 bytes
+ * @param value null-terminated value of arbitrary length
+ * @param expiration an expiration timestamp, after which the record can be purged
+ *
+ * @throws IOException raised if errors occur in the insertion process
+ */
+ virtual void createText(const char* context, const char* key, const char* value, time_t expiration)=0;
+
+ /**
+ * Returns an existing "long" record from the storage service.
+ *
+ * @param context a storage context label
+ * @param key null-terminated unique key of up to 255 bytes
+ * @param pvalue location in which to return the record value
+ * @param pexpiration location in which to return the expiration timestamp
+ * @return true iff a valid record exists and was returned
+ *
+ * @throws IOException raised if errors occur in the read process
+ */
+ virtual bool readText(const char* context, const char* key, std::string* pvalue=NULL, time_t* pexpiration=NULL)=0;
+
+ /**
+ * Updates an existing "long" record in the storage service.
+ *
+ * @param context a storage context label
+ * @param key null-terminated unique key of up to 255 bytes
+ * @param value null-terminated value of arbitrary length to store, or NULL to leave alone
+ * @param expiration a new expiration timestamp, or 0 to leave alone
+ * @return true iff the record exists and was updated
+ *
+ * @throws IOException raised if errors occur in the update process
+ */
+ virtual bool updateText(const char* context, const char* key, const char* value=NULL, time_t expiration=0)=0;
+
+ /**
+ * Deletes an existing "long" record from the storage service.
+ *
+ * @param context a storage context label
+ * @param key null-terminated unique key of up to 255 bytes
+ * @return true iff the record existed and was deleted
+ *
+ * @throws IOException raised if errors occur in the deletion process
+ */
+ virtual bool deleteText(const char* context, const char* key)=0;
+
+ /**
+ * Manually trigger a cleanup of expired records.
+ * The method <strong>MAY</strong> return without guaranteeing that
+ * cleanup has already occurred.
+ *
+ * @param context a storage context label
+ */
+ virtual void reap(const char* context)=0;
+
+ /**
+ * Forcibly removes all records in a given context along with any
+ * associated resources devoted to maintaining the context.
+ *
+ * @param context a storage context label
+ */
+ virtual void deleteContext(const char* context)=0;
+
+ protected:
+ StorageService() {}
+ };
+
+ /**
+ * Registers StorageService classes into the runtime.
+ */
+ void XMLTOOL_API registerStorageServices();
+
+ /** StorageService based on in-memory caching. */
+ #define MEMORY_STORAGE_SERVICE "org.opensaml.xmlooling.MemoryStorageService"
+};
+
+#endif /* __xmltooling_storage_h__ */
projects / shibboleth / cpp-xmltooling.git / blobdiff