ChspsMaintenanceHandler Class Reference

class ChspsMaintenanceHandler : public CTimer

Class ChspsMaintenanceHandler. ChspsMaintenanceHandler performs all theme maintenance related functionality for hspsThemeServer. Maintenance services includes theme listing, theme activation, theme removal and default theme restoring operations.

Class inheritance: ================== ChspsMaintenanceHandler derives CTimer for active timer functionality. It implements MhspsMaintenanceService-interface from HSPS Theme Management Service APIs. For more information, see HSPS Theme Management Service API documentation.

Functionality: ============== Maintenance functions are presented in high-level and low-level parametrization mode. This is the same approach that was introduced with HSPS Theme Installation Service
  • to support user-intefaces with human-readable high-level elements and on the other hand, machine-originated users with low-level data. Most of the maintenance functions are synchronous, only one is asynchronous; hspsGetNextHeader(). Others functions are straightforward to use but hspsGetListHeaders(). This will be explained next; synchronous call hspsGetListHeaders() initiates the theme header listing by passing search mask to HSPS Theme Server's Maintenance Service. This search mask is called a query. It also passes a list object in where maintenance service should append theme-header objects (type of ChspsODT-class without DOM-document) when one is retrieved asychronously. Search mask should be filled with proper parameters matching the need in hand. If no parameters are given, all headers of Application Themes available in Definition Repository will be delivered, otherwise, only sub-set of theme-headers will be delivered. After the query-call hspsGetListHeaders(), the delivering of the theme-headers is asynchronous. Asynchronous service must be initiated by calling hspsGetNextHeader() after checking that any theme matching on current query is found. This action is called a subscription. To receive theme listing, the client application must implement MhspsThemeManagementServiceObserver-interface and start to listen call-back messages. The headers matching on query will be delivered immediately. Query remains until hspsCancelGetListHeaders() is called by client. If a new Application Theme exist in repository, it will be delivered. As mentioned, when hspsGetListHeaders() returns, the return value must be checked. Return value could be one of the following:

  • EhspsGetListHeadersSuccess - there is at least one Application Theme available matching on query. Call first hspsGetNextHeader() to get the headers. Same call will set the subscribtion of new ones possible coming available later on.

  • EhspsGetListHeadersEmpty - there is no themes matching on the query available at the time, however, some might be exist later in due to installations. Client application should retain the subcription.

  • EhspsGetListHeadersFailed - service request failed in some reason. Possible reasons are for e.g. the missing rights to list headers queried.

In the near future, there will be s.c. Additional Return Code Support feature available in HSPS. This code will express for e.g. the number of headers to be delivered or possible system error code in failed cases.

By MhspsServiceObserver::HandlehspsServiceMessage() call-back function implementation, client application must listen the following ThspsServiceCompletedMessage-messages:
  • EhspsGetListHeadersUpdate - header list on the client side has a new object appended at the end of the list,

  • EhspsGetListHeadersRestart - header list on server side has changed so much that the client must empty the list printed on screen. New list will be delivered immediately. The subscription stands.

  • EhspsGetListHeadersEmpty - header list on server side is now empty. The client must empty the list on screen if printed. The subscription stands.

  • EhspsGetListHeadersFailed - operation has failed. Client should cancel request and restart, perhaps.

Maintenanace functions may also return one of the following codes:
  • EhspsServiceRequestSheduled, or

  • EhspsServiceRequestError.

For explanation of the meanings of these messages, see ThspsServiceCompletedMessage-documentation.

hspsThemeServer.exe
Since
S60 3.1

Inherits from

Public Member Functions
~ChspsMaintenanceHandler()
TBool HandleDefinitionRespositoryEvent(ThspsRepositoryInfo)
ChspsMaintenanceHandler *NewL(ChspsThemeServer &, const TUint)
ChspsMaintenanceHandler *NewLC(ChspsThemeServer &, const TUint)
voidServiceAddPluginL(const RMessage2 &)
voidServiceGetListHeadersL(const RMessage2 &)
voidServiceGetNextHeaderL(const RMessage2 &)
voidServiceGetPluginOdtL(const RMessage2 &)
voidServiceMovePluginsL(const RMessage2 &)
voidServiceRemovePluginL(const RMessage2 &)
voidServiceRemoveThemeL(const RMessage2 &)
voidServiceReplacePluginL(const RMessage2 &)
voidServiceRestoreActiveAppConfL(const RMessage2 &)
voidServiceRestoreConfigurationsL(const RMessage2 &)
voidServiceRestoreDefaultL(const RMessage2 &)
voidServiceSetActivePluginL(const RMessage2 &)
voidServiceSetActiveThemeL(const RMessage2 &)
voidServiceSetConfStateL(const RMessage2 &)
voidServiceSetPluginSettingsL(const RMessage2 &)
voidSetServerSession(ChspsThemeServerSession *)
TInt UpdatePluginListL(ChspsODT &, const TInt, const CArrayFixFlat< TInt > &)
ThspsServiceCompletedMessage hspsAddPlugin(const , const , const , const , TInt &)
ThspsServiceCompletedMessage hspsCancelGetListHeaders()
ThspsServiceCompletedMessage hspsGetListHeaders(const TDesC8 &, CArrayPtrSeg< HBufC8 > &)
ThspsServiceCompletedMessage hspsGetListHeaders(const ChspsODT &, const , CArrayPtrFlat< ChspsODT > &)
ThspsServiceCompletedMessage hspsGetNextHeader()
ThspsServiceCompletedMessage hspsMovePluginsL(const , const , const CArrayFixFlat< TInt > &)
ThspsServiceCompletedMessage hspsPluginUpdateL(const ChspsODT &)
ThspsServiceCompletedMessage hspsRemovePlugin(const , const )
ThspsServiceCompletedMessage hspsRemoveThemeL(const ChspsODT &)
ThspsServiceCompletedMessage hspsReplacePlugin(const , const , const )
ThspsServiceCompletedMessage hspsRestoreActiveAppConf(const , const )
ThspsServiceCompletedMessage hspsRestoreDefault(const ChspsODT &, ChspsODT &)
ThspsServiceCompletedMessage hspsSetActivePlugin(const TInt, const TInt)
ThspsServiceCompletedMessage hspsSetActiveTheme(const ChspsODT &, ChspsODT &)
ThspsServiceCompletedMessage hspsSetActiveTheme(const TDesC8 &, TDes8 &)
ThspsServiceCompletedMessage hspsSetConfState(const , const , const , const )
ThspsServiceCompletedMessage hspsSetPluginSettings(const ChspsODT &, const , ChspsDomDocument &, const )
Protected Member Functions
ChspsMaintenanceHandler(ChspsThemeServer &, const TUint)
voidConstructL()
voidDoCancel()
TInt RunError(TInt)
voidRunL()
Private Member Functions
voidAddErrorConfigurationL(ChspsDomDocument &, ChspsDomNode &, const TInt)
voidAddPluginResourcesL(ChspsODT &, const TInt)
TInt AppendConfigurationL(ChspsODT &, const ChspsODT &, const TInt, const TInt, TInt &, TInt &)
TInt AppendPluginConfigurationL(ChspsODT &, ChspsDomNode &, const ChspsODT &, const TInt, const TInt)
TBool CompareHeadersL(const TDesC8 &, const TDesC8 &)
TBool ComparePaths(const ChspsODT &, const ChspsODT &)
voidCompleteRequest(const ThspsServiceCompletedMessage, RMessagePtr2 &, const TDesC8 &)
TBool FilterHeader(const ChspsODT &, const ChspsODT &)
ChspsDomNode *FindActiveView(ChspsODT &)
ChspsDomNode *FindChildPluginNode(ChspsDomNode &, const TInt)
ChspsDomNode &FindNodeByTagL(const TDesC8 &, ChspsDomNode &)
TInt FindPluginPosition(ChspsDomNode &)
ChspsDomNode *FindPluginsNode(ChspsDomNode &)
TInt GetConfigurationNodeDataL(ChspsODT &, const TInt, TInt &, TDes &)
voidGetHeaderListL(CArrayPtrSeg< HBufC8 > &, const ChspsODT &)
ThspsServiceCompletedMessage GetHeaderListUpdateL()
voidGetPluginInstanceCountL(const ChspsODT &, const TInt, TInt &)
voidGetUsedIdsL(ChspsDomDocument &, TInt &, TInt &)
TBool HandleDefinitionRespositoryEventL(ThspsRepositoryInfo)
TInt HandlePluginReferencesL(ChspsODT &, ChspsODT &, TInt &, TInt &)
voidHandleReinstallationL(const TBool)
TBool InvalidateUninstalledPluginInstancesL(ChspsODT &, const TInt, const RArray< TInt > &)
TBool IsConfigurationLocked(ChspsDomNode &)
TBool IsViewConfiguration(ChspsDomNode &)
TInt RemoveConfigurationL(ChspsODT &, const TInt)
TInt RemoveConfigurationL(ChspsODT &, ChspsDomNode &)
TInt RemovePluginConfigurationsL(ChspsODT &, ChspsDomNode &)
voidRemovePluginFromAppConfsL(const ChspsODT &, RArray< ThspsRepositoryInfo > &)
TInt RemovePluginResourcesL(ChspsODT &, const TInt)
voidRemoveThemeL(const ChspsODT &)
voidRemoveUnlockedViewsL(ChspsODT &)
TInt ReplaceConfigurationL(ChspsODT &, const TInt, const ChspsODT &)
TInt RestoreActiveViewL(ChspsODT &)
voidRestoreDefaultAppConfL(ChspsODT *&, ChspsODT &)
voidRestoredDefaultL(const ChspsODT &, ChspsODT &)
voidSetConfStateL(ChspsODT &, TInt, ThspsConfigurationState, ThspsConfStateChangeFilter)
TInt UpdatePluginConfigurationL(ChspsODT &, ChspsODT &, RArray< TInt > &)
voidUpdatePluginFromAppConfsL(ChspsODT &, RArray< ThspsRepositoryInfo > &)
TInt hspsSavePluginSettingsL(ChspsODT &, ChspsDomDocument &)
TInt hspsSetPluginSettingsL(ChspsODT &, TInt, ChspsDomDocument &)
Inherited Functions
CActive::CActive(TInt)
CActive::Cancel()
CActive::Deque()
CActive::Extension_(TUint,TAny *&,TAny *)
CActive::IsActive()const
CActive::IsAdded()const
CActive::Priority()const
CActive::SetActive()
CActive::SetPriority(TInt)
CActive::~CActive()
CBase::CBase()
CBase::Delete(CBase *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
CTimer::After(TTimeIntervalMicroSeconds32)
CTimer::At(const TTime &)
CTimer::AtUTC(const TTime &)
CTimer::CTimer(TInt)
CTimer::HighRes(TTimeIntervalMicroSeconds32)
CTimer::Inactivity(TTimeIntervalSeconds)
CTimer::Lock(TTimerLockSpec)
CTimer::~CTimer()
Inherited Enumerations
CActive:TPriority
Private Attributes
CRepository &iCentralRepository
ThspsServiceCompletedMessage iCompletedMessage
ChspsDefinitionRepository &iDefinitionRepository
TInt iDeliveryCount
CFileMan *iFileMan
CArrayPtrSeg< HBufC8 > *iHeaderDataList
CArrayPtrSeg< ChspsODT > &iHeaderListCache
TBool iMaintainLogoResources
RMessagePtr2 iMessagePtr
ThspsServiceRequestMessage iRequestMessage
ChspsResult *iResult
TBuf8< KMaxResultDataLength8 >iResultData
ChspsODT *iSearchMask
TUint iSecureId
ChspsSecurityEnforcer &iSecurityEnforcer
ChspsThemeServerSession *iServerSession
ChspsODT *iSetMask
TBool iSubscription
ChspsThemeServer &iThemeServer
Inherited Attributes
CActive::iStatus

Constructor & Destructor Documentation

ChspsMaintenanceHandler(ChspsThemeServer &, const TUint)

ChspsMaintenanceHandler(ChspsThemeServer &aThemeServer,
const TUintaSecureId
)[protected]

Parameters

ChspsThemeServer & aThemeServer
const TUint aSecureId

~ChspsMaintenanceHandler()

~ChspsMaintenanceHandler()[virtual]

Destructor.

Member Functions Documentation

AddErrorConfigurationL(ChspsDomDocument &, ChspsDomNode &, const TInt)

voidAddErrorConfigurationL(ChspsDomDocument &aAppDom,
ChspsDomNode &aMissingPluginNode,
const TIntaPluginUid
)[private]
Appends missing plugin with a dummy configuration where status="Error"
Since
S60 5.0

Parameters

ChspsDomDocument & aAppDomis a DOM of an application configuration
ChspsDomNode & aMissingPluginNodeis a plug-in node which was not found from the Plugin Repository
const TInt aPluginUidis an UID of the missing plugin

AddPluginResourcesL(ChspsODT &, const TInt)

voidAddPluginResourcesL(ChspsODT &aAppODT,
const TIntaPluginUid
)[private]
Adds plugin resouces to the provided ODT
Since
S60 5.0

Parameters

ChspsODT & aAppODTis an instance of the the application configuration
const TInt aPluginUidis an UID of the plugin instance

AppendConfigurationL(ChspsODT &, const ChspsODT &, const TInt, const TInt, TInt &, TInt &)

TInt AppendConfigurationL(ChspsODT &aAppODT,
const ChspsODT &aPluginODT,
const TIntaConfigurationId,
const TIntaNewPosition,
TInt &aLastConfId,
TInt &aLastPluginId
)[private]
Appends an application configuration with an instance of a plugin configuration.
Since
S60 5.0

Parameters

ChspsODT & aAppODTis an instance of the the application configuration
const ChspsODT & aPluginODTis an ODT instance of the plugin configuration
const TInt aConfigurationIdis an id of the configuration being modified, identifies a plugins list
const TInt aNewPositionis an index of the new position in the plugins list
TInt & aLastConfIdis a value of the last configuration id
TInt & aLastPluginIdis a value of the last plugin id

AppendPluginConfigurationL(ChspsODT &, ChspsDomNode &, const ChspsODT &, const TInt, const TInt)

TInt AppendPluginConfigurationL(ChspsODT &aAppODT,
ChspsDomNode &aPluginsNode,
const ChspsODT &aPluginODT,
const TIntaNewPosition,
const TIntaNewPluginId
)[private]
Appends a plugins list with a new plugin configuration instance.
Since
S60 5.0

Parameters

ChspsODT & aAppODTis the application configuration being modified
ChspsDomNode & aPluginsNodeis the plugins node where the new plugin instance should be added to
const ChspsODT & aPluginODTis an ODT instance of the plugin configuration to be added
const TInt aNewPositionis an index of the new position in the plugins list
const TInt aNewPluginIdis an id of the new plugin instance

CompareHeadersL(const TDesC8 &, const TDesC8 &)

TBool CompareHeadersL(const TDesC8 &aOldHeaderData,
const TDesC8 &aNewHeaderData
)[private]

Parameters

const TDesC8 & aOldHeaderData
const TDesC8 & aNewHeaderData

ComparePaths(const ChspsODT &, const ChspsODT &)

TBool ComparePaths(const ChspsODT &aOldHeader,
const ChspsODT &aNewHeader
)[private]

Parameters

const ChspsODT & aOldHeader
const ChspsODT & aNewHeader

CompleteRequest(const ThspsServiceCompletedMessage, RMessagePtr2 &, const TDesC8 &)

voidCompleteRequest(const ThspsServiceCompletedMessageaReturnMessage,
RMessagePtr2 &aMessagePtr,
const TDesC8 &aHeaderData =  KNullDesC8
)[private]

Parameters

const ThspsServiceCompletedMessage aReturnMessage
RMessagePtr2 & aMessagePtr
const TDesC8 & aHeaderData =  KNullDesC8

ConstructL()

voidConstructL()[protected]

By default Symbian 2nd phase constructor is private.

DoCancel()

voidDoCancel()[protected, virtual]

From CActive, DoCancel. Cancels any outstanding operation.

FilterHeader(const ChspsODT &, const ChspsODT &)

TBool FilterHeader(const ChspsODT &aMask,
const ChspsODT &aHeader
)[private]

Parameters

const ChspsODT & aMask
const ChspsODT & aHeader

FindActiveView(ChspsODT &)

ChspsDomNode *FindActiveView(ChspsODT &aAppODT)[private]
Finds a plugin node which is the active view configuration.
Since
S60 5.2

Parameters

ChspsODT & aAppODTApplication configuration

FindChildPluginNode(ChspsDomNode &, const TInt)

ChspsDomNode *FindChildPluginNode(ChspsDomNode &aPluginsNode,
const TIntaPluginId
)[private]
Finds a plugin node with the provided id which is also a children of the provided plugins node
Since
S60 5.0

Parameters

ChspsDomNode & aPluginsNodeis an instance of the plugins node
const TInt aPluginIdis an ID of the plugin instance to be found within the plugins node

FindNodeByTagL(const TDesC8 &, ChspsDomNode &)

ChspsDomNode &FindNodeByTagL(const TDesC8 &aNodeTag,
ChspsDomNode &aDomNode
)[private]
Finds a item node with the provided item id
Since
S60 5.0

Parameters

const TDesC8 & aNodeTag
ChspsDomNode & aDomNodeA Dom node where the target node is searched from.

FindPluginPosition(ChspsDomNode &)

TInt FindPluginPosition(ChspsDomNode &aPluginNode)[private]
Returns position of a plugin in the plugins list
Since
S60 5.0

Parameters

ChspsDomNode & aPluginNodeis a plugin to be found

FindPluginsNode(ChspsDomNode &)

ChspsDomNode *FindPluginsNode(ChspsDomNode &aNode)[private]
Finds the plugins node of the provided plugin node.
Since
S60 5.0

Parameters

ChspsDomNode & aNodeis the plugins node to be searched

GetConfigurationNodeDataL(ChspsODT &, const TInt, TInt &, TDes &)

TInt GetConfigurationNodeDataL(ChspsODT &aAppODT,
const TIntaPluginId,
TInt &aPluginUid,
TDes &aPluginName
)[private]
Gets configuration node with the provided plugin id
Since
S60 5.0

Parameters

ChspsODT & aAppODTis an instance of the the application configuration
const TInt aPluginIdis an ID of the plugin instance to be found
TInt & aPluginUidis an UID of the plugin instance
TDes & aPluginName

GetHeaderListL(CArrayPtrSeg< HBufC8 > &, const ChspsODT &)

voidGetHeaderListL(CArrayPtrSeg< HBufC8 > &aHeaderDataList,
const ChspsODT &aSearchMask
)[private]

C++ default constructor.

Parameters

CArrayPtrSeg< HBufC8 > & aHeaderDataList
const ChspsODT & aSearchMask

GetHeaderListUpdateL()

ThspsServiceCompletedMessage GetHeaderListUpdateL()[private]

GetPluginInstanceCountL(const ChspsODT &, const TInt, TInt &)

voidGetPluginInstanceCountL(const ChspsODT &aAppODT,
const TIntaPluginUid,
TInt &aInstanceCount
)[private]
Returns a count of plugin instances.
Since
S60 5.0

Parameters

const ChspsODT & aAppODTis an instance of the the application configuration
const TInt aPluginUidis an UID of the plugin instances to be found
TInt & aInstanceCountis the return value

GetUsedIdsL(ChspsDomDocument &, TInt &, TInt &)

voidGetUsedIdsL(ChspsDomDocument &aDom,
TInt &aLastUsedConfId,
TInt &aLastUsedPluginId
)[private]
Finds last id value from the provided DOM.
Since
S60 5.0

Parameters

ChspsDomDocument & aDomis the application configuration in XML format
TInt & aLastUsedConfIdis the largest used configurtion id
TInt & aLastUsedPluginIdis the largest used plugin id

HandleDefinitionRespositoryEvent(ThspsRepositoryInfo)

TBool HandleDefinitionRespositoryEvent(ThspsRepositoryInfoaRepositoryInfo)

Parameters

ThspsRepositoryInfo aRepositoryInfo

HandleDefinitionRespositoryEventL(ThspsRepositoryInfo)

TBool HandleDefinitionRespositoryEventL(ThspsRepositoryInfoaRepositoryInfo)[private]

HandleDefinitionRespositoryEventL

Since
S60 5.0

Parameters

ThspsRepositoryInfo aRepositoryInfo

HandlePluginReferencesL(ChspsODT &, ChspsODT &, TInt &, TInt &)

TInt HandlePluginReferencesL(ChspsODT &aAppODT,
ChspsODT &aPluginODT,
TInt &aLastConfId,
TInt &aLastPluginId
)[private]
Finds plugin nodes from the plugin configuration being added, appends referred configurations into the main plugin configuration, and updates the plugin nodes with unique id attribute values.
Since
S60 5.0

Parameters

ChspsODT & aAppODTis an instance of the the application configuration
ChspsODT & aPluginODTis an instance of the plugin configuration being added
TInt & aLastConfIdis a value of the last configuration id
TInt & aLastPluginIdis a value of the last plugin id

HandleReinstallationL(const TBool)

voidHandleReinstallationL(const TBoolaInstallUdaEmmc)[private]
Restores plug-ins by reinstallation.
Since
S60 5.2

Parameters

const TBool aInstallUdaEmmcSet if UDA and eMMC drives should used

InvalidateUninstalledPluginInstancesL(ChspsODT &, const TInt, const RArray< TInt > &)

TBool InvalidateUninstalledPluginInstancesL(ChspsODT &aAppODT,
const TIntaPluginUid,
const RArray< TInt > &aPluginIds
)[private]
InvalidateUninstalledPluginInstancesL Removes uninstalled plugin instances from an inactive application configuration by changing them to error state.
Since
S60 5.2

Parameters

ChspsODT & aAppODTapplication configuration to be updated
const TInt aPluginUidplugin to be uninstalled
const RArray< TInt > & aPluginIdsan array on plugin ids to be processed

IsConfigurationLocked(ChspsDomNode &)

TBool IsConfigurationLocked(ChspsDomNode &aConfNode)[private]
Checks whether the plugin configuration was locked.
Since
S60 5.2

Parameters

ChspsDomNode & aConfNodeConfiguration node

IsViewConfiguration(ChspsDomNode &)

TBool IsViewConfiguration(ChspsDomNode &aPluginNode)[private]
Checks if the provided plugin configuration is a collection of plugin configurations, e.g. view configuration. Alternatively, we could check the type from header cache
Since
S60 5.2

Parameters

ChspsDomNode & aPluginNodePlugin node

NewL(ChspsThemeServer &, const TUint)

ChspsMaintenanceHandler *NewL(ChspsThemeServer &aThemeServer,
const TUintaSecureId = 0
)[static]
NewL. Two-phased constructor.
Since
S60 5.0

Parameters

ChspsThemeServer & aThemeServerServer instance
const TUint aSecureId = 0Identifies the client application which uses the handler

NewLC(ChspsThemeServer &, const TUint)

ChspsMaintenanceHandler *NewLC(ChspsThemeServer &aThemeServer,
const TUintaSecureId = 0
)[static]
NewLC. Two-phased constructor.
Since
S60 5.0

Parameters

ChspsThemeServer & aThemeServerServer instance
const TUint aSecureId = 0Identifies the client application which uses the handler

RemoveConfigurationL(ChspsODT &, const TInt)

TInt RemoveConfigurationL(ChspsODT &aAppODT,
const TIntaPluginId
)[private]
Removes an plugin instance from the provided application configuration
Since
S60 5.0

Parameters

ChspsODT & aAppODTis an instance of the the application configuration
const TInt aPluginIdis an ID of the plugin instance to be removed

RemoveConfigurationL(ChspsODT &, ChspsDomNode &)

TInt RemoveConfigurationL(ChspsODT &aAppODT,
ChspsDomNode &aPluginNode
)[private]
Removes an plugin instance from the provided application configuration
Since
S60 5.0

Parameters

ChspsODT & aAppODTis an instance of the the application configuration
ChspsDomNode & aPluginNodeis a node of the plugin instance to be removed

RemovePluginConfigurationsL(ChspsODT &, ChspsDomNode &)

TInt RemovePluginConfigurationsL(ChspsODT &aAppODT,
ChspsDomNode &aActivePluginNode
)[private]
Removes all plugin configurations from the provided plugin node (view configuration).
Since
S60 5.2

Parameters

ChspsODT & aAppODTApplication configuration
ChspsDomNode & aActivePluginNodePlugin node to be modified

RemovePluginFromAppConfsL(const ChspsODT &, RArray< ThspsRepositoryInfo > &)

voidRemovePluginFromAppConfsL(const ChspsODT &aOdt,
RArray< ThspsRepositoryInfo > &aNotificationParams
)[private]

RemovePluginFromAppConfs

Since
S60 5.0

Parameters

const ChspsODT & aOdt
RArray< ThspsRepositoryInfo > & aNotificationParams

RemovePluginResourcesL(ChspsODT &, const TInt)

TInt RemovePluginResourcesL(ChspsODT &aAppODT,
const TIntaPluginUid
)[private]
Removes plugin resources from the provided ODT
Since
S60 5.0

Parameters

ChspsODT & aAppODTis an instance of the the application configuration
const TInt aPluginUidis an UID of the plugin instance

RemoveThemeL(const ChspsODT &)

voidRemoveThemeL(const ChspsODT &aSetMask)[private]

Parameters

const ChspsODT & aSetMask

RemoveUnlockedViewsL(ChspsODT &)

voidRemoveUnlockedViewsL(ChspsODT &aAppODT)[private]
Removes all unlocked views and reset the active view. Can leave if DOM is corrupted (objects are not found) or in OOM cases.
Since
S60 5.2

Parameters

ChspsODT & aAppODTApplication configuration

ReplaceConfigurationL(ChspsODT &, const TInt, const ChspsODT &)

TInt ReplaceConfigurationL(ChspsODT &aAppODT,
const TIntaPluginId,
const ChspsODT &aPluginODT
)[private]
Replaces plugin configuration in the provided application configuration
Since
S60 5.0

Parameters

ChspsODT & aAppODTis an instance of the the application configuration
const TInt aPluginIdis an id of the plugin to be replaced
const ChspsODT & aPluginODTis an instance of the plugin configuration to be added

RestoreActiveViewL(ChspsODT &)

TInt RestoreActiveViewL(ChspsODT &aAppODT)[private]
Removes all plugins from the plugins node and related resources from the resource array.
Since
S60 5.2

Parameters

ChspsODT & aAppODTApplication configuration

RestoreDefaultAppConfL(ChspsODT *&, ChspsODT &)

voidRestoreDefaultAppConfL(ChspsODT *&aHeader,
ChspsODT &aOdt
)[private]
Restores default configuration defined for the application
Since
S60 5.0

Parameters

ChspsODT *& aHeaderODT header which defines the restored configuration
ChspsODT & aOdtrestored application configuration

RestoredDefaultL(const ChspsODT &, ChspsODT &)

voidRestoredDefaultL(const ChspsODT &aSetMask,
ChspsODT &aHeader
)[private]

Parameters

const ChspsODT & aSetMask
ChspsODT & aHeader

RunError(TInt)

TInt RunError(TIntaError)[protected, virtual]
From CActive Called when asynchronous request has failed
Since
S60 3.1

Parameters

TInt aError

RunL()

voidRunL()[protected, virtual]

From CActive, RunL. Callback function. Invoked to handle responses from the server.

ServiceAddPluginL(const RMessage2 &)

voidServiceAddPluginL(const RMessage2 &aMessage)
ServiceAddPluginL
Since
S60 5.0

Parameters

const RMessage2 & aMessagecontains the data received from the client

ServiceGetListHeadersL(const RMessage2 &)

voidServiceGetListHeadersL(const RMessage2 &aMessage)
ServiceGetListHeadersL
Since
S60 3.1

Parameters

const RMessage2 & aMessagecontains the data received from the client

ServiceGetNextHeaderL(const RMessage2 &)

voidServiceGetNextHeaderL(const RMessage2 &aMessage)
ServiceGetNextHeaderL
Since
S60 3.1

Parameters

const RMessage2 & aMessagecontains the data received from the client

ServiceGetPluginOdtL(const RMessage2 &)

voidServiceGetPluginOdtL(const RMessage2 &aMessage)

Parameters

const RMessage2 & aMessage

ServiceMovePluginsL(const RMessage2 &)

voidServiceMovePluginsL(const RMessage2 &aMessage)
ServiceMovePluginsL
Since
S60 5.0

Parameters

const RMessage2 & aMessagecontains the data received from the client

ServiceRemovePluginL(const RMessage2 &)

voidServiceRemovePluginL(const RMessage2 &aMessage)
ServiceRemovePluginL
Since
S60 5.0

Parameters

const RMessage2 & aMessagecontains the data received from the client

ServiceRemoveThemeL(const RMessage2 &)

voidServiceRemoveThemeL(const RMessage2 &aMessage)
ServiceRemoveThemeL
Since
S60 3.1

Parameters

const RMessage2 & aMessagecontains the data received from the client

ServiceReplacePluginL(const RMessage2 &)

voidServiceReplacePluginL(const RMessage2 &aMessage)
ServiceReplacePluginL
Since
S60 5.0

Parameters

const RMessage2 & aMessagecontains the data received from the client

ServiceRestoreActiveAppConfL(const RMessage2 &)

voidServiceRestoreActiveAppConfL(const RMessage2 &aMessage)
ServiceRestoreActiveAppConfL
Since
S60 5.0

Parameters

const RMessage2 & aMessagecontains the data received from the client

ServiceRestoreConfigurationsL(const RMessage2 &)

voidServiceRestoreConfigurationsL(const RMessage2 &aMessage)
ServiceRestoreConfigurationsL
Since
S60 5.2

Parameters

const RMessage2 & aMessagecontains the data received from the client

ServiceRestoreDefaultL(const RMessage2 &)

voidServiceRestoreDefaultL(const RMessage2 &aMessage)
ServiceRestoreDefaultL
Since
S60 3.1

Parameters

const RMessage2 & aMessagecontains the data received from the client

ServiceSetActivePluginL(const RMessage2 &)

voidServiceSetActivePluginL(const RMessage2 &aMessage)
ServiceSetActivePluginL
Since
S60 5.0

Parameters

const RMessage2 & aMessagecontains the data received from the client

ServiceSetActiveThemeL(const RMessage2 &)

voidServiceSetActiveThemeL(const RMessage2 &aMessage)
ServiceSetActiveThemeL
Since
S60 3.1

Parameters

const RMessage2 & aMessagecontains the data received from the client

ServiceSetConfStateL(const RMessage2 &)

voidServiceSetConfStateL(const RMessage2 &aMessage)
ServiceSetConfStateL
Since
S60 5.0

Parameters

const RMessage2 & aMessagecontains the data received from the client

ServiceSetPluginSettingsL(const RMessage2 &)

voidServiceSetPluginSettingsL(const RMessage2 &aMessage)
ServiceSetPluginSettingsL
Since
S60 5.0

Parameters

const RMessage2 & aMessagecontains the data received from the client

SetConfStateL(ChspsODT &, TInt, ThspsConfigurationState, ThspsConfStateChangeFilter)

voidSetConfStateL(ChspsODT &aAppODT,
TIntaConfId,
ThspsConfigurationStateaState,
ThspsConfStateChangeFilteraFilter
)[private]
Set configuration node state attribute value
Since
S60 5.0

Parameters

ChspsODT & aAppODTis an instance of the the application configuration
TInt aConfIdis an ID of the configuration node to be found
ThspsConfigurationState aStateis a new value of the configuration node state attribute
ThspsConfStateChangeFilter aFilter

SetServerSession(ChspsThemeServerSession *)

voidSetServerSession(ChspsThemeServerSession *aServerSession)
SetServerSession.
Since
S60 5.0

Parameters

ChspsThemeServerSession * aServerSession

UpdatePluginConfigurationL(ChspsODT &, ChspsODT &, RArray< TInt > &)

TInt UpdatePluginConfigurationL(ChspsODT &aOdt,
ChspsODT &aPluginOdt,
RArray< TInt > &aPluginIds
)[private]

UpdatePluginConfigurationL

Since
S60 5.0

Parameters

ChspsODT & aOdt
ChspsODT & aPluginOdt
RArray< TInt > & aPluginIds

UpdatePluginFromAppConfsL(ChspsODT &, RArray< ThspsRepositoryInfo > &)

voidUpdatePluginFromAppConfsL(ChspsODT &aOdt,
RArray< ThspsRepositoryInfo > &aNotificationParams
)[private]

UpdatePluginFromAppConfsL

Since
S60 5.0

Parameters

ChspsODT & aOdt
RArray< ThspsRepositoryInfo > & aNotificationParams

UpdatePluginListL(ChspsODT &, const TInt, const CArrayFixFlat< TInt > &)

TInt UpdatePluginListL(ChspsODT &aAppODT,
const TIntaConfigurationId,
const CArrayFixFlat< TInt > &aPluginIdList
)

Parameters

ChspsODT & aAppODT
const TInt aConfigurationId
const CArrayFixFlat< TInt > & aPluginIdList

hspsAddPlugin(const, const, const, const, TInt &)

ThspsServiceCompletedMessage hspsAddPlugin(const TInt,
const TInt,
const TInt,
const TInt,
TInt &
)
From MhspsMaintenanceService hspsAddPlugin Not used - see ServiceAddPluginL instead which has a diffrent input
Since
S60 5.0

Parameters

const TInt
const TInt
const TInt
const TInt
TInt &

hspsCancelGetListHeaders()

ThspsServiceCompletedMessage hspsCancelGetListHeaders()
From MhspsMaintenanceService hspsCancelGetListHeaders
Since
S60 3.1

hspsGetListHeaders(const TDesC8 &, CArrayPtrSeg< HBufC8 > &)

ThspsServiceCompletedMessage hspsGetListHeaders(const TDesC8 &aSearchMaskData,
CArrayPtrSeg< HBufC8 > &aHeaderDataList
)
From MhspsMaintenanceService hspsGetListHeaders
Since
S60 3.1

Parameters

const TDesC8 & aSearchMaskData
CArrayPtrSeg< HBufC8 > & aHeaderDataList

hspsGetListHeaders(const ChspsODT &, const, CArrayPtrFlat< ChspsODT > &)

ThspsServiceCompletedMessage hspsGetListHeaders(const ChspsODT &,
const TBool,
CArrayPtrFlat< ChspsODT > &
)
From MhspsMaintenanceService hspsGetListHeaders
Since
S60 3.1

Parameters

const ChspsODT &
const TBool
CArrayPtrFlat< ChspsODT > &

hspsGetNextHeader()

ThspsServiceCompletedMessage hspsGetNextHeader()
From MhspsMaintenanceService hspsGetNextHeader
Since
S60 3.1

hspsMovePluginsL(const, const, const CArrayFixFlat< TInt > &)

ThspsServiceCompletedMessage hspsMovePluginsL(const TInt,
const TInt,
const CArrayFixFlat< TInt > &
)

From MhspsMaintenanceService hspsMovePluginsL Not used - see ServiceMovePluginsL instead which has a diffrent input

Parameters

const TInt
const TInt
const CArrayFixFlat< TInt > &

hspsPluginUpdateL(const ChspsODT &)

ThspsServiceCompletedMessage hspsPluginUpdateL(const ChspsODT &aOdt)

Updates plugin configuration in all application configuration

Since
S60 5.0

Parameters

const ChspsODT & aOdt

hspsRemovePlugin(const, const)

ThspsServiceCompletedMessage hspsRemovePlugin(const TInt,
const TInt
)

From MhspsMaintenanceService hspsRemovePlugin Not used - see ServiceRemovePluginL instead which has a diffrent input

Parameters

const TInt
const TInt

hspsRemoveThemeL(const ChspsODT &)

ThspsServiceCompletedMessage hspsRemoveThemeL(const ChspsODT &aSetMask)
From MhspsMaintenanceService hspsRemoveThemeL
Since
S60 3.1

Parameters

const ChspsODT & aSetMaskis an ODT-header parametrized enough to express the theme to be removed.

hspsReplacePlugin(const, const, const)

ThspsServiceCompletedMessage hspsReplacePlugin(const TInt,
const TInt,
const TInt
)

From MhspsMaintenanceService hspsReplacePlugin Not used - see ServiceReplacePluginL instead which has a diffrent input

Parameters

const TInt
const TInt
const TInt

hspsRestoreActiveAppConf(const, const)

ThspsServiceCompletedMessage hspsRestoreActiveAppConf(const TInt,
const TInt
)

From MhspsMaintenanceService hspsRestoreActiveAppConf Not used - see ServiceRestoreActiveAppConfL instead which has a diffrent input

Parameters

const TInt
const TInt

hspsRestoreDefault(const ChspsODT &, ChspsODT &)

ThspsServiceCompletedMessage hspsRestoreDefault(const ChspsODT &aSetMask,
ChspsODT &aHeader
)
From MhspsMaintenanceService hspsRestoreDefault
Since
S60 3.1

Parameters

const ChspsODT & aSetMaskis an ODT-header parametrized enough to express the theme to be made active.
ChspsODT & aHeaderis an empty ODT-header object that will contain the header of the theme actually made active if the request was successful.

hspsSavePluginSettingsL(ChspsODT &, ChspsDomDocument &)

TInt hspsSavePluginSettingsL(ChspsODT &aOdt,
ChspsDomDocument &aDom
)[private]
Saves Plugin settings
Since
S60 5.0

Parameters

ChspsODT & aOdt
ChspsDomDocument & aDomis a Dom Document of the settings that is going to saved

hspsSetActivePlugin(const TInt, const TInt)

ThspsServiceCompletedMessage hspsSetActivePlugin(const TIntaAppUid,
const TIntaPluginId
)

From MhspsMaintenanceService hspsSetActivePlugin Not used - see ServiceRemovePluginL instead which has a diffrent input

Parameters

const TInt aAppUid
const TInt aPluginId

hspsSetActiveTheme(const ChspsODT &, ChspsODT &)

ThspsServiceCompletedMessage hspsSetActiveTheme(const ChspsODT &aSetMask,
ChspsODT &aOdt
)
From MhspsMaintenanceService hspsSetActiveTheme
Since
S60 3.1

Parameters

const ChspsODT & aSetMaskrepresents parameters by which the new theme activation will be done. There must be sufficient set of parameters presented, at least a theme UID.
ChspsODT & aOdtis an empty ODT-object which will contain the ODT of activated theme on the return of the call. This parametrisation follows the high-level schema. There must be sufficient set of parameters presented, at least a theme UID.

hspsSetActiveTheme(const TDesC8 &, TDes8 &)

ThspsServiceCompletedMessage hspsSetActiveTheme(const TDesC8 &,
TDes8 &
)
From MhspsMaintenanceService hspsSetActiveTheme
Since
S60 3.1

Parameters

const TDesC8 &
TDes8 &

hspsSetConfState(const, const, const, const)

ThspsServiceCompletedMessage hspsSetConfState(const TInt,
const TInt,
const ThspsConfigurationState,
const ThspsConfStateChangeFilter
)

From MhspsMaintenanceService hspsSetConfState Not used - see ServiceSetConfStateL instead which has a diffrent input

Parameters

const TInt
const TInt
const ThspsConfigurationState
const ThspsConfStateChangeFilter

hspsSetPluginSettings(const ChspsODT &, const, ChspsDomDocument &, const)

ThspsServiceCompletedMessage hspsSetPluginSettings(const ChspsODT &,
const TInt,
ChspsDomDocument &,
const TBool
)

From MhspsMaintenanceService hspsSetSettings Not used - see ServiceRemovePluginL instead which has a diffrent input

Parameters

const ChspsODT &
const TInt
ChspsDomDocument &
const TBool

hspsSetPluginSettingsL(ChspsODT &, TInt, ChspsDomDocument &)

TInt hspsSetPluginSettingsL(ChspsODT &aOdt,
TIntaPluginId,
ChspsDomDocument &aDom
)[private]
Sets Plugin settings
Since
S60 5.0

Parameters

ChspsODT & aOdtis an instance of the the application configuration
TInt aPluginIdis an ID of the plugin instance to be found
ChspsDomDocument & aDomis a Dom Document of the settings that is going to set/update

Member Data Documentation

CRepository & iCentralRepository

CRepository &iCentralRepository[private]

ThspsServiceCompletedMessage iCompletedMessage

ThspsServiceCompletedMessage iCompletedMessage[private]

ChspsDefinitionRepository & iDefinitionRepository

ChspsDefinitionRepository &iDefinitionRepository[private]

TInt iDeliveryCount

TInt iDeliveryCount[private]

CFileMan * iFileMan

CFileMan *iFileMan[private]

CArrayPtrSeg< HBufC8 > * iHeaderDataList

CArrayPtrSeg< HBufC8 > *iHeaderDataList[private]

CArrayPtrSeg< ChspsODT > & iHeaderListCache

CArrayPtrSeg< ChspsODT > &iHeaderListCache[private]

TBool iMaintainLogoResources

TBool iMaintainLogoResources[private]

RMessagePtr2 iMessagePtr

RMessagePtr2 iMessagePtr[private]

ThspsServiceRequestMessage iRequestMessage

ThspsServiceRequestMessage iRequestMessage[private]

ChspsResult * iResult

ChspsResult *iResult[private]

TBuf8< KMaxResultDataLength8 > iResultData

TBuf8< KMaxResultDataLength8 >iResultData[private]

ChspsODT * iSearchMask

ChspsODT *iSearchMask[private]

TUint iSecureId

TUint iSecureId[private]

ChspsSecurityEnforcer & iSecurityEnforcer

ChspsSecurityEnforcer &iSecurityEnforcer[private]

ChspsThemeServerSession * iServerSession

ChspsThemeServerSession *iServerSession[private]

ChspsODT * iSetMask

ChspsODT *iSetMask[private]

TBool iSubscription

TBool iSubscription[private]

ChspsThemeServer & iThemeServer

ChspsThemeServer &iThemeServer[private]