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 <TargetConditionals.h>
  28
  29 #if TARGET_OS_OSX
  30
  31 #include <security_cdsa_client/dlclient.h>
  32
  33 //
  34 // This class performs a transaction on a CSPDL database.
  35 //
  36 // If commit() has not yet been called when the object goes out of scope, the transaction will roll back instead (exceptions will be swallowed).
  37 //
  38 // Nesting transactions will likely work, but isn't recommended.
  39 //
  40 class DLTransaction {
  41 public:
  42     DLTransaction(CSSM_DL_DB_HANDLE dldbh);
  43
  44     ~DLTransaction();
  45
  46     // Everything has gone right; this transaction will commit.
  47     // If you don't call this, the transaction will roll back when the object goes out of scope.
  48     // Might throw on error.
  49     void commit();
  50
  51 protected:
  52     DLTransaction();
  53
  54     // Note: disables autocommit using the dldbh
  55     void initialize();
  56
  57     // Call rollback if necessary. Never throws.
  58     void finalize();
  59
  60     // Rolls back database transactions. Might throw.
  61     void rollback();
  62
  63     CSSM_DL_DB_HANDLE mDldbh;
  64
  65     bool mSuccess;
  66     bool mFinalized;
  67
  68     CSSM_BOOL mAutoCommit;
  69 };
  70
  71 class CSPDLTransaction : public DLTransaction {
  72 public:
  73     CSPDLTransaction(Security::CssmClient::Db& db);
  74     ~CSPDLTransaction();
  75
  76 private:
  77     Security::CssmClient::Db& mDb;
  78 };
  79
  80 #endif //TARGET_OS_OSX
  81
  82 #endif // _H_CSPDLTRANSACTION