CSenXmlServiceDescription Class Reference
class CSenXmlServiceDescription : public CSenDomFragment |
CSenXmlServiceDescription class implements the most common value object used in WSF, which is used to describe some invocable service.
Class offers basic properties which describe some service and methods to manipulate this info. These properties are stored in XML fragment format and a class instance can be represented as one XML tree.
The main properties for service description are:
SenServDesc.lib
- Since
- Series60 3.0
Inherits from
- CSenXmlServiceDescription
Public Member Functions |
---|
| ~CSenXmlServiceDescription() |
IMPORT_C TBool | Accepts(MSenProviderPolicy &) |
IMPORT_C TInt | AddFacetL(const CSenFacet &) |
IMPORT_C TInt | AddIdentityProviderIdL(TDesC8 &) |
IMPORT_C HBufC8 * | AsXmlL() |
IMPORT_C HBufC * | AsXmlUnicodeL() |
IMPORT_C TPtrC8 | Contract() |
IMPORT_C RCredentialList & | Credentials() |
IMPORT_C TDescriptionClassType | DescriptionClassType() |
IMPORT_C TPtrC8 | Endpoint() |
IMPORT_C TInt | FacetValue(TDesC8 &, HBufC8 *&) |
IMPORT_C TInt | FacetsL(RFacetArray &) |
IMPORT_C TPtrC8 | FrameworkId() |
IMPORT_C TPtrC8 | FrameworkVersion() |
IMPORT_C TBool | HasEqualPrimaryKeysL(MSenServiceDescription &) |
IMPORT_C TInt | HasFacetL(const TDesC8 &, TBool &) |
IMPORT_C TInt | IapId(TUint32 &) |
IMPORT_C const CSenIdentityProviderIdArray8 & | IdentityProviderIds8L() |
IMPORT_C TBool | IsLocalL() |
IMPORT_C TBool | Matches(MSenServiceDescription &) |
IMPORT_C const TDesC8 & | NewElementName() |
IMPORT_C CSenXmlServiceDescription * | NewL() |
IMPORT_C CSenXmlServiceDescription * | NewL(const TDesC8 &) |
IMPORT_C CSenXmlServiceDescription * | NewL(const TDesC8 &, const TDesC8 &) |
IMPORT_C CSenXmlServiceDescription * | NewLC() |
IMPORT_C CSenXmlServiceDescription * | NewLC(const TDesC8 &) |
IMPORT_C CSenXmlServiceDescription * | NewLC(const TDesC8 &, const TDesC8 &) |
IMPORT_C TBool | PromptUserInfo() |
IMPORT_C TPtrC8 | ProviderId() |
IMPORT_C TInt | RebuildFrom(MSenProviderPolicy &) |
IMPORT_C TInt | RemoveFacet(const TDesC8 &) |
IMPORT_C void | ResumeParsingFromL(const TDesC8 &, const TDesC8 &, const TDesC8 &) |
IMPORT_C TInt | ScoreMatchL(MSenServiceDescription &) |
IMPORT_C MSenServicePolicy * | ServicePolicy() |
IMPORT_C void | SetAttributesL(const RAttributeArray &) |
IMPORT_C void | SetContractL(const TDesC8 &) |
IMPORT_C void | SetEndPointL(const TDesC8 &) |
IMPORT_C TInt | SetFacetL(const CSenFacet &) |
IMPORT_C void | SetFrameworkIdL(const TDesC8 &) |
IMPORT_C void | SetIapIdL(TUint32) |
IMPORT_C void | SetIdentityProviderIdsL(CSenIdentityProviderIdArray8 &) |
IMPORT_C TInt | SetPolicyL(const TDesC8 &) |
IMPORT_C TInt | SetPolicyL(const TDesC8 &, const TDesC8 &) |
IMPORT_C TInt | SetPolicyL(const TDesC8 &, const TDesC8 &, const TDesC8 &, const TDesC8 &) |
IMPORT_C void | SetPromptUserInfoL(TBool) |
IMPORT_C TInt | SetProviderIdL(const TDesC8 &) |
IMPORT_C void | SetSnapIdL(TUint32) |
IMPORT_C TInt | SetTransportCueL(const TDesC8 &) |
IMPORT_C TInt | SetTransportPropertiesL(const TDesC8 &) |
IMPORT_C TInt | SnapId(TUint32 &) |
IMPORT_C TPtrC8 | TransportCue() |
IMPORT_C TInt | TransportPropertiesL(HBufC8 *&) |
IMPORT_C void | WriteAsXMLToL(RWriteStream &) |
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::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::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::~CSenBaseFragment() |
| CSenDomFragment::BaseConstructL(CSenXmlReader &) |
| CSenDomFragment::BaseConstructL(const CSenElement &) |
| CSenDomFragment::BaseConstructL(const TDesC8 &) |
| 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 &,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::WriteEndElementL(const TDesC8 &,const TDesC8 &,const TDesC8 &) |
| CSenDomFragment::WriteStartElementL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &) |
| CSenDomFragment::~CSenDomFragment() |
Protected Attributes |
---|
const TDescriptionClassType | iType |
Constructor & Destructor Documentation
CSenXmlServiceDescription(TDescriptionClassType)
IMPORT_C | CSenXmlServiceDescription | ( | TDescriptionClassType | aType | ) | [protected] |
Parameters
TDescriptionClassType aType | enumeration defining the type of this class. |
~CSenXmlServiceDescription()
IMPORT_C | ~CSenXmlServiceDescription | ( | ) | [virtual] |
Member Functions Documentation
Accepts(MSenProviderPolicy &)
AddFacetL(const CSenFacet &)
AddIdentityProviderIdL(TDesC8 &)
IMPORT_C TInt | AddIdentityProviderIdL | ( | TDesC8 & | aProviderId | ) | [virtual] |
AsXmlL()
IMPORT_C HBufC8 * | AsXmlL | ( | ) | [virtual] |
Gets the service description as XML fragment in UTF-8 format.
- Since
- Series60 3.0
AsXmlUnicodeL()
IMPORT_C HBufC * | AsXmlUnicodeL | ( | ) | [virtual] |
Gets the service description as XML, in Unicode (UCS-2)
- Since
- Series60 3.0
ConstructL()
IMPORT_C void | ConstructL | ( | ) | [protected] |
Basic ConstructL function.
ConstructL(const TDesC8 &)
IMPORT_C void | ConstructL | ( | const TDesC8 & | aNamespaceURI | ) | [protected] |
Basic ConstructL function.
- Since
- Series60 3.0
Parameters
const TDesC8 & aNamespaceURI | for this service description, which is also an XML element. |
ConstructL(const TDesC8 &, const TDesC8 &)
IMPORT_C void | ConstructL | ( | const TDesC8 & | aEndPoint, |
| const TDesC8 & | aContract |
| ) | [protected] |
Basic ConstructL function.
- Since
- Series60 3.0
Parameters
const TDesC8 & aEndPoint | |
const TDesC8 & aContract | identifies the service type, typically some URN. |
Credentials()
Returns list of credentials. Ownership is not transferred, any modifications to the contents of the list modify the real objects.
- Since
- Series60 3.0
DescriptionClassType()
IMPORT_C TDescriptionClassType | DescriptionClassType | ( | ) | |
EndElementL(const TDesC8 &, const TDesC8 &, const TDesC8 &)
IMPORT_C void | EndElementL | ( | const TDesC8 & | aNsUri, |
| const TDesC8 & | aLocalName, |
| const TDesC8 & | aQName |
| ) | [protected, virtual] |
Callback function which implement the XML content handler interface.
- Since
- Series60 3.0
Parameters
const TDesC8 & aNsUri | The namespace URI of the new element |
const TDesC8 & aLocalName | The local name of the new element |
const TDesC8 & aQName | The qualified name of the new element |
FacetValue(TDesC8 &, HBufC8 *&)
FacetValueL(TDesC8 &, HBufC8 *&)
FrameworkVersion()
IMPORT_C TPtrC8 | FrameworkVersion | ( | ) | |
HasEqualPrimaryKeysL(MSenServiceDescription &)
Method returns ETrue if the primary keys of this service description are equal. Definition of primary keys varies on concrete implementations.
In a typical XML sub class implementation the primary keys are Contract and Endpoint elements.
Difference to Match() method is that primary keys - often descriptors - MUST be equal both in this service description and in aCandidate, unlike in Match(), where argument is more like wildcard pattern matching even in cases where it includes fewer fields (less information).
Parameters
MSenServiceDescription & aCandidate | is a service description, which primary keys are checked in this comparison. |
HasFacetL(const TDesC8 &, TBool &)
Method for checking if service description has a certain facet.
- Since
- Series60 3.0
Parameters
const TDesC8 & aURI | the facet to check, typically some URI. |
TBool & aHasFacet | is ETrue if facet is found and EFalse, if not. |
Matches(MSenServiceDescription &)
NewElementName()
IMPORT_C const TDesC8 & | NewElementName | ( | ) | [virtual] |
Method returns the localname for this service description. This is the localname of the element, when this class is represented as an XML element.
- Since
- Series60 3.0
NewL()
Standard 2 phase constructor
NewL(const TDesC8 &)
Standard 2 phase constructor
Parameters
const TDesC8 & aNamespaceURI | namespace URI for the service description. |
NewL(const TDesC8 &, const TDesC8 &)
Standard 2 phase constructors
Parameters
const TDesC8 & aEndPoint | |
const TDesC8 & aContract | identifies the service type. |
NewLC()
Standard 2 phase constructor
NewLC(const TDesC8 &)
Standard 2 phase constructor
Parameters
const TDesC8 & aNamespaceURI | namespace URI for the service description. |
NewLC(const TDesC8 &, const TDesC8 &)
Standard 2 phase constructors
Parameters
const TDesC8 & aEndPoint | |
const TDesC8 & aContract | identifies the service type. |
PromptUserInfo()
IMPORT_C TBool | PromptUserInfo | ( | ) | |
Getter for current userinfo mode (KSenAttrPromptUserInfo attribute).
ProviderId()
Getter for (identity) provider ID
- Since
- Series60 5.0
RebuildFrom(MSenProviderPolicy &)
RemoveFacet(const TDesC8 &)
IMPORT_C TInt | RemoveFacet | ( | const TDesC8 & | aURI | ) | [virtual] |
RemoveFacetL(const TDesC8 &)
ResumeParsingFromL(const TDesC8 &, const TDesC8 &, const TDesC8 &)
IMPORT_C void | ResumeParsingFromL | ( | const TDesC8 & | aNsUri, |
| const TDesC8 & | aLocalName, |
| const TDesC8 & | aQName |
| ) | [virtual] |
Resumes the parsing. Called by the delegate fragment in order to notify owner, which needs to regain (take over) parsing. For example, when a policy fragment is parsed, the service description fragment should resume parsing the rest of its own XML document representation.
- Since
- Series60 3.0
Parameters
const TDesC8 & aNsUri | The namespace URI of the current element |
const TDesC8 & aLocalName | The local name of the current element |
const TDesC8 & aQName | The qualified name of the current element |
ScoreMatchL(MSenServiceDescription &)
On success, this method returns a positive integer if this service description matches with the given pattern in at least one aspect. Higher numbers mean a closer match.
The bits of information that are in the pattern are read and compared to corresponding fields in this ServiceDescription. Note that a pattern may have far fewer fields and that only the non-null fields are compared. For example, assume that a pattern with only a contract was defined; with the contract set to "urn:example.com:service". Each ServiceDescription with the same contract will match the pattern, even if such a ServiceDescription has non-null fields for other aspects.
- Since
- Series60 3.0
ServicePolicy()
Getter for (web) service policy
SetAttributesL(const RAttributeArray &)
Method looks for FrameworkID attribute from the given XML attribute array and if one is found, sets its value for this instance. In addition, all the namespace attributes are copied. All other attributes are discarded.
- Since
- Series60 3.0
SetContractL(const TDesC8 &)
IMPORT_C void | SetContractL | ( | const TDesC8 & | aContract | ) | |
SetEndPointL(const TDesC8 &)
IMPORT_C void | SetEndPointL | ( | const TDesC8 & | aEndPoint | ) | |
SetFacetL(const CSenFacet &)
SetFrameworkIdL(const TDesC8 &)
IMPORT_C void | SetFrameworkIdL | ( | const TDesC8 & | aFrameworkID | ) | |
Setter for the framework ID. The developer may use a FrameworkID to search for a session of (i.e. connection to) a certain service invocation framework.
- Since
- Series60 3.0
SetIapIdL(TUint32)
IMPORT_C void | SetIapIdL | ( | TUint32 | aIapId | ) | [virtual] |
SetIdentityProviderIdsL(CSenIdentityProviderIdArray8 &)
SetPolicyL(const TDesC8 &)
Method provides convenient way to add a new value in Client Policy This method will add elements such as <SOAP12> or <UsernameTokenOverTLS> in the Policy to be used by stack. Infact this method adds a new element in xml representation of ServicePolicy.
Parameters
const TDesC8 & aName | is the Name of the attribute. |
SetPolicyL(const TDesC8 &, const TDesC8 &)
Method provides convenient way to add a new value in Client Policy This method will add elements such as <Addressing> in the Policy to be used by stack. Infact this method adds a new element in xml representation of ServicePolicy and adds its value as contents of the element. <Addressing>http://schemas.xmlsoap.org/ws/2004/03/addressing</Addressing>
Parameters
const TDesC8 & aName | is the Name of the Policy attribute. |
const TDesC8 & aValue | is the Contents of the Policy attribute. |
SetPolicyL(const TDesC8 &, const TDesC8 &, const TDesC8 &, const TDesC8 &)
Method provides convenient way to add a new value in Client Policy This method will add elements such as <Addressing> in the Policy to be used by stack, plus it will add one specified attribute (name and value) for that element. Infact this method adds a new element - and it's attribute - in the xml representation of ServicePolicy element, which is direct child to ServiceDescription (root element) document. <MetadataEndpoint method="GET">http://www.mypolicyendpoint.com/policy2/</MetadataEndpoint>
Parameters
const TDesC8 & aName | is the Name of the Policy attribute. |
const TDesC8 & aValue | is the Contents of the Policy attribute. |
const TDesC8 & aAttribName | is the Name of the attribute in element aName |
const TDesC8 & aAttribValue | is the Contents of the aAttribName attribute. |
SetPromptUserInfoL(TBool)
IMPORT_C void | SetPromptUserInfoL | ( | TBool | aPromptUserInfoMode | ) | |
Setter for userinfo (KSenAttrPromptUserInfo) attribute, which
Parameters
TBool aPromptUserInfoMode | EFalse dictates that an error must be returned when creating a service connection and userinfo is not accepted by (remote) authentication, instead of showing the dialog. ETrue (or if attribute does not exist in this XML SD) means that end-user should be prompted (default behaviour). The number of retry attempts (each showing a dialog) is service invocation framework spesific; typically 3 retries are permitted. |
SetProviderIdL(const TDesC8 &)
IMPORT_C TInt | SetProviderIdL | ( | const TDesC8 & | aProviderID | ) | |
Setter for (identity) provider ID
- Since
- Series60 5.0
Parameters
const TDesC8 & aProviderID | the unique identifier of the (identity) provider |
SetSnapIdL(TUint32)
IMPORT_C void | SetSnapIdL | ( | TUint32 | aIapId | ) | |
SetTransportCueL(const TDesC8 &)
IMPORT_C TInt | SetTransportCueL | ( | const TDesC8 & | aTransportCue | ) | |
SetTransportPropertiesL(const TDesC8 &)
IMPORT_C TInt | SetTransportPropertiesL | ( | const TDesC8 & | aProperties | ) | |
StartElementL(const TDesC8 &, const TDesC8 &, const TDesC8 &, const RAttributeArray &)
Callback function which implements the XML content handler interface.
- Since
- Series60 3.0
Parameters
const TDesC8 & aNsUri | |
const TDesC8 & aLocalName | The local name of the new element |
const TDesC8 & aQName | The qualified name of the new element |
const RAttributeArray & aAttributes | The attributes of the new element |
TransportCue()
Getter for transport cue, assuming that attribute has been set, and that has "cue" -attribute.
TransportPropertiesL(HBufC8 *&)
IMPORT_C TInt | TransportPropertiesL | ( | HBufC8 *& | aProperties | ) | |
WriteAsXMLToL(RWriteStream &)
IMPORT_C void | WriteAsXMLToL | ( | RWriteStream & | aWriteStream | ) | [virtual] |
Writes this service description as XML, in UTF-8 form to a stream
- Since
- Series60 3.0
Member Data Documentation
CSenCredential * iCredential
RCredentialList
iCredentialList
TTime
iNotOnOrAfter
TTime
| iNotOnOrAfter | [private] |
CSenProviderPolicy * iProviderPolicy
CSenServicePolicy * iServicePolicy
const TDescriptionClassType iType
const TDescriptionClassType | iType | [protected] |
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.