conn

Public Member Type Definitions
typedef	RExternalisableArray< TEntry > RFileArray
typedef	RExternalisableArray< TRestoreFileFilter > RRestoreFileFilterArray
typedef	RExternalisableArray< TSecureId > RSIDArray
typedef	RExternalisableArray< TDataOwnerAndStatus > RSIDStatusArray
typedef	RPointerArray< CSelection > RSelections
typedef	RPointerArray< CSnapshot > RSnapshots
typedef	TUint32 TActiveBURSettings
typedef	TUint32 TCommonBURSettings
typedef	TBufC< KMaxPackageNameLength > TPackageName
typedef	TUint32 TPassiveBURSettings

Public Attributes
const TInt	KABASyncMessageSlots
const TUint	KABBuildVersionNumber
const TTimeIntervalMicroSeconds32	KABCallbackDefaultTimeout
const TTimeIntervalMicroSeconds32	KABCallbackWatchdogTimeout
const TUint	KABMajorVersionNumber
const TInt	KABMaxSendDataBlock
const TUint	KABMinorVersionNumber
const TInt	KABRetryCount
const TUint	KBURPartTypeMask
const TUint	KBackupIncTypeMask
const TInt	KCharWidthInBytes
const TInt	KCompressionBlockSize
const TInt	KDataOffset
const TInt	KDefaultDelay
const TInt	KDesCArrayGranularity
const TInt	KDescriptorOffset
const TInt	KEncryptionBufferSize
const TInt	KHeaderOffset
const TInt	KIPCMessageSize
const TInt	KJavaIdLength
const TInt	KJavaVirtualMachineSecureId
const TInt	KKeySize
const TUint	KMaxDerivedTypes
const TInt	KMaxGenericTypeSize
const TInt	KMaxHeapSize
const TInt	KMaxPackageNameLength
const TInt	KMinHeapSize
const TUint32	KNullABSid
const TInt	KSBBufferBlockSize
const TInt	KSBEASyncMessageSlots
const TUint	KSBEBuildVersionNumber
const TInt	KSBEGSHDefaultSize
const TInt	KSBEGSHMaxRetries
const TInt	KSBEGSHReductionFactor
const TUint	KSBEMajorVersionNumber
const TInt	KSBEMaxHexStringLength
const TUint	KSBEMinorVersionNumber
const TInt	KSBERetryCount
const TUid	KSBServerUID3
const TInt	KSID
const TInt	KSIDLength
const TUint	KShutdownDelay
const TUint	KUidBackupRestoreKey
const CPolicyServer::TPolicyElement	myABElements
const TUint8	myABElementsIndex
const CPolicyServer::TPolicy	myABPolicy
const TUint	myABRangeCount
const TInt	myABRanges
const CPolicyServer::TPolicyElement	mySBEElements
const TUint8	mySBEElementsIndex
const CPolicyServer::TPolicy	mySBEPolicy
const TUint	mySBERangeCount
const TInt	mySBERanges

Public Member Enumerations
enum	TABCallbackCommands { EABCallbackAllSnapshotsSupplied, EABCallbackReceiveSnapshotData, EABCallbackGetExpectedDataSize, EABCallbackGetSnapshotData, ..., EABCallbackGetDataChecksum }
enum	TABMessages { EABMsgBURModeInfo, EABMsgDoesPartialAffectMe, EABMsgConfirmReadyForBUR, EABMsgPrimeForCallback, ..., EABMsgGetDriveNumForSuppliedSnapshot }
enum	TActiveBUROptions { ENoActiveOptions, EDelayToPrepareData, EActiveSupportsInc }
enum	TActiveType { EActiveOnly, EActiveAndProxyImpl, EProxyImpOnly }
enum	TBURPartType { EBURUnset, EBURNormal, EBURBackupFull, EBURBackupPartial, ..., EBURRestorePartial }
enum	TBackupDataType { EActive, EPassive }
enum	TBackupIncType { ENoBackup, EBackupBase, EBackupIncrement }
enum	TCommonBUROptions { ENoOptions, EActiveBUR, EPassiveBUR, EHasSystemFiles, ..., ERequiresReboot }
enum	TDataOwnerStatus { EUnset, EDataOwnerNotFound, EDataOwnerReady, EDataOwnerNotReady, ..., EDataOwnerReadyNoImpl }
enum	TJavaTransferType { EJavaMIDlet, EJavaMIDletData }
enum	TPackageDataType { ESystemData, ESystemSnapshotData }
enum	TPassiveBUROptions { ENoPassiveOptions, EHasPublicFiles, EDeleteBeforeRestore, EPassiveSupportsInc }
enum	TSBDerivedType { ESIDDerivedType, EPackageDerivedType, ESIDTransferDerivedType, EPackageTransferDerivedType, ..., EJavaTransferDerivedType }
enum	TSBEMessages { ESBEMsgGetGSHHandle, ESBEMsgPrepDataOwnerInfo, ESBEMsgGetDataOwnerInfo, ESBEMsgPrepPublicFiles, ..., ESBEMsgGetLargePublicFiles }
enum	TSelectionType { EInclude, EExclude }
enum	TState { ENone, ERequest, ESupply, EBuffer }
enum	TTransferDataType { ERegistrationData, EPassiveSnapshotData, EPassiveBaseData, EPassiveIncrementalData, ..., EPublicFileListing }
enum	TTransferDirection { EServerToDataOwner, EDataOwnerToServer }

