MSenConsumerPolicy Class Reference

class MSenConsumerPolicy

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 though 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>

SenServDesc.lib
Since
Series60 3.0

Member Functions Documentation

AcceptsConsumerPolicy(MSenConsumerPolicy &)

TBool AcceptsConsumerPolicy ( MSenConsumerPolicy & aPolicyPattern ) [pure virtual]
Checks if the policy of this service pattern accepts given policy.
Since
Series60 3.0

Parameters

MSenConsumerPolicy & aPolicyPattern the consumer policy to check.

AddConsumerIdentityProviderIdL(const TDesC8 &)

TInt AddConsumerIdentityProviderIdL ( const TDesC8 & aProviderId ) [pure virtual]
Adds a new Identity provider ID value at the end of the current list values.
Since
Series60 3.0

Parameters

const TDesC8 & aProviderId unique ProviderID as UTF-8 descriptor

ConsumerIapId(TUint32 &)

TInt ConsumerIapId ( TUint32 & aCurrentIapId ) [pure virtual]
Getter for IAP ID.
Since
Series60 3.0

Parameters

TUint32 & aCurrentIapId will contain the current Internet Access Point ID

ConsumerIdentityProviderIds8L()

const CSenIdentityProviderIdArray8 & ConsumerIdentityProviderIds8L ( ) [pure virtual]
Getter for Identity provider IDs.
Since
Series60 3.0

RebuildFromConsumerPolicy(MSenConsumerPolicy &)

TInt RebuildFromConsumerPolicy ( MSenConsumerPolicy & aTemplate ) [pure virtual]
Rebuilds the consumer policy of this service pattern from the given consumer policy.
Since
Series60 3.0

Parameters

MSenConsumerPolicy & aTemplate the consumer policy to rebuild from.

SetConsumerIapIdL(TUint32)

void SetConsumerIapIdL ( TUint32 aIapId ) [pure virtual]
Setter for Internet Access Point (IAP) ID existing in CommDB.
Since
Series60 3.0

Parameters

TUint32 aIapId IAP ID

SetConsumerIdentityProviderIdsL(CSenIdentityProviderIdArray8 &)

void 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.
Since
Series60 3.0

Parameters

CSenIdentityProviderIdArray8 & aList list of identity provider IDs.