OSX/sec/SOSCircle/Regressions/CKDKeyValueStore.h

   1 /*
   2  * Copyright (c) 2012,2014 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
  25 #import <Foundation/Foundation.h>
  26 //#import "CKDKVSProxy.h"
  27 #import "SOSCloudKeychainConstants.h"
  28 #import "SOSCloudKeychainClient.h"
  29
  30 extern CFStringRef kCKDKVSRemoteStoreID;
  31 extern CFStringRef kCKDAWSRemoteStoreID;
  32
  33 //--- protocol ---
  34
  35 @protocol CKDKVSDelegate <NSObject>
  36
  37 @required
  38
  39 - (id)objectForKey:(NSString *)aKey;
  40 - (void)setObject:(id)anObject forKey:(NSString *)aKey;
  41 - (void)removeObjectForKey:(NSString *)aKey;
  42
  43 - (NSDictionary *)dictionaryRepresentation;
  44
  45 - (BOOL)synchronize;
  46
  47 @optional
  48 - (BOOL)isLocalKVS;
  49 // DEBUG
  50 - (void)setDictionaryRepresentation:(NSMutableDictionary *)initialValue;
  51 - (void)clearPersistentStores;
  52
  53 @end
  54
  55 //--- interface ---
  56
  57 @interface CKDKeyValueStore : NSObject <CKDKVSDelegate>
  58 {
  59     BOOL localKVS;
  60     BOOL persistStore;
  61     CloudItemsChangedBlock itemsChangedCallback;
  62 }
  63
  64 @property (retain) id <CKDKVSDelegate> delegate;
  65 @property (retain) NSString *identifier;
  66 @property (retain) NSString *path;
  67
  68 - (BOOL)synchronize;
  69 + (CKDKeyValueStore *)defaultStore:(NSString *)identifier itemsChangedBlock:(CloudItemsChangedBlock)itemsChangedBlock;
  70 - (id)initWithIdentifier:(NSString *)xidentifier itemsChangedBlock:(CloudItemsChangedBlock)itemsChangedBlock;
  71
  72 + (CFStringRef)remoteStoreID;
  73
  74 - (id)initWithItemsChangedBlock:(CloudItemsChangedBlock)itemsChangedBlock;
  75 - (void)cloudChanged:(NSNotification*)notification;
  76
  77 @end
  78
  79 @interface CKDKeyValueStoreCollection : NSObject
  80 {
  81     dispatch_queue_t syncrequestqueue;
  82     NSMutableDictionary *store;
  83 }
  84 @property (retain) NSMutableDictionary *collection;
  85
  86 + (id)sharedInstance;
  87 + (id <CKDKVSDelegate>)defaultStore:(NSString *)identifier itemsChangedBlock:(CloudItemsChangedBlock)itemsChangedBlock;
  88 + (void)enqueueWrite:(id)anObject forKey:(NSString *)aKey from:(NSString *)identifier;
  89 + (id)enqueueWithReply:(NSString *)aKey;
  90 + (BOOL)enqueueSyncWithReply;
  91 + (void)postItemChangedNotification:(NSString *)keyThatChanged from:(NSString *)identifier;
  92 + (void)postItemsChangedNotification:(NSArray *)keysThatChanged from:(NSString *)identifier;
  93
  94 @end