Public Member Functions
void	CleanupRPointerArray(TAny *)
void	CleanupResetAndDestroyL(T &)
void	CleanupResetAndDestroyPushL(T &)
void	PackType(T &, TDesC8 &, TInt)
void	PackTypeAdvance(T &, TDesC8 &, TInt &)
TBool	ReadFromBufferF(T &, TUint8 &, const TUint8 )
template TBool	ReadFromBufferF< TFileFixedHeader >(TFileFixedHeader &, TUint8 &, const TUint8 )
template TBool	ReadFromBufferF< TSnapshot >(TSnapshot &, TUint8 &, const TUint8 )
TBool	ReadFromBufferV(TPtr8 &, TInt, TUint8 &, const TUint8 )
void	ReadL(T &, TPtr8 &)
void	ReadL(T &, TPtr8 &, TInt, TInt)
void	UnpackType(T &, TDesC8 &, TInt)
void	UnpackTypeAdvance(T &, TDesC8 &, TInt &)
void	UnpackTypeAdvance(TDriveList &, TDesC8 &, TInt &)
void	WriteL(T &, TPtr8 &)
void	WriteL(T &, TPtr8 &, TInt, TInt)
TBool	WriteToBufferF(T &, TPtr8 &)
TBool	WriteToBufferV(const TPtr8 &, TInt, TPtr8 &)
	_LIT(KABServerName, "!ABServer")
	_LIT(KBackSlash, "\\")
	_LIT(KBackupRegistrationFile, "backup_registration*.xml")
	_LIT(KCentRepProcessName, "centralrepositorysrv.exe")
	_LIT(KColon, ":")
	_LIT(KConfigFile, "sbeconfig.xml")
	_LIT(KDrive, "?:")
	_LIT(KDriveAndSlash, "?:\\")
	_LIT(KExclamationAsDrive, "!")
	_LIT(KImport, "\\import\\")
	_LIT(KImportDir, "\\private\\10202D56\\import\\packages\\")
	_LIT(KMIDletTempRestorePath, "C:\\system\\temp\\MIDletRestore\\")
	_LIT(KOther, "\\..\\")
	_LIT(KPad, "00000000")
	_LIT(KPrimaryBackupRegistrationFile, "backup_registration.xml")
	_LIT(KPrivate, "\\private\\")
	_LIT(KPrivateMatch, "?:\\private\\*")
	_LIT(KPrivateNoBackup, "?:\\private\\????????\\NoBackup\\*")
	_LIT(KPrivateSidMatch, "?:\\private\\")
	_LIT(KQuestionMark, "?")
	_LIT(KResource, "?:\\resource\\*")
	_LIT(KSBEServerName, "!SBEServer")
	_LIT(KSBImageName, "sbengine")
	_LIT(KStar, "*")
	_LIT(KSys, "?:\\sys\\*")
	_LIT(KSystem, "?:\\system\\*")
	_LIT(KTempPath, ":\\system\\temp\\")
	_LIT8(KActiveAndProxy, "activeandproxy")
	_LIT8(KActiveBackup, "active_backup")
	_LIT8(KActiveOnly, "activeonly")
	_LIT8(KActiveType, "active_type")
	_LIT8(KAppCloseDelay, "app_close_delay")
	_LIT8(KBackupRegistration, "backup_registration")
	_LIT8(KBaseBackupOnly, "base_backup_only")
	_LIT8(KCallbackDelayTime, "callback_delay_time")
	_LIT8(KCenrepBackup, "cenrep_backup")
	_LIT8(KCentRep, "central_repository")
	_LIT8(KConfig, "sbe_config")
	_LIT8(KDBMSBackup, "dbms_backup")
	_LIT8(KDatabase, "database")
	_LIT8(KDelay, "delay")
	_LIT8(KDeleteBeforeRestore, "delete_before_restore")
	_LIT8(KDrives, "exclude_drives")
	_LIT8(KExclude, "exclude")
	_LIT8(KHeap, "heap")
	_LIT8(KHexLeader, "0x")
	_LIT8(KIncludeDirectory, "include_directory")
	_LIT8(KIncludeFile, "include_file")
	_LIT8(KJavaXMLElementIncludeDirectory, "java_include_directory")
	_LIT8(KJavaXMLElementJavaBackupMIDlet, "java_backup_midlet")
	_LIT8(KJavaXMLElementMIDletSuite, "midlet_suite")
	_LIT8(KList, "list")
	_LIT8(KMaxRetries, "max_retries")
	_LIT8(KMimeType, "text/xml")
	_LIT8(KPassiveBackup, "passive_backup")
	_LIT8(KPolicy, "policy")
	_LIT8(KProcessName, "process_name")
	_LIT8(KProxyDataManager, "proxy_data_manager")
	_LIT8(KProxyOnly, "proxyonly")
	_LIT8(KProxySID, "SID")
	_LIT8(KPublicBackup, "public_backup")
	_LIT8(KRedFact, "reduction_factor")
	_LIT8(KRequiresDelay, "requires_delay_to_prepare_data")
	_LIT8(KRequiresReboot, "requires_reboot")
	_LIT8(KRestore, "restore")
	_LIT8(KSize, "size")
	_LIT8(KSupportsInc, "supports_incremental")
	_LIT8(KSupportsSelective, "supports_selective")
	_LIT8(KSystemBackup, "system_backup")
	_LIT8(KUid, "uid")
	_LIT8(KVersion, "1.0")
	_LIT8(KYes, "yes")
	_LIT_SECURE_ID(KCentRepSID, 0x10202BE9)
	_LIT_SECURE_ID(KDummyId, 0x00000000)
	_LIT_SECURITY_POLICY_PASS(KReadPolicy)
	_LIT_SECURITY_POLICY_S0(KWritePolicy, KSID)

Typedef TPackageName

typedef TBufC< KMaxPackageNameLength >

TPackageName

Typedef TPassiveBURSettings

typedef TUint32

TPassiveBURSettings

Passive BUR Settings This structure will store the passive backup and restore options for a SID

Member Attribute Documentation

KABASyncMessageSlots

const TInt

KABASyncMessageSlots

Number of async message slots.

KABBuildVersionNumber

const TUint

KABBuildVersionNumber

The AB build number

KABCallbackDefaultTimeout

const TTimeIntervalMicroSeconds32

KABCallbackDefaultTimeout

KABCallbackWatchdogTimeout

