Collapse all Symbian^3 Product Developer Library

CSenPolicy Class Reference

class CSenPolicy : public CSenDomFragment

Example structure of Policy XML fragment: <Policy>

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

</Policy>

Inherits from

CSenPolicy
- CSenDomFragment
  - CSenBaseFragment
    - CSenFragment
      - CBase

Public Member Functions
	~CSenPolicy()
IMPORT_C TBool	Accepts(MSenPolicy &)
IMPORT_C TInt	AddIdentityProviderIdL(const TDesC8 &)
IMPORT_C TInt	IapId(TUint32 &)
IMPORT_C const CSenIdentityProviderIdArray8 &	IdentityProviderIds8L()
IMPORT_C CSenPolicy *	NewL()
IMPORT_C CSenPolicy *	NewL(TUint32)
IMPORT_C CSenPolicy *	NewL(TUint32, TBool)
IMPORT_C CSenPolicy *	NewLC()
IMPORT_C CSenPolicy *	NewLC(TUint32)
IMPORT_C CSenPolicy *	NewLC(TUint32, TBool)
IMPORT_C TInt	RebuildFrom(MSenPolicy &)
IMPORT_C void	SetIapIdL(TUint32)
IMPORT_C void	SetIdentityProviderIdsL(CSenIdentityProviderIdArray8 &)
IMPORT_C void	SetSnapIdL(TUint32)
IMPORT_C TInt	SnapId(TUint32 &)

Protected Member Functions
	CSenPolicy()
IMPORT_C void	BaseConstructL(const TDesC8 &)
IMPORT_C void	BaseConstructL(const TDesC8 &, TUint32)
IMPORT_C void	BaseConstructL(const TDesC8 &, TUint32, TBool)

Private Member Functions
TBool	AcceptsL(MSenPolicy &)
TInt	RebuildFromL(MSenPolicy &)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	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()
	CSenBaseFragment::AllocContentSaverL()
	CSenBaseFragment::AsElement()
	CSenBaseFragment::AsXmlL()
	CSenBaseFragment::AsXmlUnicodeL()
	CSenBaseFragment::BuildFrom(const TDesC8 &)
	CSenBaseFragment::CSenBaseFragment()
	CSenBaseFragment::ConsistsOfL(MSenFragment &)
	CSenBaseFragment::Content()
	CSenBaseFragment::ContentOf(const TDesC8 &)
	CSenBaseFragment::DelegateParsingL(MSenFragment &)
	CSenBaseFragment::DelegateParsingL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &)
	CSenBaseFragment::DetachL()
	CSenBaseFragment::EndElementL(const TDesC8 &,const TDesC8 &,const TDesC8 &)
	CSenBaseFragment::EnsureNamespace(const TDesC8 &)
	CSenBaseFragment::ExtractElement()
	CSenBaseFragment::LocalName()const
	CSenBaseFragment::Namespace(const TDesC8 &)
	CSenBaseFragment::NsPrefix()const
	CSenBaseFragment::NsUri()const
	CSenBaseFragment::ParseL(const TDesC8 &)
	CSenBaseFragment::Reader()
	CSenBaseFragment::ResetContentL()
	CSenBaseFragment::SaveNamespacesL(const RAttributeArray &,TBool)
	CSenBaseFragment::SetContentOfL(const TDesC8 &,const TDesC8 &)
	CSenBaseFragment::SetOwner(MSenFragment &)
	CSenBaseFragment::SetReader(CSenXmlReader &)
	CSenBaseFragment::StartEntity(TDesC8 &)
	CSenBaseFragment::WriteAsXMLToL(RWriteStream &)
	CSenBaseFragment::~CSenBaseFragment()
	CSenDomFragment::BaseConstructL(CSenXmlReader &)
	CSenDomFragment::BaseConstructL(const CSenElement &)
	CSenDomFragment::BaseConstructL(const TDesC8 &,const TDesC8 &)
	CSenDomFragment::BaseConstructL(const TDesC8 &,const TDesC8 &,const TDesC8 &)
	CSenDomFragment::BaseConstructL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &)
	CSenDomFragment::BaseConstructL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &,CSenElement &)
	CSenDomFragment::CSenDomFragment()
	CSenDomFragment::CharactersL(const TDesC8 &,TInt,TInt)
	CSenDomFragment::ExpandL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &)
	CSenDomFragment::NewL(const CSenElement &)
	CSenDomFragment::NewL(const TDesC8 &)
	CSenDomFragment::NewL(const TDesC8 &,const TDesC8 &)
	CSenDomFragment::NewL(const TDesC8 &,const TDesC8 &,const TDesC8 &)
	CSenDomFragment::NewL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &)
	CSenDomFragment::NewL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &,CSenElement &)
	CSenDomFragment::ParseWithL(CSenXmlReader &)
	CSenDomFragment::ResumeParsingFromL(const TDesC8 &,const TDesC8 &,const TDesC8 &)
	CSenDomFragment::SetAttributesL(const RAttributeArray &)
	CSenDomFragment::StartElementL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &)
	CSenDomFragment::WriteEndElementL(const TDesC8 &,const TDesC8 &,const TDesC8 &)
	CSenDomFragment::WriteStartElementL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &)
	CSenDomFragment::~CSenDomFragment()

Private Attributes
CSenIdentityProviderIdArray8 *	iIdpIdList

