Classes

AuthorizationHandler to perform authorization against the Predix Sync authorization service.

Given a valid authenticated user, this class interacts with the Predix Sync session service to initialize a session, and return user information.

Provides Logging support for the SDK using the Apple Unified Logging API

RefreshAuthenticationHandler subclass that handles standard predix.io UAA service refresh token authentication

AuthenticationManager manages the overall authentication, authorization, and deauthentication process.

It does this by determining what type of authentication is needed based on the current system state and the provided configuration, and then passes detailed authentication tasks to AuthenticationHandler modules. Each implementer of the AuthenticationHandler protocol should implement one type of authentication.

In this way, based on configuration, AuthenticationManager will automatically handle online and offline authentication and if so configured will utilize biometric authentication (Touch ID or Face ID) for subsequent authentications after an initial online login was performed successfully.

Example:*

// First, create and populate our configuration
var config = AuthenticationManagerConfiguration()
let url = URL(string: "https://auth.myserver.com")
config.baseURL = url
config.clientId = "my_oauth_client_id"
config.clientSecret = "my_oauth_client_secret"
config.useBiometricAuthentication = true // BiometricAuthentication for refresh and offline authentication is disabled by default.

// Next, create an AuthenticationManager object with the configuration
let manager = AuthenticationManager(configuration: config)

// Assign an OnlineAuthenticationHandler or subclass. In this case, UAABrowserAuthenticationHandler provides support for browser-based UAA login
let onlineHandler = UAABrowserAuthenticationHandler(redirectURI: "predixmobile://foobar")

// Assign a refresh handler to allow for refreshing a token without having to do a full login again
onlineHandler.refreshAuthenticationHandler = UAARefreshAuthenticationHandler()

// Set delegates as needed
onlineHandler.authenticationBrowserDelegate = self

// Assign the OnlineAuthenticationHandler to the manager
manager.onlineAuthenticationHandler = onlineHandler

// Similarly, assign an OfflineAuthenticationHandler for offline authentication support
manager.offlineAuthenticationHandler = OfflineAuthenticationHandler()

// And assign an AuthorizationHandler class for calling the authorization service after authenticating.
manager.authorizationHandler = PredixSyncAuthorizationHandler()

// Then call authenticate. The completionHandler will be called when the authentication process finishes.
manager.authenticate { (status) in
    print("Authentication Status: \(status)")
}

OnlineAuthenticationHandler subclass for handling service-call based based (non-browser) online authentication.

Handles making a request to the backend for authentication, and parsing the results.

Predix Sync on-device non-relational database storage

Represents a single row of data returned from a query

Results of a view query

Base class for all Database documents

A specialized AuthenticationHandler that works with an associated BrowserBasedAuthenticationHandler to exchange a UAA authorization code for authentication and refresh tokens.

KeychainCommand object for reading values from the keychain

KeychainCommand object for writing values to the keychain

KeychainCommand base class for reading and writing values to/from the keychain

Uses SFAuthenticationSession (available in iOS 11) to handle authentication, then uses UAACodeExchangeAuthenticationHandler to exchange the retrieved authorization code for authentication and refresh tokens.

Base class for all AuthenticationHandlers.

Provides common functions that all AuthenticationHandlers share.

Base class for all refresh authentication handlers used by an OnlineAuthenticationHandler

Processes Oauth2 refresh-based authentication, where a refresh token is exchanged for an active authentication token with an authentication provider.

Intended to allow for secure biometric or device passcode based authentication scenarios.

In the expected process, the OnlineAuthenticationHandler.authenticationResponsePayload property will contain a refresh token. This token is then used by this handler during the next authentication request to refresh the authentication without needing the users credentials.

Stores user data, populated during the authentication process.

Allows an application developer to provide mock data responses for URLSession and other types of network request classes (UIWebView for example).

The MockNetworkDataManager works with mock data providers to determine if a requested URL should return real network data or mock network data.

By default the MockNetworkDataManager uses a default data provider that works with a resource bundle and plist to determine if a requested URL should return mock data. Here is an example of how the default provider works:

In a project define a MockData.bundle resource bundle, inside that bundle it should contain all of the contents you need to mock a network response for a request. The bundle should also include a DataMapping.plist file.

Example: <?xml version=1.0 encoding=UTF-8?> <!DOCTYPE plist PUBLIC -//Apple//DTD PLIST 1.0//EN http://www.apple.com/DTDs/PropertyList-1.0.dtd> https://apple.com dataFilename mockData.json requests httpMethod GET headerFields a b response headerFields a b httpVersion 1.1 statusCode 200 httpMethod POST

Alternatively you can define a simple response structure, this will return the response for ANY requests sent for the given endpoint

<?xml version=1.0 encoding=UTF-8?> <!DOCTYPE plist PUBLIC -//Apple//DTD PLIST 1.0//EN http://www.apple.com/DTDs/PropertyList-1.0.dtd> https://simple.com dataFilename mockData.json response headerFields a b httpVersion 1.1 statusCode 200

The data is loaded from disk as raw Data using the contents of file as the data response. This means the default provider should be able to work with most file types (JSON, text, images, video, etc.)

Class used to determine device connectivity status

BrowserBasedAuthenticationHandler subclass that handles standard predix.io UAA browser-based login page authentication.

Uses the UAA authorization code grant mechanism, which then uses UAACodeExchangeAuthenticationHandler to exchange that authorization code for authentication and refresh tokens.

Retrieves PredixSyncServerInformation from a given Predix Sync server endpoint

Base class for all offline authentication handlers

Processes offline authentication.

AuthorizationHandler to extract authorization data from the UAA oAuth token

Base class for all online authentication handlers

Processes online authentication, and allows for authentication refresh capabilities.

TimeSeriesManager provides an API that allows you to retreive tags and datapoints from a Time Series instance running in PredixCluod.

The TimeSeriesManager is intended to work with the Predix Cloud Time Series service, for more information please see the Time Series service documentation.

Example usage:

   // First, create a TimeSeriesManagerConfiguration and populate the configuration with your Time Series service information.
   let config = TimeSeriesManagerConfiguration(predixZoneId: "<your ZoneID used for the Time Series Service>")

   // Next, create a TimeSeriesManager with the TimeSeriesManagerConfiguration
   let manager = TimeSeriesManager(configuration: config)

   // Then call the API. The completionHandler will be called when the process finishes.
   self.getManager().getTags(completionHandler:{(tags,  error) in
   ...
}

OnlineAuthenticationHandler subclass for handling browser-based based online authentication.

Handles displaying an authentication web page, intercepting an Oauth2 redirect, and parsing the results.

ServiceBasedAuthenticationHandler subclass that handles standard predix.io UAA service password grant authentication

Class for associating a binary payload to a Document

Object to contain the result of a keychain operation.

Object to contain the result of a keychain read operation.

Keychain access class used for storing, retrieving and deleting values from the Apple keychain.

AssetManager manages the communication with backend Predix-Asset service. This class has the knowledge of how to create new Assets and fetch existing assets from the backend Predix-Asset service based on the given query parameters. Example: // First, create an asset configuration with your Asset service instanceId let config = AssetManagerConfiguration(instanceId: my-asset-instanceId)

// Next, create an AssetManager object with the configuration
let manager = AssetManager(configuration: config)

// now you can call:
// `createAssets(jsonAssets: [[String:Any]], completionHandler: @escaping (Asset?, AssetStatus)->Void)`
// `fetchAssets(assetType: String, query: AssetQuery, completionHandler: @escaping (Asset?, AssetStatus)->Void)`