const TTimeIntervalMicroSeconds32

KABCallbackWatchdogTimeout

Constant definition for the watchdog timer

KABMajorVersionNumber

const TUint

KABMajorVersionNumber

The AB major version number.

KABMaxSendDataBlock

const TInt

KABMaxSendDataBlock

Size of data blocks to send back to the PC from the ABClient

KABMinorVersionNumber

const TUint

KABMinorVersionNumber

The AB minor version number.

KABRetryCount

const TInt

KABRetryCount

Number of times to attempt connection to server.

KBURPartTypeMask

const TUint

KBURPartTypeMask

TBURPartType Bitmask

KBackupIncTypeMask

const TUint

KBackupIncTypeMask

TBackupIncType Bitmask

KCharWidthInBytes

const TInt

KCharWidthInBytes

Used for unpacking unicode descriptors

KCompressionBlockSize

const TInt

KCompressionBlockSize

Compression block size

KDataOffset

const TInt

KDataOffset

Offset to the data that the TPtr8 will point to

KDefaultDelay

const TInt

KDefaultDelay

KDesCArrayGranularity

const TInt

KDesCArrayGranularity

KDescriptorOffset

const TInt

KDescriptorOffset

Offset to the beginning of the main descriptor

KEncryptionBufferSize

const TInt

KEncryptionBufferSize

Constants used in the class below

KHeaderOffset

const TInt

KHeaderOffset

Offset for the lock flag

KIPCMessageSize

const TInt

KIPCMessageSize

The maximum size of descriptor data passed with each IPC call

KJavaIdLength

const TInt

KJavaIdLength

Length of the 128 bit Java hash in bytes

KJavaVirtualMachineSecureId

const TInt

KJavaVirtualMachineSecureId

KKeySize

const TInt

KKeySize

Constants used in the class below

KMaxDerivedTypes

const TUint

KMaxDerivedTypes

Maximum number of derived types specified in TSBDerivedType

KMaxGenericTypeSize

const TInt

KMaxGenericTypeSize

KMaxGenericTypeSize must be a multiple of 4 to ensure that all structures are 4-byte aligned

KMaxHeapSize

const TInt

KMaxHeapSize

KMaxPackageNameLength

const TInt

KMaxPackageNameLength

Maximum length of package name

KMinHeapSize

const TInt

KMinHeapSize

KNullABSid

const TUint32

KNullABSid

Constant for defining an unset Secure ID

KSBBufferBlockSize

const TInt

KSBBufferBlockSize

This block size for the internal buffer

KSBEASyncMessageSlots

const TInt

KSBEASyncMessageSlots

Number of async message slots.

KSBEBuildVersionNumber

const TUint

KSBEBuildVersionNumber

The SBE build number

KSBEGSHDefaultSize

const TInt

KSBEGSHDefaultSize

KSBEGSHMaxRetries

const TInt

KSBEGSHMaxRetries

KSBEGSHReductionFactor

const TInt

KSBEGSHReductionFactor

KSBEMajorVersionNumber

const TUint

KSBEMajorVersionNumber

The SBE major version number.

KSBEMaxHexStringLength

const TInt

KSBEMaxHexStringLength

KSBEMinorVersionNumber

const TUint

KSBEMinorVersionNumber

The SBE minor version number.

KSBERetryCount

const TInt

KSBERetryCount

Number of times to attempt connection to server.

KSBServerUID3

const TUid

KSBServerUID3

The SB Server 3rd UID - Assigned from database.

KSID

const TInt

KSID

KSIDLength

const TInt

KSIDLength

KShutdownDelay

const TUint

KShutdownDelay

Shutdown delay, in microseconds.

KUidBackupRestoreKey

const TUint

KUidBackupRestoreKey

Secure Backup and Restore publish and subscribe key

Secure Backup and Restore uses a Publish and Subscribe key to publish the current backup / restore state.

The key is a system key so the category to be used when subscribing is KUidSystemCategoryValue The key to be used is KUidBackupRestoreKey. The value is a bit-wise OR of a TBURPartType value and a TBackupIncType value This means that a normal state (i.e. non-backup or restore) is EBURNormal | ENoBackup but If the key has not been set (i.e. == 0) then no backup or restore is in progress either

myABElements

const CPolicyServer::TPolicyElement

myABElements

myABElementsIndex

const TUint8

myABElementsIndex

Active Backup security action array

An array with a one-to-one mapping with the range array specifiying what security action to take for each server request.

myABPolicy

const CPolicyServer::TPolicy

myABPolicy

myABRangeCount

const TUint

myABRangeCount

Active Backup range count

The number of different security ranges for active backup request numbers

myABRanges

const TInt

myABRanges

Active Backup security request ranges

This is a breakdown of the active backup requests into ranges for security checking purposes.

mySBEElements

const CPolicyServer::TPolicyElement

mySBEElements

mySBEElementsIndex

const TUint8

mySBEElementsIndex

Secure Backup Engine security action array

An array with a one-to-one mapping with the range array specifiying what security action to take for each server request.

mySBEPolicy

const CPolicyServer::TPolicy

mySBEPolicy

mySBERangeCount

const TUint

mySBERangeCount

Secure Backup Engine range count

The number of different security ranges for SBEs request numbers

mySBERanges

const TInt

mySBERanges

Secure Backup Engine security request ranges

This is a breakdown of the SBE requests into ranges for security checking purposes.

Member Enumeration Documentation

Enum TABCallbackCommands

List of commands that the server requests the client to call on it's callback interface

Enumerator	Value	Description
EABCallbackAllSnapshotsSupplied
EABCallbackReceiveSnapshotData
EABCallbackGetExpectedDataSize
EABCallbackGetSnapshotData
EABCallbackInitialiseGetBackupData
EABCallbackGetBackupDataSection
EABCallbackInitialiseRestoreBaseDataSection
EABCallbackRestoreBaseDataSection
EABCallbackInitialiseRestoreIncrementData
EABCallbackRestoreIncrementDataSection
EABCallbackRestoreComplete
EABCallbackInitialiseGetProxyBackupData
EABCallbackInitialiseRestoreProxyBaseData
EABCallbackTerminateMultiStageOperation
EABCallbackGetDataChecksum

