OZUserDefaultsStorageAdapter

public final actor OZUserDefaultsStorageAdapter : OZStorageAdapter

Persistent OZStorageAdapter backed by an isolated UserDefaults suite.

Stores credential and session payloads as UTF-8 JSON strings under stable keys:

cred_<credentialId> for individual stored credentials,
credential_index for the JSON-encoded list of known credential IDs,
session_current for the active session.

The adapter scopes every read and write to a UserDefaults(suiteName:) instance so multiple adapter instances configured with different suites do not interfere with one another. Stored credentials contain only public key material plus metadata, so UserDefaults provides adequate isolation for typical use cases. Applications requiring stronger at-rest protection should use OZKeychainStorageAdapter instead.

Thread safety is provided by Swift Concurrency actor isolation, which serializes all operations against the underlying UserDefaults instance.

Example:

let storage = try OZUserDefaultsStorageAdapter()
try await storage.save(credential: credential)
let loaded = try await storage.get(credentialId: credential.credentialId)

Important

Not encrypted at rest. UserDefaults persists payloads to a plaintext property-list file in the application container; on a jailbroken device or via an unencrypted iTunes/Finder backup, the contents are recoverable. The credentials persisted by this adapter contain only public-key material and non-secret metadata; applications storing session data or anything sensitive should use OZKeychainStorageAdapter instead.

Show on GitHub

defaultSuiteName
Default suite name passed to UserDefaults(suiteName:).

Consumers can override this via the initializer to scope the adapter to a different suite — useful when multiple isolated stores must coexist within the same process.
Declaration
Swift

public static let defaultSuiteName: String
Show on GitHub


                    
                    
                    init(suiteName:)

Initializes a new OZUserDefaultsStorageAdapter scoped to suiteName.

Throws

SmartAccountStorageException.WriteFailed when UserDefaults(suiteName:) returns nil. This happens when the supplied suite name is reserved (for example the empty string) or otherwise rejected by the system.

Declaration

Swift

public init(suiteName: String = OZUserDefaultsStorageAdapter.defaultSuiteName) throws

Parameters


                                suiteName

Name of the UserDefaults suite to use as the backing store. Defaults to OZUserDefaultsStorageAdapter.defaultSuiteName.

Show on GitHub


                    
                    
                    save(credential:)

Asynchronous

Declaration

Swift

public func save(credential: OZStoredCredential) async throws

Show on GitHub


                    
                    
                    get(credentialId:)

Asynchronous

Declaration

Swift

public func get(credentialId: String) async throws -> OZStoredCredential?

Show on GitHub


                    
                    
                    getByContract(contractId:)

Asynchronous

Declaration

Swift

public func getByContract(contractId: String) async throws -> [OZStoredCredential]

Show on GitHub


                    
                    
                    getAll()

Asynchronous

Declaration

Swift

public func getAll() async throws -> [OZStoredCredential]

Show on GitHub

delete(credentialId:) Asynchronous
Declaration
Swift

public func delete(credentialId: String) async throws
Show on GitHub


                    
                    
                    update(credentialId:updates:)

Asynchronous

Declaration

Swift

public func update(credentialId: String, updates: OZStoredCredentialUpdate) async throws

Show on GitHub

clear() Asynchronous
Declaration
Swift

public func clear() async throws
Show on GitHub


                    
                    
                    saveSession(_:)

Asynchronous

Declaration

Swift

public func saveSession(_ session: OZStoredSession) async throws

Show on GitHub


                    
                    
                    getSession()

Asynchronous

Declaration

Swift

public func getSession() async throws -> OZStoredSession?

Show on GitHub

clearSession() Asynchronous
Declaration
Swift

public func clearSession() async throws
Show on GitHub