Inherited Attributes
	CSenBaseFragment::iState
	CSenBaseFragment::iWs
	CSenBaseFragment::iXmlReader
	CSenBaseFragment::ipElement
	CSenBaseFragment::ipOwner
	CSenDomFragment::ipDomDelegate

Constructor & Destructor Documentation

CSenPolicy()

CSenPolicy

(

)

[protected]

C++ default constructor.

~CSenPolicy()

~CSenPolicy

(

)

[virtual]

Destructor

Member Functions Documentation

Accepts(MSenPolicy &)

IMPORT_C TBool

Accepts

(

MSenPolicy &

aPolicyPattern

)

[virtual]

Checks if policies match.

Parameters

MSenPolicy & aPolicyPattern

the policy to match

AcceptsL(MSenPolicy &)

TBool

AcceptsL

(

MSenPolicy &

aPolicyPattern

)

[private]

Leaving variants of the functions.

Parameters

MSenPolicy & aPolicyPattern

AddIdentityProviderIdL(const TDesC8 &)

IMPORT_C TInt

AddIdentityProviderIdL

(

const TDesC8 &

aProviderId

)

[virtual]

Adds a new Identity provider ID value at the end of the current list values Checks for duplicate (does not insert new ID elements with equal content)

Parameters

const TDesC8 & aProviderId

BaseConstructL(const TDesC8 &)

IMPORT_C void

BaseConstructL

(

const TDesC8 &

aLocalName

)

[protected]

By default Symbian 2nd phase constructor is private.

Parameters

const TDesC8 & aLocalName

BaseConstructL(const TDesC8 &, TUint32)

IMPORT_C void	BaseConstructL	(	const TDesC8 &	aLocalName,
			TUint32	aIapId
		)	[protected]

Parameters

const TDesC8 & aLocalName
TUint32 aIapId

BaseConstructL(const TDesC8 &, TUint32, TBool)

IMPORT_C void	BaseConstructL	(	const TDesC8 &	aLocalName,
			TUint32	aId,
			TBool	aIsSnapId
		)	[protected]

Parameters

const TDesC8 & aLocalName
TUint32 aId
TBool aIsSnapId

IapId(TUint32 &)

IMPORT_C TInt

IapId

(

TUint32 &

aCurrentIapId

)

[virtual]

Getter for IAP ID.

Parameters

TUint32 & aCurrentIapId

will contain the current Internet Access Point ID Max value for IAP ID is 2147483647

IdentityProviderIds8L()

IMPORT_C const CSenIdentityProviderIdArray8 &

IdentityProviderIds8L

(

)

[virtual]

Getter for IdentityProvider IDs.

Since: Series60 3.0

NewL()

IMPORT_C CSenPolicy *

NewL

(

)

[static]

Two-phased constructors. These parameterless constructors are ment to be used for example before parsing XML stream.

NewL(TUint32)

IMPORT_C CSenPolicy *

NewL

(

TUint32

aIapId

)

[static]

Parameters

TUint32 aIapId

NewL(TUint32, TBool)

IMPORT_C CSenPolicy *	NewL	(	TUint32	aId,
			TBool	aIsSnapId
		)	[static]

Parameters

TUint32 aId
TBool aIsSnapId

NewLC()

IMPORT_C CSenPolicy *

NewLC

(

)

[static]

NewLC(TUint32)

IMPORT_C CSenPolicy *

NewLC

(

TUint32

aIapId

)

[static]

Parameters

TUint32 aIapId

NewLC(TUint32, TBool)

IMPORT_C CSenPolicy *	NewLC	(	TUint32	aId,
			TBool	aIsSnapId
		)	[static]

Parameters

TUint32 aId
TBool aIsSnapId

RebuildFrom(MSenPolicy &)

IMPORT_C TInt

RebuildFrom

(

MSenPolicy &

aTemplate

)

[virtual]

Method reads provider policy class instance values from given template. Values may include an IAP ID, preferred IdentityProvider IDs etc.

Since: Series60 3.0

Parameters

MSenPolicy & aTemplate

from which the values are read.

RebuildFromL(MSenPolicy &)

TInt

RebuildFromL

(

MSenPolicy &

aTemplate

)

[private]

Parameters

MSenPolicy & aTemplate

SetIapIdL(TUint32)

IMPORT_C void

SetIapIdL

(

TUint32

aIapId

)

[virtual]

Setter for Internet Access Point (IAP) ID. Method is used to define default access point to avoid IAP selection dialog prompt.

Since: Series60 3.0

Parameters

TUint32 aIapId

is the ID found from CommDB.

SetIdentityProviderIdsL(CSenIdentityProviderIdArray8 &)

IMPORT_C void

SetIdentityProviderIdsL

(

CSenIdentityProviderIdArray8 &

aList

)

[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.

Since: Series60 3.0

Parameters

CSenIdentityProviderIdArray8 & aList

list of IdentityProvider IDs.

SetSnapIdL(TUint32)

IMPORT_C void

SetSnapIdL

(

TUint32

aSnapId

)

[virtual]

Sets the SnapId

Parameters

TUint32 aSnapId

snap id

SnapId(TUint32 &)

IMPORT_C TInt

SnapId

(

TUint32 &

aCurrentSnapId

)

[virtual]

Gets the SnapId

Parameters

TUint32 & aCurrentSnapId

snap id

Member Data Documentation

CSenIdentityProviderIdArray8 * iIdpIdList

CSenIdentityProviderIdArray8 *

iIdpIdList

[private]