Enum TABMessages

AB Client/Server Messages

Enumerator	Value	Description
EABMsgBURModeInfo		Get info about the backup/restore mode
EABMsgDoesPartialAffectMe		Query whether or not this client is being operated on
EABMsgConfirmReadyForBUR		Confirm to the SBEngine that all data has now been prepared
EABMsgPrimeForCallback		This is the first msg that primes server for callbacks
EABMsgPrimeForCallbackAndResponse		Re-prime the server, sending a response from the last call
EABMsgPrimeForCallbackAndResponseDes		As for PrimeForCallbackAndResponse but for sending a descriptor
EABMsgPropagateLeave		Propagate a leave from the callback, back to the engine
EABMsgGetDataSync		Synchronous call to get data from the server
EABMsgSendDataLength		Synchronous call to send the length of data to the server
EABMsgClosingDownCallback		Inform the server that we're closing down the callback interface
EABMsgGetDriveNumForSuppliedSnapshot		Called from within the ReceiveSnapshot callback to return the drive num

Enum TActiveBUROptions

The active backup options

Enumerator	Value	Description
ENoActiveOptions	0x00000000	0x00000000: no active backup options selected
EDelayToPrepareData	0x00000001	0x00000001: data owner slow to prepare active data
EActiveSupportsInc	0x00000002	0x00000002: data owner supports incremental BUR ?

Enum TActiveType

enum representing TActiveType

Enumerator	Value	Description
EActiveOnly	0
EActiveAndProxyImpl	1
EProxyImpOnly	2

Enum TBURPartType

The backup / restore state of a device.

Enumerator	Value	Description
EBURUnset	0x00000000	0x00000000: The backup / restore mode has not been set
EBURNormal	0x00000001	0x00000001: The device as a whole is not engaged in a backup or restore
EBURBackupFull	0x00000002	0x00000002: The device as a whole is engaged in a backup of all components data
EBURBackupPartial	0x00000004	0x00000004: The device as a whole is engaged in a backup of selected components data
EBURRestoreFull	0x00000008	0x00000008: The device as a whole is engaged in a restore of all components data
EBURRestorePartial	0x00000010	0x00000010: The device as a whole is engaged in a restore of all components data

Enum TBackupDataType

TBackupDataType indicates whether a specific data stream or operation relates to active or passive backup or restore. A specific data owner can use both active and passive and so we need to differentiate between operations.

Enumerator	Value	Description
EActive	0	0x00000000: The backup or restore operation is active rather than passive
EPassive	1	0x00000001: The backup or restore operation is passive rather than active

Enum TBackupIncType

The type of a backup.

Enumerator	Value	Description
ENoBackup	0x00000000	0x00000000: No backup is in progress
EBackupBase	0x00000100	0x00000100: The backup is a base backup, i.e. it includes all files / data
EBackupIncrement	0x00000200	0x00000200: The backup is an incremental backup, i.e. it includes only files / data that have changed since a previous backup

Enum TCommonBUROptions

The passive backup options

Enumerator	Value	Description
ENoOptions	0x00000000	0x00000000: no common options selected
EActiveBUR	0x00000001	0x00000001: Does the data owner do active backup / restore?
EPassiveBUR	0x00000002	0x00000002: Does the data owner do passive backup / restore?
EHasSystemFiles	0x00000004	0x00000004: Does the data owner want system files backed up?
ESupportsSelective	0x00000008	0x00000008: Can the data owner do BUR selectively?
ERequiresReboot	0x00000010	0x00000010: Does the data owner require reboot after restore?

Enum TDataOwnerStatus

TDataOwnerStatus encapsulates the status of a data owner.

Enumerator	Value	Description
EUnset	0	0x00000000: Unset - allows creation of object without incorrect status
EDataOwnerNotFound	1	0x00000001: Data owner not found in registration files
EDataOwnerReady	2	0x00000002: Data owner ready for backup / restore
EDataOwnerNotReady	3	0x00000003: Data owner not yet ready for backup / restore
EDataOwnerFailed	4	0x00000004: Data owner failed to become ready
EDataOwnerNotConnected	5	0x00000005: Data owner alive, but not fully ready
EDataOwnerReadyNoImpl	6	0x00000006: Data owner ready for backup / restore but does not provide callback implementation

Enum TJavaTransferType

This enum defines the type of Java data that is being transferred and can indicate either a MIDlet suite archive (Jad/Jar etc.) or data for an installed MIDlet suite

Enumerator	Value	Description
EJavaMIDlet	0
EJavaMIDletData	1

Enum TPackageDataType

TPackageDataType indicates the type of package data being transferred from the Secure Backup Engine to the Secure Backup Server or vice versa.

Deprecated

Enumerator	Value	Description
ESystemData	0	0x00000000: The data is system files (typically executables or resource files)
ESystemSnapshotData	1	0x00000001: The data is a snapshot for system files

Enum TPassiveBUROptions

The passive backup options

Enumerator	Value	Description
ENoPassiveOptions	0x00000000	0x00000000: no passive options selected
EHasPublicFiles	0x00000001	0x00000001: data owner has public files to BUR ?
EDeleteBeforeRestore	0x00000002	0x00000002: data owner requires a delete before restore ?
EPassiveSupportsInc	0x00000004	0x00000004: data owner supports incremental BUR ?

Enum TSBDerivedType

Used to identify the derived type that the base generic type represents

Deprecated

Enumerator	Value	Description
ESIDDerivedType	0	0x00000000: SID derived type
EPackageDerivedType	1	0x00000001: Package derived type
ESIDTransferDerivedType	2	0x00000002: SID data transfer derived type
EPackageTransferDerivedType	3	0x00000003: Package data transfer derived type
EJavaDerivedType	4	0x00000004: Java ID derived type
EJavaTransferDerivedType	5	0x00000005: Java ID derived type

