SecureLogConfigComponents Class Reference

#include <SecureLogConfig.h>

Inheritance diagram for SecureLogConfigComponents:

Properties
NSString *	fileID
	Optional parameter This file Id is part of the log file name. Default value: d5a1 Maximum length is 10 characters.
NSData *	publicKeyModulus
	Mandatory parameter Is required to retrieve public key and encrypt the log message (Max Length is 1024 characters)
NSData *	publicKeyExponent
	Mandatory parameter Is required to retrieve public key and encrypt the log message (Max Length is 8 characters)
NSUInteger	rollingFileMaxCount
	Optional parameter To set a Secure logger rolling file max count Default value: 8.
NSUInteger	rollingSizeInKB
	Optional parameter To set a Secure logger rolling size Default value: 1024.
NSURL *	directory
	Optional parameter The directory to store the logs Default value: Library/Application Support/Thales.
SecureLogLevel	logLevel
	Optional parameter The level of log which you want the secure log to write to the file Default value: SecureLogLevelWarn.

Detailed Description

The class contains all parameters which is required to initialise SecureLog. Set all parameters value to this object and pass to SecureLogConfig initialise function

Property Documentation

directory

- (NSURL*) directory

readwritenonatomicstrong

Optional parameter The directory to store the logs Default value: Library/Application Support/Thales.

Exceptions

NSInvalidArgumentException

if the directory is not existed

fileID

- (NSString*) fileID

readwritenonatomicstrong

Optional parameter This file Id is part of the log file name. Default value: d5a1 Maximum length is 10 characters.

Exceptions

NSInvalidArgumentException

if the length is more than 10 characters

logLevel

- (SecureLogLevel) logLevel

readwritenonatomicassign

Optional parameter The level of log which you want the secure log to write to the file Default value: SecureLogLevelWarn.

Exceptions

NSInvalidArgumentException

if the level is not from SecureLogLevel

publicKeyExponent

- (NSData*) publicKeyExponent

readwritenonatomicstrong

Mandatory parameter Is required to retrieve public key and encrypt the log message (Max Length is 8 characters)

Exceptions

NSInvalidArgumentException

if publicKeyExponent is nil or the length is more than 8 characters

publicKeyModulus

- (NSData*) publicKeyModulus

readwritenonatomicstrong

Mandatory parameter Is required to retrieve public key and encrypt the log message (Max Length is 1024 characters)

Exceptions

NSInvalidArgumentException

if publicKeyModulus is nil or the length is more than 1024 characters

rollingFileMaxCount

- (NSUInteger) rollingFileMaxCount

readwritenonatomicassign

Optional parameter To set a Secure logger rolling file max count Default value: 8.

Exceptions

NSInvalidArgumentException

if rollingFileMaxCount is equals to 0 or more than 99.

rollingSizeInKB

- (NSUInteger) rollingSizeInKB

readwritenonatomicassign

Optional parameter To set a Secure logger rolling size Default value: 1024.

Exceptions

NSInvalidArgumentException

if rollingSizeInKB = 0