OSX/libsecurity_utilities/lib/CSPDLTransaction.h

   1 /*
   2  * Copyright (c) 2015 Apple Inc. All Rights Reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24 #ifndef _H_CSPDLTRANSACTION
  25 #define _H_CSPDLTRANSACTION
  26
  27 #include <security_cdsa_client/dlclient.h>
  28
  29 //
  30 // This class performs a transaction on a CSPDL database.
  31 //
  32 // If commit() has not yet been called when the object goes out of scope, the transaction will roll back instead (exceptions will be swallowed).
  33 //
  34 // Nesting transactions will likely work, but isn't recommended.
  35 //
  36 class DLTransaction {
  37 public:
  38     DLTransaction(CSSM_DL_DB_HANDLE dldbh);
  39
  40     ~DLTransaction();
  41
  42     // Everything has gone right; this transaction will commit.
  43     // If you don't call this, the transaction will roll back when the object goes out of scope.
  44     // Might throw on error.
  45     void commit();
  46
  47 protected:
  48     DLTransaction();
  49
  50     // Note: disables autocommit using the dldbh
  51     void initialize();
  52
  53     // Call rollback if necessary. Never throws.
  54     void finalize();
  55
  56     // Rolls back database transactions. Might throw.
  57     void rollback();
  58
  59     CSSM_DL_DB_HANDLE mDldbh;
  60
  61     bool mSuccess;
  62     bool mFinalized;
  63
  64     CSSM_BOOL mAutoCommit;
  65 };
  66
  67 class CSPDLTransaction : public DLTransaction {
  68 public:
  69     CSPDLTransaction(Security::CssmClient::Db& db);
  70     ~CSPDLTransaction();
  71
  72 private:
  73     Security::CssmClient::Db& mDb;
  74 };
  75
  76 #endif // _H_CSPDLTRANSACTION