Enum TSBEMessages

SBE Client/Server Messages

Enumerator	Value	Description
ESBEMsgGetGSHHandle		Pass the the Global Anonymous Shared Heap handle to client
ESBEMsgPrepDataOwnerInfo		Prepare the data owner information for a specific SID
ESBEMsgGetDataOwnerInfo		Transfer the data owner information for a specific SID
ESBEMsgPrepPublicFiles		Prepare the data owner information for a specific SID
ESBEMsgGetPublicFiles		Transfer the data owner information for a specific SID
ESBEMsgPrepPublicFilesRaw		Prepare the data owner information for a specific SID
ESBEMsgGetPublicFilesRaw		Transfer the data owner information for a specific SID
ESBEMsgPrepPublicFilesXML		Prepare the data owner information for a specific SID
ESBEMsgGetPublicFilesXML		Transfer the data owner information for a specific SID
ESBEMsgSetBURMode		Set the Backup and Restore mode and associatedial BUR
ESBEMsgPrepSIDStatus		Get the returned descriptor length from a SIDS params
ESBEMsgSetSIDListPartial		Set the list of data owners affected in a parttatus array
ESBEMsgGetSIDStatus		Transfer the array of SID's and statuses
ESBEMsgRequestDataSync		Request that the SBE transfers some data to the client
ESBEMsgSupplyDataSync		Instruct the SBE that data has been supplied ine client
ESBEMsgRequestDataAsync		Request that the SBE transfers some data to th the GSH
ESBEMsgSupplyDataAsync		Instruct the SBE that data has been supplied in the GSH
ESBEMsgAllSnapshotsSupplied		Request that supplied SID's are subject to a Base backup
ESBEMsgGetExpectedDataSize		Ask the SBE for the expected size of backup data
ESBEMsgAllSystemFilesRestored		Instruct the SBE that all system files have now been restored
ESBEMsgGetDataChecksum		For testing - Request the checksum of a SID's backup data
ESBEMsgPrepLargePublicFiles		Instruct the SBE to build the public file list and place in GSH
ESBEMsgGetLargePublicFiles		Retrieve parameters such as the finished flag from SBE

Enum TSelectionType

Enumeration to specify if a selection should be included or excluded

Enumerator	Value	Description
EInclude
EExclude		Is excluded

Enum TState

The current request state

Enumerator	Value	Description
ENone
ERequest
ESupply
EBuffer

Enum TTransferDataType

TTransferDataType indicates the type of data being transferred from the Secure Backup Engine to the Secure Backup Server or vice versa.

Enumerator	Value	Description
ERegistrationData	0	0x00000000: deprecated
EPassiveSnapshotData	1	0x00000001: The data is a snapshot for passive backup that includes file details
EPassiveBaseData	2	0x00000002: The data is passively backup up private data with no previous history
EPassiveIncrementalData	3	0x00000003: The data is passively backed up private data as an increment on a previous base backup
EActiveSnapshotData	4	0x00000004: The data is a snapshot for active backup that includes file details
EActiveBaseData	5	0x00000005: The data is actively backup up private data with no previous history
EActiveIncrementalData	6	0x00000006: The data is actively backed up private data as an increment on a previous base backup
ECentralRepositoryData	7	0x00000007: deprecated
EPublicFileListing	8	0x00000008: An externalised list of public file entries belonging to a single data owner

Enum TTransferDirection

TTransferDirection indicates whether a (just completed) data transfer is from the Secure Backup Server to a data owner or vice versa.

Enumerator	Value	Description
EServerToDataOwner	0	0x00000000: The transfer is from the Secure Backup Server to a data owner
EDataOwnerToServer	1	0x00000001: The transfer is from a data owner to the Secure Backup Server

Member Function Documentation

CleanupRPointerArray ( TAny * )

void

CleanupRPointerArray

(

TAny *

aPtr

)

CleanupResetAndDestroyL ( T & )

void

CleanupResetAndDestroyL

(

T &

aRef

)

[inline]

CleanupResetAndDestroyPushL ( T & )

void

CleanupResetAndDestroyPushL

(

T &

aRef

)

[inline]

PackType ( T &, TDesC8 &, TInt )

void	PackType	(	T &	aType,
			TDesC8 &	aDes,
			TInt	aOffset
		)	[inline]

Templated function to copy a simple type into a specified position in aDes defined by aOffset. aOffset is not advanced as a result of this operation

Parameter	Description
aType	This object is overwritten with the flattened type in aDes
aDes	The buffer that contains the type T pointed to by aPtr
aOffset	The running index of where the following type begins. Updated by ExtractPointer

Returns: The new offset after packing the data type

PackTypeAdvance ( T &, TDesC8 &, TInt & )

void	PackTypeAdvance	(	T &	aType,
			TDesC8 &	aDes,
			TInt &	aOffset
		)	[inline]

Templated function to copy a simple type into a specified position in aDes defined by aOffset. aOffset is updated to reflect the advance along aDes

Parameter	Description
aType	This object is overwritten with the flattened type in aDes
aDes	The buffer that contains the type T pointed to by aPtr
aOffset	The running index of where the following type begins. Updated by ExtractPointer

Returns: The new offset after packing the data type

ReadFromBufferF ( T &, TUint8 &, const TUint8 )

TBool	ReadFromBufferF	(	T &	aT,
			TUint8 *&	appCurrent,
			const TUint8 *	apEnd
		)

Template class to read flat structures from the buffer

Parameter	Description
aT	on return the flat structure.
appCurrent	The current point into the buffer.
apEnd	The end of the buffer.

Returns: ETrue if read succesfully. EFalse if a retry is needed.

ReadFromBufferF< TFileFixedHeader > ( TFileFixedHeader &, TUint8 &, const TUint8 )

