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

/*
 * 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 <TargetConditionals.h>

#if TARGET_OS_OSX

#include <security_cdsa_client/dlclient.h>

//
// This class performs a transaction on a CSPDL database.
//
// If commit() has not yet been called when the object goes out of scope, the transaction will roll back instead (exceptions will be swallowed).
//
// Nesting transactions will likely work, but isn't recommended.
//
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 when the object goes out of scope.
    // Might throw on error.
    void commit();

protected:
    DLTransaction();

    // Note: disables autocommit using the dldbh
    void initialize();

    // Call rollback if necessary. Never throws.
    void finalize();

    // Rolls back database transactions. Might throw.
    void rollback();

    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 //TARGET_OS_OSX

#endif // _H_CSPDLTRANSACTION
Commit	Line	Data
e3d460c9 A	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
866f8763 A	27	#include <TargetConditionals.h>
	28
	29	#if TARGET_OS_OSX
	30
e3d460c9 A	31	#include <security_cdsa_client/dlclient.h>
	32
	33	//
	34	// This class performs a transaction on a CSPDL database.
	35	//
fa7225c8	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).
e3d460c9	37	//
fa7225c8	38	// Nesting transactions will likely work, but isn't recommended.
e3d460c9 A	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.
fa7225c8 A	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();
e3d460c9 A	50
	51	protected:
	52	DLTransaction();
	53
fa7225c8	54	// Note: disables autocommit using the dldbh
e3d460c9 A	55	void initialize();
e3d460c9 A	56
fa7225c8 A	57	// Call rollback if necessary. Never throws.
	58	void finalize();
	59
	60	// Rolls back database transactions. Might throw.
	61	void rollback();
	62
e3d460c9 A	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
866f8763 A	80	#endif //TARGET_OS_OSX
866f8763 A	81
e3d460c9	82	#endif // _H_CSPDLTRANSACTION