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 // It will commit when:
  33 //
  34 // 1) success() has been called
  35 // 2) the object goes out of scope OR finalize() is called
  36 //
  37 // if success() has not been called, the transaction will roll back instead.
  38 //
  39 // You can nest transaction objects, but I don't really suggest it...
  40 //
  41 class DLTransaction {
  42 public:
  43     DLTransaction(CSSM_DL_DB_HANDLE dldbh);
  44
  45     ~DLTransaction();
  46
  47     // Everything has gone right; this transaction will commit.
  48     // If you don't call this, the transaction will roll back.
  49     void success();
  50
  51     // Commit or rollback as appropriate
  52     void finalize();
  53
  54 protected:
  55     DLTransaction();
  56
  57     // Actually toggle autocommit using the dldbh
  58     void initialize();
  59
  60     CSSM_DL_DB_HANDLE mDldbh;
  61
  62     bool mSuccess;
  63     bool mFinalized;
  64
  65     CSSM_BOOL mAutoCommit;
  66 };
  67
  68 class CSPDLTransaction : public DLTransaction {
  69 public:
  70     CSPDLTransaction(Security::CssmClient::Db& db);
  71     ~CSPDLTransaction();
  72
  73 private:
  74     Security::CssmClient::Db& mDb;
  75 };
  76
  77 #endif // _H_CSPDLTRANSACTION