template TBool	ReadFromBufferF< TFileFixedHeader >	(	TFileFixedHeader &	,
			TUint8 *&	,
			const TUint8 *
		)

ReadFromBufferF< TSnapshot > ( TSnapshot &, TUint8 &, const TUint8 )

template TBool	ReadFromBufferF< TSnapshot >	(	TSnapshot &	,
			TUint8 *&	,
			const TUint8 *
		)

ReadFromBufferV ( TPtr8 &, TInt, TUint8 &, const TUint8 )

TBool	ReadFromBufferV	(	TPtr8 &	aT,
			TInt	aSize,
			TUint8 *&	appCurrent,
			const TUint8 *	apEnd
		)

Reads from the buffer.

Parameter	Description
aT	on return the data read.
aSize	size of the data to read.
appCurrent	Pointer to read from.
apEnd	the end of the data.

Returns: ETrue on success. EFalse on failure.

ReadL ( T &, TPtr8 & )

void	ReadL	(	T &	aT,
			TPtr8 &	aBuffer
		)

ReadL ( T &, TPtr8 &, TInt, TInt )

void	ReadL	(	T &	aT,
			TPtr8 &	aBuffer,
			TInt	aStartAt = 0,
			TInt	aToCopy = sizeof(T)
		)

Reads data from any given type into aBuffer

Parameter	Description
aT	type to put in buffer
aBuffer	the buffer
aStartAt	offset of the data
aToCopy	the amount of data to copy

UnpackType ( T &, TDesC8 &, TInt )

void	UnpackType	(	T &	aType,
			TDesC8 &	aDes,
			TInt	aOffset
		)	[inline]

Templated function to copy a simple type from a specified position in aDes defined by aOffset. aOffset is not updated on return.

Parameter	Description
aType	This pointer is set with the pointer to the type in aDes
aDes	The buffer that contains the type T pointed to by aPtr
aOffset	The running index of where the following type begins. Updated by ExtractPointer

UnpackTypeAdvance ( T &, TDesC8 &, TInt & )

void	UnpackTypeAdvance	(	T &	aType,
			TDesC8 &	aDes,
			TInt &	aOffset
		)	[inline]

Templated function to copy a simple type from a specified position in aDes defined by aOffset. aOffset is advanced so that on return, the new offset is stored enabling the next call to UnpackType() to point at the position following this type.

Parameter	Description
aType	This pointer is set with the pointer to the type in aDes
aDes	The buffer that contains the type T pointed to by aPtr
aOffset	The running index of where the following type begins. Updated by ExtractPointer

UnpackTypeAdvance ( TDriveList &, TDesC8 &, TInt & )

void	UnpackTypeAdvance	(	TDriveList &	aType,
			TDesC8 &	aDes,
			TInt &	aOffset
		)	[inline]

Parameter	Description
aType	This pointer is set with the pointer to the type in aDes
aDes	The buffer that contains the type T pointed to by aPtr
aOffset	The running index of where the following type begins. Updated by ExtractPointer

WriteL ( T &, TPtr8 & )

void	WriteL	(	T &	aT,
			TPtr8 &	aBuffer
		)

WriteL ( T &, TPtr8 &, TInt, TInt )

void	WriteL	(	T &	aT,
			TPtr8 &	aBuffer,
			TInt	aStartAt = 0,
			TInt	aToCopy = sizeof(T)
		)

Writes data from aBuffer into any given type

Parameter	Description
aT	type to read in from buffer
aBuffer	the buffer
aStartAt	offset of the data
aToCopy	the amount of data to copy

WriteToBufferF ( T &, TPtr8 & )

TBool	WriteToBufferF	(	T &	aT,
			TPtr8 &	aPtr
		)

Writes flat structures to the buffer.

NOTE: This should _ONLY_ be used to write T classes to the buffer.

Parameter	Description
aT	The flat structure to write to the buffer.

Returns: ETrue on success. EFalse on failure.

WriteToBufferV ( const TPtr8 &, TInt, TPtr8 & )

TBool	WriteToBufferV	(	const TPtr8 &	aPtr,
			TInt	aSize,
			TPtr8 &	aBuffer
		)

Writes some vairable data to the buffer.

NOTE: This should _ONLY_ be used to write T classes to the buffer.

Parameter	Description
aPtr	buffer to read from.
aSize	size of the data to write.
aBuffer	the buffer to write to.

Returns: ETrue on success. EFalse on failure.

_LIT ( KABServerName, "!ABServer" )

_LIT	(	KABServerName	,
		"!ABServer"
	)

The name of the AB server.

_LIT ( KBackSlash, "\\" )

_LIT	(	KBackSlash	,
		"\\"
	)

_LIT ( KBackupRegistrationFile, "backup_registration*.xml" )

_LIT	(	KBackupRegistrationFile	,
		"backup_registration*.xml"
	)

_LIT ( KCentRepProcessName, "centralrepositorysrv.exe" )

_LIT	(	KCentRepProcessName	,
		"centralrepositorysrv.exe"
	)

Name of Central Repository Server

_LIT ( KColon, ":" )

_LIT	(	KColon	,
		":"
	)

_LIT ( KConfigFile, "sbeconfig.xml" )

_LIT	(	KConfigFile	,
		"sbeconfig.xml"
	)

_LIT ( KDrive, "?:" )

_LIT	(	KDrive	,
		"?:"
	)

_LIT ( KDriveAndSlash, "?:\\" )

_LIT	(	KDriveAndSlash	,
		"?:\\"
	)

_LIT ( KExclamationAsDrive, "!" )

_LIT	(	KExclamationAsDrive	,
		"!"
	)

_LIT ( KImport, "\\import\\" )

_LIT	(	KImport	,
		"\\import\\"
	)

_LIT ( KImportDir, "\\private\\10202D56\\import\\packages\\" )

_LIT	(	KImportDir	,
		"\\private\\10202D56\\import\\packages\\"
	)

