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.
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.
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.
EhspsServiceRequestSheduled, or
EhspsServiceRequestError.
For explanation of the meanings of these messages, see ThspsServiceCompletedMessage-documentation.
Protected Member Functions | |
---|---|
ChspsMaintenanceHandler(ChspsThemeServer &, const TUint) | |
void | ConstructL() |
void | DoCancel() |
TInt | RunError(TInt) |
void | RunL() |
Inherited Enumerations | |
---|---|
CActive:TPriority |
Inherited Attributes | |
---|---|
CActive::iStatus |
ChspsMaintenanceHandler | ( | ChspsThemeServer & | aThemeServer, |
const TUint | aSecureId | ||
) | [protected] |
ChspsThemeServer & aThemeServer | |
const TUint aSecureId |
void | AddErrorConfigurationL | ( | ChspsDomDocument & | aAppDom, |
ChspsDomNode & | aMissingPluginNode, | |||
const TInt | aPluginUid | |||
) | [private] |
ChspsDomDocument & aAppDom | is a DOM of an application configuration |
ChspsDomNode & aMissingPluginNode | is a plug-in node which was not found from the Plugin Repository |
const TInt aPluginUid | is an UID of the missing plugin |
void | AddPluginResourcesL | ( | ChspsODT & | aAppODT, |
const TInt | aPluginUid | |||
) | [private] |
TInt | AppendConfigurationL | ( | ChspsODT & | aAppODT, |
const ChspsODT & | aPluginODT, | |||
const TInt | aConfigurationId, | |||
const TInt | aNewPosition, | |||
TInt & | aLastConfId, | |||
TInt & | aLastPluginId | |||
) | [private] |
ChspsODT & aAppODT | is an instance of the the application configuration |
const ChspsODT & aPluginODT | is an ODT instance of the plugin configuration |
const TInt aConfigurationId | is an id of the configuration being modified, identifies a plugins list |
const TInt aNewPosition | is an index of the new position in the plugins list |
TInt & aLastConfId | is a value of the last configuration id |
TInt & aLastPluginId | is a value of the last plugin id |
TInt | AppendPluginConfigurationL | ( | ChspsODT & | aAppODT, |
ChspsDomNode & | aPluginsNode, | |||
const ChspsODT & | aPluginODT, | |||
const TInt | aNewPosition, | |||
const TInt | aNewPluginId | |||
) | [private] |
ChspsODT & aAppODT | is the application configuration being modified |
ChspsDomNode & aPluginsNode | is the plugins node where the new plugin instance should be added to |
const ChspsODT & aPluginODT | is an ODT instance of the plugin configuration to be added |
const TInt aNewPosition | is an index of the new position in the plugins list |
const TInt aNewPluginId | is an id of the new plugin instance |
TBool | CompareHeadersL | ( | const TDesC8 & | aOldHeaderData, |
const TDesC8 & | aNewHeaderData | |||
) | [private] |
TBool | ComparePaths | ( | const ChspsODT & | aOldHeader, |
const ChspsODT & | aNewHeader | |||
) | [private] |
void | CompleteRequest | ( | const ThspsServiceCompletedMessage | aReturnMessage, |
RMessagePtr2 & | aMessagePtr, | |||
const TDesC8 & | aHeaderData = KNullDesC8 | |||
) | [private] |
const ThspsServiceCompletedMessage aReturnMessage | |
RMessagePtr2 & aMessagePtr | |
const TDesC8 & aHeaderData = KNullDesC8 |
void | DoCancel | ( | ) | [protected, virtual] |
From CActive, DoCancel. Cancels any outstanding operation.
TBool | FilterHeader | ( | const ChspsODT & | aMask, |
const ChspsODT & | aHeader | |||
) | [private] |
ChspsDomNode * | FindActiveView | ( | ChspsODT & | aAppODT | ) | [private] |
ChspsODT & aAppODT | Application configuration |
ChspsDomNode * | FindChildPluginNode | ( | ChspsDomNode & | aPluginsNode, |
const TInt | aPluginId | |||
) | [private] |
ChspsDomNode & aPluginsNode | is an instance of the plugins node |
const TInt aPluginId | is an ID of the plugin instance to be found within the plugins node |
ChspsDomNode & | FindNodeByTagL | ( | const TDesC8 & | aNodeTag, |
ChspsDomNode & | aDomNode | |||
) | [private] |
const TDesC8 & aNodeTag | |
ChspsDomNode & aDomNode | A Dom node where the target node is searched from. |
TInt | FindPluginPosition | ( | ChspsDomNode & | aPluginNode | ) | [private] |
ChspsDomNode & aPluginNode | is a plugin to be found |
ChspsDomNode * | FindPluginsNode | ( | ChspsDomNode & | aNode | ) | [private] |
ChspsDomNode & aNode | is the plugins node to be searched |
TInt | GetConfigurationNodeDataL | ( | ChspsODT & | aAppODT, |
const TInt | aPluginId, | |||
TInt & | aPluginUid, | |||
TDes & | aPluginName | |||
) | [private] |
void | GetHeaderListL | ( | CArrayPtrSeg< HBufC8 > & | aHeaderDataList, |
const ChspsODT & | aSearchMask | |||
) | [private] |
C++ default constructor.
CArrayPtrSeg< HBufC8 > & aHeaderDataList | |
const ChspsODT & aSearchMask |
void | GetPluginInstanceCountL | ( | const ChspsODT & | aAppODT, |
const TInt | aPluginUid, | |||
TInt & | aInstanceCount | |||
) | [private] |
void | GetUsedIdsL | ( | ChspsDomDocument & | aDom, |
TInt & | aLastUsedConfId, | |||
TInt & | aLastUsedPluginId | |||
) | [private] |
ChspsDomDocument & aDom | is the application configuration in XML format |
TInt & aLastUsedConfId | is the largest used configurtion id |
TInt & aLastUsedPluginId | is the largest used plugin id |
TBool | HandleDefinitionRespositoryEvent | ( | ThspsRepositoryInfo | aRepositoryInfo | ) |
ThspsRepositoryInfo aRepositoryInfo |
TBool | HandleDefinitionRespositoryEventL | ( | ThspsRepositoryInfo | aRepositoryInfo | ) | [private] |
HandleDefinitionRespositoryEventL
ThspsRepositoryInfo aRepositoryInfo |
TInt | HandlePluginReferencesL | ( | ChspsODT & | aAppODT, |
ChspsODT & | aPluginODT, | |||
TInt & | aLastConfId, | |||
TInt & | aLastPluginId | |||
) | [private] |
void | HandleReinstallationL | ( | const TBool | aInstallUdaEmmc | ) | [private] |
const TBool aInstallUdaEmmc | Set if UDA and eMMC drives should used |
TBool | InvalidateUninstalledPluginInstancesL | ( | ChspsODT & | aAppODT, |
const TInt | aPluginUid, | |||
const RArray< TInt > & | aPluginIds | |||
) | [private] |
TBool | IsConfigurationLocked | ( | ChspsDomNode & | aConfNode | ) | [private] |
ChspsDomNode & aConfNode | Configuration node |
TBool | IsViewConfiguration | ( | ChspsDomNode & | aPluginNode | ) | [private] |
ChspsDomNode & aPluginNode | Plugin node |
ChspsMaintenanceHandler * | NewL | ( | ChspsThemeServer & | aThemeServer, |
const TUint | aSecureId = 0 | |||
) | [static] |
ChspsThemeServer & aThemeServer | Server instance |
const TUint aSecureId = 0 | Identifies the client application which uses the handler |
ChspsMaintenanceHandler * | NewLC | ( | ChspsThemeServer & | aThemeServer, |
const TUint | aSecureId = 0 | |||
) | [static] |
ChspsThemeServer & aThemeServer | Server instance |
const TUint aSecureId = 0 | Identifies the client application which uses the handler |
TInt | RemoveConfigurationL | ( | ChspsODT & | aAppODT, |
const TInt | aPluginId | |||
) | [private] |
TInt | RemoveConfigurationL | ( | ChspsODT & | aAppODT, |
ChspsDomNode & | aPluginNode | |||
) | [private] |
ChspsODT & aAppODT | is an instance of the the application configuration |
ChspsDomNode & aPluginNode | is a node of the plugin instance to be removed |
TInt | RemovePluginConfigurationsL | ( | ChspsODT & | aAppODT, |
ChspsDomNode & | aActivePluginNode | |||
) | [private] |
ChspsODT & aAppODT | Application configuration |
ChspsDomNode & aActivePluginNode | Plugin node to be modified |
void | RemovePluginFromAppConfsL | ( | const ChspsODT & | aOdt, |
RArray< ThspsRepositoryInfo > & | aNotificationParams | |||
) | [private] |
RemovePluginFromAppConfs
const ChspsODT & aOdt | |
RArray< ThspsRepositoryInfo > & aNotificationParams |
TInt | RemovePluginResourcesL | ( | ChspsODT & | aAppODT, |
const TInt | aPluginUid | |||
) | [private] |
void | RemoveThemeL | ( | const ChspsODT & | aSetMask | ) | [private] |
const ChspsODT & aSetMask |
void | RemoveUnlockedViewsL | ( | ChspsODT & | aAppODT | ) | [private] |
ChspsODT & aAppODT | Application configuration |
TInt | ReplaceConfigurationL | ( | ChspsODT & | aAppODT, |
const TInt | aPluginId, | |||
const ChspsODT & | aPluginODT | |||
) | [private] |
TInt | RestoreActiveViewL | ( | ChspsODT & | aAppODT | ) | [private] |
ChspsODT & aAppODT | Application configuration |
void | RestoreDefaultAppConfL | ( | ChspsODT *& | aHeader, |
ChspsODT & | aOdt | |||
) | [private] |
void | RestoredDefaultL | ( | const ChspsODT & | aSetMask, |
ChspsODT & | aHeader | |||
) | [private] |
TInt | RunError | ( | TInt | aError | ) | [protected, virtual] |
TInt aError |
void | RunL | ( | ) | [protected, virtual] |
From CActive, RunL. Callback function. Invoked to handle responses from the server.
void | ServiceAddPluginL | ( | const RMessage2 & | aMessage | ) |
const RMessage2 & aMessage | contains the data received from the client |
void | ServiceGetListHeadersL | ( | const RMessage2 & | aMessage | ) |
const RMessage2 & aMessage | contains the data received from the client |
void | ServiceGetNextHeaderL | ( | const RMessage2 & | aMessage | ) |
const RMessage2 & aMessage | contains the data received from the client |
void | ServiceGetPluginOdtL | ( | const RMessage2 & | aMessage | ) |
const RMessage2 & aMessage |
void | ServiceMovePluginsL | ( | const RMessage2 & | aMessage | ) |
const RMessage2 & aMessage | contains the data received from the client |
void | ServiceRemovePluginL | ( | const RMessage2 & | aMessage | ) |
const RMessage2 & aMessage | contains the data received from the client |
void | ServiceRemoveThemeL | ( | const RMessage2 & | aMessage | ) |
const RMessage2 & aMessage | contains the data received from the client |
void | ServiceReplacePluginL | ( | const RMessage2 & | aMessage | ) |
const RMessage2 & aMessage | contains the data received from the client |
void | ServiceRestoreActiveAppConfL | ( | const RMessage2 & | aMessage | ) |
const RMessage2 & aMessage | contains the data received from the client |
void | ServiceRestoreConfigurationsL | ( | const RMessage2 & | aMessage | ) |
const RMessage2 & aMessage | contains the data received from the client |
void | ServiceRestoreDefaultL | ( | const RMessage2 & | aMessage | ) |
const RMessage2 & aMessage | contains the data received from the client |
void | ServiceSetActivePluginL | ( | const RMessage2 & | aMessage | ) |
const RMessage2 & aMessage | contains the data received from the client |
void | ServiceSetActiveThemeL | ( | const RMessage2 & | aMessage | ) |
const RMessage2 & aMessage | contains the data received from the client |
void | ServiceSetConfStateL | ( | const RMessage2 & | aMessage | ) |
const RMessage2 & aMessage | contains the data received from the client |
void | ServiceSetPluginSettingsL | ( | const RMessage2 & | aMessage | ) |
const RMessage2 & aMessage | contains the data received from the client |
void | SetConfStateL | ( | ChspsODT & | aAppODT, |
TInt | aConfId, | |||
ThspsConfigurationState | aState, | |||
ThspsConfStateChangeFilter | aFilter | |||
) | [private] |
ChspsODT & aAppODT | is an instance of the the application configuration |
TInt aConfId | is an ID of the configuration node to be found |
ThspsConfigurationState aState | is a new value of the configuration node state attribute |
ThspsConfStateChangeFilter aFilter |
void | SetServerSession | ( | ChspsThemeServerSession * | aServerSession | ) |
ChspsThemeServerSession * aServerSession |
TInt | UpdatePluginConfigurationL | ( | ChspsODT & | aOdt, |
ChspsODT & | aPluginOdt, | |||
RArray< TInt > & | aPluginIds | |||
) | [private] |
UpdatePluginConfigurationL
void | UpdatePluginFromAppConfsL | ( | ChspsODT & | aOdt, |
RArray< ThspsRepositoryInfo > & | aNotificationParams | |||
) | [private] |
UpdatePluginFromAppConfsL
ChspsODT & aOdt | |
RArray< ThspsRepositoryInfo > & aNotificationParams |
TInt | UpdatePluginListL | ( | ChspsODT & | aAppODT, |
const TInt | aConfigurationId, | |||
const CArrayFixFlat< TInt > & | aPluginIdList | |||
) |
ChspsODT & aAppODT | |
const TInt aConfigurationId | |
const CArrayFixFlat< TInt > & aPluginIdList |
ThspsServiceCompletedMessage | hspsAddPlugin | ( | const | TInt, |
const | TInt, | |||
const | TInt, | |||
const | TInt, | |||
TInt & | ||||
) |
const TInt | |
const TInt | |
const TInt | |
const TInt | |
TInt & |
ThspsServiceCompletedMessage | hspsCancelGetListHeaders | ( | ) |
ThspsServiceCompletedMessage | hspsGetListHeaders | ( | const TDesC8 & | aSearchMaskData, |
CArrayPtrSeg< HBufC8 > & | aHeaderDataList | |||
) |
const TDesC8 & aSearchMaskData | |
CArrayPtrSeg< HBufC8 > & aHeaderDataList |
ThspsServiceCompletedMessage | hspsGetListHeaders | ( | const ChspsODT & | , |
const | TBool, | |||
CArrayPtrFlat< ChspsODT > & | ||||
) |
const ChspsODT & | |
const TBool | |
CArrayPtrFlat< ChspsODT > & |
ThspsServiceCompletedMessage | hspsGetNextHeader | ( | ) |
ThspsServiceCompletedMessage | hspsMovePluginsL | ( | const | TInt, |
const | TInt, | |||
const CArrayFixFlat< TInt > & | ||||
) |
From MhspsMaintenanceService hspsMovePluginsL Not used - see ServiceMovePluginsL instead which has a diffrent input
const TInt | |
const TInt | |
const CArrayFixFlat< TInt > & |
ThspsServiceCompletedMessage | hspsPluginUpdateL | ( | const ChspsODT & | aOdt | ) |
Updates plugin configuration in all application configuration
const ChspsODT & aOdt |
ThspsServiceCompletedMessage | hspsRemovePlugin | ( | const | TInt, |
const | TInt | |||
) |
From MhspsMaintenanceService hspsRemovePlugin Not used - see ServiceRemovePluginL instead which has a diffrent input
const TInt | |
const TInt |
ThspsServiceCompletedMessage | hspsRemoveThemeL | ( | const ChspsODT & | aSetMask | ) |
const ChspsODT & aSetMask | is an ODT-header parametrized enough to express the theme to be removed. |
ThspsServiceCompletedMessage | hspsReplacePlugin | ( | const | TInt, |
const | TInt, | |||
const | TInt | |||
) |
From MhspsMaintenanceService hspsReplacePlugin Not used - see ServiceReplacePluginL instead which has a diffrent input
const TInt | |
const TInt | |
const TInt |
ThspsServiceCompletedMessage | hspsRestoreActiveAppConf | ( | const | TInt, |
const | TInt | |||
) |
From MhspsMaintenanceService hspsRestoreActiveAppConf Not used - see ServiceRestoreActiveAppConfL instead which has a diffrent input
const TInt | |
const TInt |
ThspsServiceCompletedMessage | hspsRestoreDefault | ( | const ChspsODT & | aSetMask, |
ChspsODT & | aHeader | |||
) |
TInt | hspsSavePluginSettingsL | ( | ChspsODT & | aOdt, |
ChspsDomDocument & | aDom | |||
) | [private] |
ChspsODT & aOdt | |
ChspsDomDocument & aDom | is a Dom Document of the settings that is going to saved |
ThspsServiceCompletedMessage | hspsSetActivePlugin | ( | const TInt | aAppUid, |
const TInt | aPluginId | |||
) |
From MhspsMaintenanceService hspsSetActivePlugin Not used - see ServiceRemovePluginL instead which has a diffrent input
ThspsServiceCompletedMessage | hspsSetActiveTheme | ( | const ChspsODT & | aSetMask, |
ChspsODT & | aOdt | |||
) |
const ChspsODT & aSetMask | represents parameters by which the new theme activation will be done. There must be sufficient set of parameters presented, at least a theme UID. |
ChspsODT & aOdt | is 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. |
ThspsServiceCompletedMessage | hspsSetActiveTheme | ( | const TDesC8 & | , |
TDes8 & | ||||
) |
ThspsServiceCompletedMessage | hspsSetConfState | ( | const | TInt, |
const | TInt, | |||
const | ThspsConfigurationState, | |||
const | ThspsConfStateChangeFilter | |||
) |
From MhspsMaintenanceService hspsSetConfState Not used - see ServiceSetConfStateL instead which has a diffrent input
const TInt | |
const TInt | |
const ThspsConfigurationState | |
const ThspsConfStateChangeFilter |
ThspsServiceCompletedMessage | hspsSetPluginSettings | ( | const ChspsODT & | , |
const | TInt, | |||
ChspsDomDocument & | , | |||
const | TBool | |||
) |
From MhspsMaintenanceService hspsSetSettings Not used - see ServiceRemovePluginL instead which has a diffrent input
const ChspsODT & | |
const TInt | |
ChspsDomDocument & | |
const TBool |
TInt | hspsSetPluginSettingsL | ( | ChspsODT & | aOdt, |
TInt | aPluginId, | |||
ChspsDomDocument & | aDom | |||
) | [private] |
ChspsODT & aOdt | is an instance of the the application configuration |
TInt aPluginId | is an ID of the plugin instance to be found |
ChspsDomDocument & aDom | is a Dom Document of the settings that is going to set/update |
ThspsServiceCompletedMessage | iCompletedMessage | [private] |
ChspsDefinitionRepository & | iDefinitionRepository | [private] |
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.