MSenProviderPolicy Class Reference

API published in: S60 3rd Ed

Link against: senservdesc.lib

Capability Information

Required Capabilities

NetworkServices ReadUserData WriteUserData

#include <msenproviderpolicy.h>

Inherited by CSenXmlServiceDescription.

Detailed Description

This abstract class defines provider policy interface.

The provider 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, provider 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 provider policy. Provider Policies are WSF wide settings, which are stored in WSF databases, and thus they are shared with all the actual Web Service Consumers (WSCs) accessing same services.

Example structure of ProviderPolicy XML fragment:

<ProviderPolicy> <Transport> <IapId> 1 </IapId> </Transport> <IdentityProviderIDs strict="true"> <IdentityProviderID> urn:first.id.example.com </IdentityProviderID> <IdentityProviderID> urn:second.id.example.com </IdentityProviderID> </IdentityProviderIDs> </ProviderPolicy>


Public Member Functions
virtual void  SetIapIdL (TUint32 aIapId)=0
  Setter for Internet Access Point (IAP) ID.
virtual TInt  IapId (TUint32 &aCurrentIapId)=0
  Getter for IAP ID.
virtual void  SetIdentityProviderIdsL (CSenIdentityProviderIdArray8 &aList)=0
  Setter for IdentityProvider IDs.
virtual TInt  AddIdentityProviderIdL (TDesC8 &aProviderId)=0
  Adds a new IdentityProviderID value at the end of the current list values.
virtual TInt  RebuildFrom (MSenProviderPolicy &aTemplate)=0
  Method reads provider policy class instance values from given template.
virtual const CSenIdentityProviderIdArray8 &  IdentityProviderIds8L ()=0
  Getter for IdentityProvider IDs.
virtual TBool  Accepts (MSenProviderPolicy &aPolicyPattern)=0
  Checks if some policy is accepted by current policy.

Member Function Documentation

virtual TBool MSenProviderPolicy::Accepts (  MSenProviderPolicy &  aPolicyPattern  )  [pure virtual]
 

Checks if some policy is accepted by current policy.

Parameters:
aPolicyPattern  is the policy being compared with this instance.
Returns:
ETrue if policy candidate is accepted by current policy definition, EFalse if not.

Implemented in CSenXmlServiceDescription.

virtual TInt MSenProviderPolicy::AddIdentityProviderIdL (  TDesC8 &  aProviderId  )  [pure virtual]
 

Adds a new IdentityProviderID value at the end of the current list values.

Parameters:
aProviderID  defines, which IdentityProvider is preferred OR which is strictly acceptable one, when initiating a new service connection.
Returns:
KErrAlreadyExists, if a duplicate is tried to add KErrArgument if a zero-length descriptor is tried to add (aProviderId.Length() == 0)

Implemented in CSenXmlServiceDescription.

virtual TInt MSenProviderPolicy::IapId (  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 CSenXmlServiceDescription.

virtual const CSenIdentityProviderIdArray8& MSenProviderPolicy::IdentityProviderIds8L (   )  [pure virtual]
 

Getter for IdentityProvider 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 CSenXmlServiceDescription.

virtual TInt MSenProviderPolicy::RebuildFrom (  MSenProviderPolicy &  aTemplate  )  [pure virtual]
 

Method reads provider policy class instance values from given template.

Values may include an IAP ID, preferred IdentityProvider IDs etc.

Parameters:
aTemplate  from which the values are read.
Returns:
KErrNone Everything went ok. KErrAlreadyExists Duplicates were found KErrArgument Invalid providerIds were found Other error codes are system-wide Symbian error codes.

Implemented in CSenXmlServiceDescription.

virtual void MSenProviderPolicy::SetIapIdL (  TUint32  aIapId  )  [pure virtual]
 

Setter for Internet Access Point (IAP) ID.

Method is used to define default access point to avoid IAP selection dialog prompt.

Parameters:
aIapId  is the ID found from CommDB.

Implemented in CSenXmlServiceDescription.

virtual void MSenProviderPolicy::SetIdentityProviderIdsL (  CSenIdentityProviderIdArray8 &  aList  )  [pure virtual]
 

Setter for IdentityProvider IDs.

Overrides current values with the given values from the array. When initiating a new service connection, this list of ProviderIDs define, which IdentityProviders are preferred OR which are strictly acceptable ones.

Parameters:
aList  list of IdentityProvider IDs.

Implemented in CSenXmlServiceDescription.

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