_LIT ( KMIDletTempRestorePath, "C:\\system\\temp\\MIDletRestore\\" )

_LIT	(	KMIDletTempRestorePath	,
		"C:\\system\\temp\\MIDletRestore\\"
	)

Temporary path used for restoring midlets

_LIT ( KOther, "\\..\\" )

_LIT	(	KOther	,
		"\\..\\"
	)

_LIT ( KPad, "00000000" )

_LIT	(	KPad	,
		"00000000"
	)

_LIT ( KPrimaryBackupRegistrationFile, "backup_registration.xml" )

_LIT	(	KPrimaryBackupRegistrationFile	,
		"backup_registration.xml"
	)

_LIT ( KPrivate, "\\private\\" )

_LIT	(	KPrivate	,
		"\\private\\"
	)

_LIT ( KPrivateMatch, "?:\\private\\*" )

_LIT	(	KPrivateMatch	,
		"?:\\private\\*"
	)

_LIT ( KPrivateNoBackup, "?:\\private\\????????\\NoBackup\\*" )

_LIT	(	KPrivateNoBackup	,
		"?:\\private\\????????\\NoBackup\\*"
	)

_LIT ( KPrivateSidMatch, "?:\\private\\" )

_LIT	(	KPrivateSidMatch	,
		"?:\\private\\"
	)

_LIT ( KQuestionMark, "?" )

_LIT	(	KQuestionMark	,
		"?"
	)

_LIT ( KResource, "?:\\resource\\*" )

_LIT	(	KResource	,
		"?:\\resource\\*"
	)

_LIT ( KSBEServerName, "!SBEServer" )

_LIT	(	KSBEServerName	,
		"!SBEServer"
	)

The name of the SBE server execuatable.

_LIT ( KSBImageName, "sbengine" )

_LIT	(	KSBImageName	,
		"sbengine"
	)

The Secure Backup image name

_LIT ( KStar, "*" )

_LIT	(	KStar	,
		"*"
	)

_LIT ( KSys, "?:\\sys\\*" )

_LIT	(	KSys	,
		"?:\\sys\\*"
	)

_LIT ( KSystem, "?:\\system\\*" )

_LIT	(	KSystem	,
		"?:\\system\\*"
	)

_LIT ( KTempPath, ":\\system\\temp\\" )

_LIT	(	KTempPath	,
		":\\system\\temp\\"
	)

_LIT8 ( KActiveAndProxy, "activeandproxy" )

_LIT8	(	KActiveAndProxy	,
		"activeandproxy"
	)

_LIT8 ( KActiveBackup, "active_backup" )

_LIT8	(	KActiveBackup	,
		"active_backup"
	)

_LIT8 ( KActiveOnly, "activeonly" )

_LIT8	(	KActiveOnly	,
		"activeonly"
	)

_LIT8 ( KActiveType, "active_type" )

_LIT8	(	KActiveType	,
		"active_type"
	)

_LIT8 ( KAppCloseDelay, "app_close_delay" )

_LIT8	(	KAppCloseDelay	,
		"app_close_delay"
	)

_LIT8 ( KBackupRegistration, "backup_registration" )

_LIT8	(	KBackupRegistration	,
		"backup_registration"
	)

_LIT8 ( KBaseBackupOnly, "base_backup_only" )

_LIT8	(	KBaseBackupOnly	,
		"base_backup_only"
	)

_LIT8 ( KCallbackDelayTime, "callback_delay_time" )

_LIT8	(	KCallbackDelayTime	,
		"callback_delay_time"
	)

_LIT8 ( KCenrepBackup, "cenrep_backup" )

_LIT8	(	KCenrepBackup	,
		"cenrep_backup"
	)

_LIT8 ( KCentRep, "central_repository" )

_LIT8	(	KCentRep	,
		"central_repository"
	)

_LIT8 ( KConfig, "sbe_config" )

_LIT8	(	KConfig	,
		"sbe_config"
	)

_LIT8 ( KDBMSBackup, "dbms_backup" )

_LIT8	(	KDBMSBackup	,
		"dbms_backup"
	)

_LIT8 ( KDatabase, "database" )

_LIT8	(	KDatabase	,
		"database"
	)

_LIT8 ( KDelay, "delay" )

_LIT8	(	KDelay	,
		"delay"
	)

_LIT8 ( KDeleteBeforeRestore, "delete_before_restore" )

_LIT8	(	KDeleteBeforeRestore	,
		"delete_before_restore"
	)

_LIT8 ( KDrives, "exclude_drives" )

_LIT8	(	KDrives	,
		"exclude_drives"
	)

_LIT8 ( KExclude, "exclude" )

_LIT8	(	KExclude	,
		"exclude"
	)

_LIT8 ( KHeap, "heap" )

_LIT8	(	KHeap	,
		"heap"
	)

_LIT8 ( KHexLeader, "0x" )

_LIT8	(	KHexLeader	,
		"0x"
	)

_LIT8 ( KIncludeDirectory, "include_directory" )

_LIT8	(	KIncludeDirectory	,
		"include_directory"
	)

_LIT8 ( KIncludeFile, "include_file" )

_LIT8	(	KIncludeFile	,
		"include_file"
	)

_LIT8 ( KJavaXMLElementIncludeDirectory, "java_include_directory" )

_LIT8	(	KJavaXMLElementIncludeDirectory	,
		"java_include_directory"
	)

_LIT8 ( KJavaXMLElementJavaBackupMIDlet, "java_backup_midlet" )

_LIT8	(	KJavaXMLElementJavaBackupMIDlet	,
		"java_backup_midlet"
	)

_LIT8 ( KJavaXMLElementMIDletSuite, "midlet_suite" )

_LIT8	(	KJavaXMLElementMIDletSuite	,
		"midlet_suite"
	)

_LIT8 ( KList, "list" )

_LIT8	(	KList	,
		"list"
	)

_LIT8 ( KMaxRetries, "max_retries" )

_LIT8	(	KMaxRetries	,
		"max_retries"
	)

_LIT8 ( KMimeType, "text/xml" )

_LIT8	(	KMimeType	,
		"text/xml"
	)

_LIT8 ( KPassiveBackup, "passive_backup" )

_LIT8	(	KPassiveBackup	,
		"passive_backup"
	)

_LIT8 ( KPolicy, "policy" )

_LIT8	(	KPolicy	,
		"policy"
	)

_LIT8 ( KProcessName, "process_name" )

_LIT8	(	KProcessName	,
		"process_name"
	)

_LIT8 ( KProxyDataManager, "proxy_data_manager" )

_LIT8	(	KProxyDataManager	,
		"proxy_data_manager"
	)

_LIT8 ( KProxyOnly, "proxyonly" )

_LIT8	(	KProxyOnly	,
		"proxyonly"
	)

_LIT8 ( KProxySID, "SID" )

_LIT8	(	KProxySID	,
		"SID"
	)

_LIT8 ( KPublicBackup, "public_backup" )

_LIT8	(	KPublicBackup	,
		"public_backup"
	)

_LIT8 ( KRedFact, "reduction_factor" )

_LIT8	(	KRedFact	,
		"reduction_factor"
	)

_LIT8 ( KRequiresDelay, "requires_delay_to_prepare_data" )

_LIT8	(	KRequiresDelay	,
		"requires_delay_to_prepare_data"
	)

_LIT8 ( KRequiresReboot, "requires_reboot" )

_LIT8	(	KRequiresReboot	,
		"requires_reboot"
	)

_LIT8 ( KRestore, "restore" )

_LIT8	(	KRestore	,
		"restore"
	)

_LIT8 ( KSize, "size" )

_LIT8	(	KSize	,
		"size"
	)

_LIT8 ( KSupportsInc, "supports_incremental" )

_LIT8	(	KSupportsInc	,
		"supports_incremental"
	)

_LIT8 ( KSupportsSelective, "supports_selective" )

_LIT8	(	KSupportsSelective	,
		"supports_selective"
	)

_LIT8 ( KSystemBackup, "system_backup" )

_LIT8	(	KSystemBackup	,
		"system_backup"
	)

_LIT8 ( KUid, "uid" )

_LIT8	(	KUid	,
		"uid"
	)

_LIT8 ( KVersion, "1.0" )

_LIT8	(	KVersion	,
		"1.0"
	)

_LIT8 ( KYes, "yes" )

_LIT8	(	KYes	,
		"yes"
	)

_LIT_SECURE_ID ( KCentRepSID, 0x10202BE9 )

_LIT_SECURE_ID	(	KCentRepSID	,
		0x10202BE9
	)

_LIT_SECURE_ID ( KDummyId, 0x00000000 )

_LIT_SECURE_ID	(	KDummyId	,
		0x00000000
	)

_LIT_SECURITY_POLICY_PASS ( KReadPolicy )

_LIT_SECURITY_POLICY_PASS

(

KReadPolicy

)

_LIT_SECURITY_POLICY_S0 ( KWritePolicy, KSID )

_LIT_SECURITY_POLICY_S0	(	KWritePolicy	,
		KSID
	)

conn

Member Type Definition Documentation

Typedef RFileArray

Typedef RRestoreFileFilterArray

Typedef RSIDArray

Typedef RSIDStatusArray

Typedef RSelections

Typedef RSnapshots

Typedef TActiveBURSettings

Typedef TCommonBURSettings

Typedef TPackageName

Typedef TPassiveBURSettings

Member Attribute Documentation

KABASyncMessageSlots

KABBuildVersionNumber

KABCallbackDefaultTimeout

KABCallbackWatchdogTimeout

KABMajorVersionNumber

KABMaxSendDataBlock

KABMinorVersionNumber

KABRetryCount

KBURPartTypeMask

KBackupIncTypeMask

KCharWidthInBytes

KCompressionBlockSize

KDataOffset

KDefaultDelay

KDesCArrayGranularity

KDescriptorOffset

KEncryptionBufferSize

KHeaderOffset

KIPCMessageSize

KJavaIdLength

KJavaVirtualMachineSecureId

KKeySize

KMaxDerivedTypes

KMaxGenericTypeSize

KMaxHeapSize

KMaxPackageNameLength

KMinHeapSize

KNullABSid

KSBBufferBlockSize

KSBEASyncMessageSlots

KSBEBuildVersionNumber

KSBEGSHDefaultSize

KSBEGSHMaxRetries

KSBEGSHReductionFactor

KSBEMajorVersionNumber

KSBEMaxHexStringLength

KSBEMinorVersionNumber

KSBERetryCount

KSBServerUID3

KSID

KSIDLength

KShutdownDelay

KUidBackupRestoreKey

myABElements

myABElementsIndex

myABPolicy

myABRangeCount

myABRanges

mySBEElements

mySBEElementsIndex

mySBEPolicy

mySBERangeCount

mySBERanges

Member Enumeration Documentation

Enum TABCallbackCommands

Enum TABMessages

Enum TActiveBUROptions

Enum TActiveType

Enum TBURPartType

Enum TBackupDataType

Enum TBackupIncType

Enum TCommonBUROptions

Enum TDataOwnerStatus

Enum TJavaTransferType

Enum TPackageDataType

Enum TPassiveBUROptions

Enum TSBDerivedType

ReadFromBufferF ( T &, TUint8 &, const TUint8 )

ReadFromBufferF< TFileFixedHeader > ( TFileFixedHeader &, TUint8 &, const TUint8 )

ReadFromBufferF< TSnapshot > ( TSnapshot &, TUint8 &, const TUint8 )

ReadFromBufferV ( TPtr8 &, TInt, TUint8 &, const TUint8 )

_LIT ( KImport, "\\import\\" )

_LIT ( KOther, "\\..\\" )