HID APPROVE SDK  5.7.1
HID APPROVE SDK for iOS
 All Classes Files Functions Variables Enumerations Enumerator Properties Pages
HIDContainer.h
Go to the documentation of this file.
1 /* ---------------------------------------------------------------------------
2  © 2017-2020 HID Global Corporation/ASSA ABLOY AB. All rights reserved.
3 
4  Redistribution and use in source and binary forms, with or without modification,
5  are permitted provided that the following conditions are met:
6  - Redistributions of source code must retain the above copyright notice,
7  this list of conditions and the following disclaimer.
8  - Redistributions in binary form must reproduce the above copyright notice,
9  this list of conditions and the following disclaimer in the documentation
10  and/or other materials provided with the distribution.
11  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
12  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
13  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
14  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
15  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
16  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
17  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
18  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
19  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
20  THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
21  --------------------------------------------------------------------------- */
22 
23 #import <Foundation/Foundation.h>
24 #import "HIDIdentifier.h"
25 #import "HIDProtectionPolicy.h"
27 #import "HIDKeySpec.h"
29 #import "HIDProgressListener.h"
30 
40 @protocol HIDContainer
41 
46 - (NSInteger)getId;
47 
52 - (NSString*)getServerURL;
53 
58 - (NSString*)getName;
59 
73 - (BOOL)setName:(NSString*)name error:(NSError**)error;
74 
79 - (NSString*)getUserId;
80 
103 - (NSArray*)findKeys:(NSArray*)filter error:(NSError**)error;
104 
118 - (BOOL)deleteKey:(HIDIdentifier*)keyId withParams:(NSArray*)parameters error:(NSError**)error;
119 
148 - (NSString*)getProperty:(NSString*)propertyId error:(NSError**)error;
149 
170 - (BOOL)setProperty:(NSString*)propertyId withValue:(NSString*)propertyValue error:(NSError**)error;
171 
184 - (id<HIDProtectionPolicy>)getProtectionPolicy:(NSError**)error;
185 
205 - (NSArray*)retrieveTransactionIds:(NSString*)sessionPassword withParams:(NSArray*)parameters error:(NSError**)error;
206 
220 - (BOOL)setConnectionConfiguration:(HIDConnectionConfiguration*)config error:(NSError**)error;
221 
237 - (BOOL)addKey:(HIDKeySpec*)keySpec withProtectionPolicyId:(HIDIdentifier*)protectionPolicyId withPassword:(NSString*)password error:(NSError**)error;
238 
243 - (BOOL)isFIPSModeEnabled;
244 
245 
257 -(NSDate*)getCreationDate:(NSError**)error;
258 
270 -(NSDate*)getExpiryDate:(NSError**)error;
271 
283 -(NSDate*)getRenewalDate:(NSError**)error;
284 
297 -(Boolean)isRenewable:(NSString*)sessionPassword error:(NSError**)error;;
298 
321 - (Boolean)renew:(HIDContainerRenewal*)config withSessionPassword:(NSString*) sessionPassword withListener:(NSObject<HIDProgressListener>*)listener error:(NSError**)error;
322 
353 - (BOOL)updateDeviceInfo:(NSString*)propertyId withValue:(NSString*)propertyValue withPassword:(NSString*)sessionPassword withParams:(NSArray*)parameters error:(NSError**)error;
354 
355 @end
NSInteger getId()
Get the identifier of that container.
NSString * getServerURL()
Gets the server URL associated with that container.
The protection policy defines the security parameters associated with a key or data item...
Definition: HIDProtectionPolicy.h:129
Listener delegate to report status information or receive password request events.
NSString * getUserId()
Gets the identifier of the user for this container.
This interface provides an integration point for receiving status information sent from the server du...
Definition: HIDProgressListener.h:124
Service container instance.
Definition: HIDContainer.h:40
Security policy for the protection of sensitive data.
Key Spec object for use with addKey:withProtectionPolicyId:withPassword:error: (HIDContainer-p) ...
Definition: HIDKeySpec.h:34
Container initialization configuration.
object identifier.
Definition: HIDIdentifier.h:34
Key Spec instance.
Configuration for renew of a Container.
Definition: HIDContainerInitialization.h:90
Connection configuration.
Configuration of server connections.
Definition: HIDConnectionConfiguration.h:42
BOOL isFIPSModeEnabled()
Checks if FIPS 140-2 mode is required.
Object reference.
NSString * getName()
Gets the Friendly Name associated with that container.