Security-57337.40.85.tar.gz

[apple/security.git] / OSX / libsecurity_utilities / lib / CSPDLTransaction.h

diff --git a/OSX/libsecurity_utilities/lib/CSPDLTransaction.h b/OSX/libsecurity_utilities/lib/CSPDLTransaction.h
new file mode 100644 (file)
index 0000000..2a5adce
--- /dev/null
+++ b/OSX/libsecurity_utilities/lib/CSPDLTransaction.h
@@ -0,0 +1,77 @@
+/*
+ * Copyright (c) 2015 Apple Inc. All Rights Reserved.
+ *
+ * @APPLE_LICENSE_HEADER_START@
+ *
+ * This file contains Original Code and/or Modifications of Original Code
+ * as defined in and that are subject to the Apple Public Source License
+ * Version 2.0 (the 'License'). You may not use this file except in
+ * compliance with the License. Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this
+ * file.
+ *
+ * The Original Code and all software distributed under the License are
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
+ * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
+ * limitations under the License.
+ *
+ * @APPLE_LICENSE_HEADER_END@
+ */
+
+#ifndef _H_CSPDLTRANSACTION
+#define _H_CSPDLTRANSACTION
+
+#include <security_cdsa_client/dlclient.h>
+
+//
+// This class performs a transaction on a CSPDL database.
+//
+// It will commit when:
+//
+// 1) success() has been called
+// 2) the object goes out of scope OR finalize() is called
+//
+// if success() has not been called, the transaction will roll back instead.
+//
+// You can nest transaction objects, but I don't really suggest it...
+//
+class DLTransaction {
+public:
+    DLTransaction(CSSM_DL_DB_HANDLE dldbh);
+
+    ~DLTransaction();
+
+    // Everything has gone right; this transaction will commit.
+    // If you don't call this, the transaction will roll back.
+    void success();
+
+    // Commit or rollback as appropriate
+    void finalize();
+
+protected:
+    DLTransaction();
+
+    // Actually toggle autocommit using the dldbh
+    void initialize();
+
+    CSSM_DL_DB_HANDLE mDldbh;
+
+    bool mSuccess;
+    bool mFinalized;
+
+    CSSM_BOOL mAutoCommit;
+};
+
+class CSPDLTransaction : public DLTransaction {
+public:
+    CSPDLTransaction(Security::CssmClient::Db& db);
+    ~CSPDLTransaction();
+
+private:
+    Security::CssmClient::Db& mDb;
+};
+
+#endif // _H_CSPDLTRANSACTION