keychain/ckks/CKKSOutgoingQueueEntry.h

   1 /*
   2  * Copyright (c) 2016 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 #include "keychain/securityd/SecDbItem.h"
  25 #include <utilities/SecDb.h>
  26 #import "CKKSItem.h"
  27 #import "CKKSMirrorEntry.h"
  28 #import "CKKSSQLDatabaseObject.h"
  29
  30 #ifndef CKKSOutgoingQueueEntry_h
  31 #define CKKSOutgoingQueueEntry_h
  32
  33 #if OCTAGON
  34 #import <CloudKit/CloudKit.h>
  35
  36 NS_ASSUME_NONNULL_BEGIN
  37
  38 @class CKKSKeychainView;
  39
  40 @interface CKKSOutgoingQueueEntry : CKKSSQLDatabaseObject
  41
  42 @property CKKSItem* item;
  43 @property NSString* uuid;  // property access to underlying CKKSItem
  44
  45 @property NSString* action;
  46 @property NSString* state;
  47 @property NSString* accessgroup;
  48 @property NSDate* waitUntil;  // If non-null, the time at which this entry should be processed
  49
  50 - (instancetype)initWithCKKSItem:(CKKSItem*)item
  51                           action:(NSString*)action
  52                            state:(NSString*)state
  53                        waitUntil:(NSDate* _Nullable)waitUntil
  54                      accessGroup:(NSString*)accessgroup;
  55
  56 + (instancetype)withItem:(SecDbItemRef)item
  57                   action:(NSString*)action
  58                   zoneID:(CKRecordZoneID*)zoneID
  59                    error:(NSError* __autoreleasing*)error;
  60 + (instancetype)fromDatabase:(NSString*)uuid
  61                        state:(NSString*)state
  62                       zoneID:(CKRecordZoneID*)zoneID
  63                        error:(NSError* __autoreleasing*)error;
  64 + (instancetype)tryFromDatabase:(NSString*)uuid zoneID:(CKRecordZoneID*)zoneID error:(NSError* __autoreleasing*)error;
  65 + (instancetype)tryFromDatabase:(NSString*)uuid
  66                           state:(NSString*)state
  67                          zoneID:(CKRecordZoneID*)zoneID
  68                           error:(NSError* __autoreleasing*)error;
  69
  70 + (NSArray<CKKSOutgoingQueueEntry*>*)fetch:(ssize_t)n
  71                                      state:(NSString*)state
  72                                     zoneID:(CKRecordZoneID*)zoneID
  73                                      error:(NSError* __autoreleasing*)error;
  74 + (NSArray<CKKSOutgoingQueueEntry*>*)allInState:(NSString*)state
  75                                          zoneID:(CKRecordZoneID*)zoneID
  76                                           error:(NSError* __autoreleasing*)error;
  77
  78 + (NSArray<CKKSOutgoingQueueEntry*>*)allWithUUID:(NSString*)uuid
  79                                           states:(NSArray<NSString*>*)states
  80                                           zoneID:(CKRecordZoneID*)zoneID
  81                                            error:(NSError * __autoreleasing *)error;
  82
  83 + (NSDictionary<NSString*, NSNumber*>*)countsByStateInZone:(CKRecordZoneID*)zoneID error:(NSError* __autoreleasing*)error;
  84 + (NSInteger)countByState:(CKKSItemState *)state zone:(CKRecordZoneID*)zoneID error: (NSError * __autoreleasing *) error;
  85
  86 @end
  87
  88 NS_ASSUME_NONNULL_END
  89 #endif
  90 #endif /* CKKSOutgoingQueueEntry_h */