OOEmbeddedSecureURLGenerator Class Reference

Default implementation of OOSecureURLGenerator which will generate secured Ooyala API URLs using API key and secret. More...

#import "OOEmbeddedSecureURLGenerator.h"

+ Inheritance diagram for OOEmbeddedSecureURLGenerator:

Instance Methods

(id) - initWithAPIKey:secret:
 Initialize an OOEmbeddedSecureURLGenerator. More...
 
(id) - initWithAPIKey:signatureGenerator:
 Initialize an OOEmbeddedSecureURLGenerator with custom OOSignatureGenerator implementation. More...
 
(NSURL *) - secureURL:uri:params:
 Generate the secure URL using the APIKey+Expires+Signature method (signature is generated using the OOSignatureGenerator) More...
 

Detailed Description

Default implementation of OOSecureURLGenerator which will generate secured Ooyala API URLs using API key and secret.

OOEmbeddedSecureURLGenerator.

Note that embedding your API key and secret into the app is not very secure. To minimize the risk, use read-only API keys if possible. Alternatively, implement your own OOSignatureGenerator and keep the API keys and secrets on server-side.

OOEmbeddedSecureURLGenerator.h in OoyalaSDK

Method Documentation

- (id) initWithAPIKey: (NSString *)  theAPIKey
secret: (NSString *)  theSecret 

Initialize an OOEmbeddedSecureURLGenerator.

Parameters
[in]theAPIKeythe API Key to use (from Backlot)
[in]theSecretthe Secret to use (from Backlot)
Returns
the initialized OOEmbeddedSecureURLGenerator
- (id) initWithAPIKey: (NSString *)  theAPIKey
signatureGenerator: (id< OOSignatureGenerator >)  theSignatureGenerator 

Initialize an OOEmbeddedSecureURLGenerator with custom OOSignatureGenerator implementation.

Parameters
[in]theAPIKeythe API Key to use (from Backlot)
[in]theSignatureGeneratorOOSignatureGenerator to use
Returns
the initialized OOEmbeddedSecureURLGenerator
- (NSURL *) secureURL: (NSString *)  host
uri: (NSString *)  uri
params: (NSDictionary *)  params 

Generate the secure URL using the APIKey+Expires+Signature method (signature is generated using the OOSignatureGenerator)

Parameters
[in]hostthe hostname for the URL
[in]urithe URI for the URL
[in]paramsthe URI params for the URL (not including any security params that the security method would use)
Returns
a secure NSURL created from the parameters

The documentation for this class was generated from the following file: