MSenConsumerPolicy Class Reference

API published in: S60 3rd Ed

Link against: senservdesc.lib

Capability Information

Required Capabilities

NetworkServices ReadUserData WriteUserData

#include <msenconsumerpolicy.h>

Inherited by CSenServicePattern.

Detailed Description

This abstract class defines consumer policy interface.

The consumer policy sets the conditions in which some service provider is capable to operate in. It is defining context, through which these (possibly remote) services may be contacted and used. The actual properties may include transport layer settings, like predefined Internet Access Point (IAP) ID. In addition, consumer policy may declare, that certain service should only be contacted using certain identity provider (in ID-WSF). This can be achieved by mapping certain list of IDP IDs to a consumer policy. A consumer policy is effective only for a single session, and thus it applies to one service connection only. This means, that this policy information is "private", and not shared between different WSC applications using WSF, event hough they might be using the same (remote) service at the same time. Consumer policy properties are not serialized in any WSF database, but resides in memory only.

Example structure of ConsumerPolicy XML fragment:

<ConsumerPolicy> <Transport> <IapId> 2 </IapId> </Transport> <IdentityProviderIDs strict="false"> <IdentityProviderID> urn:first.example.idp.com </IdentityProviderID> <IdentityProviderID> urn:second.example.idp.com </IdentityProviderID> </IdentityProviderIDs> </ConsumerPolicy>


Public Member Functions
virtual void  SetConsumerIapIdL (TUint32 aIapId)=0
  Setter for Internet Access Point (IAP) ID existing in CommDB.
virtual TInt  ConsumerIapId (TUint32 &aCurrentIapId)=0
  Getter for IAP ID.
virtual void  SetConsumerIdentityProviderIdsL (CSenIdentityProviderIdArray8 &aList)=0
  Setter for consumer identity provider IDs.
virtual TInt  AddConsumerIdentityProviderIdL (const TDesC8 &aProviderId)=0
  Adds a new Identity provider ID value at the end of the current list values.
virtual TInt  RebuildFromConsumerPolicy (MSenConsumerPolicy &aTemplate)=0
  Rebuilds the consumer policy of this service pattern from the given consumer policy.
virtual const CSenIdentityProviderIdArray8 &  ConsumerIdentityProviderIds8L ()=0
  Getter for Identity provider IDs.
virtual TBool  AcceptsConsumerPolicy (MSenConsumerPolicy &aPolicyPattern)=0
  Checks if the policy of this service pattern accepts given policy.

Member Function Documentation

virtual TBool MSenConsumerPolicy::AcceptsConsumerPolicy (  MSenConsumerPolicy &  aPolicyPattern  )  [pure virtual]
 

Checks if the policy of this service pattern accepts given policy.

Parameters:
aPolicyPattern  the consumer policy to check.
Returns:
ETrue if accepts, EFalse if not

Implemented in CSenServicePattern.

virtual TInt MSenConsumerPolicy::AddConsumerIdentityProviderIdL (  const TDesC8 &  aProviderId  )  [pure virtual]
 

Adds a new Identity provider ID value at the end of the current list values.

Parameters:
aProviderId  unique ProviderID as UTF-8 descriptor
Returns:
KErrAlreadyExists, if a duplicate is tried to add KErrArgument if a zero-length descriptor is tried to add (aProviderId.Length() == 0)

Implemented in CSenServicePattern.

virtual TInt MSenConsumerPolicy::ConsumerIapId (  TUint32 &  aCurrentIapId  )  [pure virtual]
 

Getter for IAP ID.

Parameters:
aCurrentIapId  will contain the current Internet Access Point ID
Returns:
  • KErrNone if <IapId> element is found and has valid content
  • KErrNotFound if no <IapId> element has been found or it has no content
  • TLex error codes, if <IapId> element has non-numeric value, which cannot be resolved

Implemented in CSenServicePattern.

virtual const CSenIdentityProviderIdArray8& MSenConsumerPolicy::ConsumerIdentityProviderIds8L (   )  [pure virtual]
 

Getter for Identity provider IDs.

Returns:
a list of IDP arrays if such value(s) have been set or an empty array if no IDP:s have been specified.

Implemented in CSenServicePattern.

virtual TInt MSenConsumerPolicy::RebuildFromConsumerPolicy (  MSenConsumerPolicy &  aTemplate  )  [pure virtual]
 

Rebuilds the consumer policy of this service pattern from the given consumer policy.

Parameters:
aTemplate  the consumer policy to rebuild from.
Returns:
KErrNone or other system-wide Symbian error codes.

Implemented in CSenServicePattern.

virtual void MSenConsumerPolicy::SetConsumerIapIdL (  TUint32  aIapId  )  [pure virtual]
 

Setter for Internet Access Point (IAP) ID existing in CommDB.

Parameters:
aIapId  IAP ID

Implemented in CSenServicePattern.

virtual void MSenConsumerPolicy::SetConsumerIdentityProviderIdsL (  CSenIdentityProviderIdArray8 &  aList  )  [pure virtual]
 

Setter for consumer identity provider IDs.

Overrides current values with the given values from the array. If an ID does not exist, it will be added.

Parameters:
aList  list of identity provider IDs.

Implemented in CSenServicePattern.

The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top