#include <mw/SenXmlServiceDescription.h>
class CSenXmlServiceDescription : public CSenDomFragment |
Protected Attributes | |
---|---|
const TDescriptionClassType | iType |
Protected Member Functions | |
---|---|
CSenXmlServiceDescription(TDescriptionClassType) | |
IMPORT_C void | ConstructL() |
IMPORT_C void | ConstructL(const TDesC8 &) |
IMPORT_C void | ConstructL(const TDesC8 &, const TDesC8 &) |
virtual IMPORT_C void | EndElementL(const TDesC8 &, const TDesC8 &, const TDesC8 &) |
virtual IMPORT_C void | StartElementL(const TDesC8 &, const TDesC8 &, const TDesC8 &, const RAttributeArray &) |
Inherited Attributes | |
---|---|
CSenBaseFragment::iState | |
CSenBaseFragment::iWs | |
CSenBaseFragment::iXmlReader | |
CSenBaseFragment::ipElement | |
CSenBaseFragment::ipOwner | |
CSenDomFragment::ipDomDelegate |
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.
contract (typically some URI)
endpoint (typically some URL)
frameworkID
IMPORT_C | CSenXmlServiceDescription | ( | TDescriptionClassType | aType | ) | [protected] |
C++ default constructor.
Parameter | Description |
---|---|
aType | enumeration defining the type of this class. |
IMPORT_C HBufC8 * | AsXmlL | ( | ) | [virtual] |
Reimplemented from CSenBaseFragment::AsXmlL()
Returns: the service description as XML, which ownership is transferred to the caller.
IMPORT_C HBufC * | AsXmlUnicodeL | ( | ) | [virtual] |
Reimplemented from CSenBaseFragment::AsXmlUnicodeL()
Returns: the service description as XML, in Unicode (UCS-2) encoding form.
IMPORT_C void | ConstructL | ( | const TDesC8 & | aNamespaceURI | ) | [protected] |
Parameter | Description |
---|---|
aNamespaceURI | for this service description, which is also an XML element. |
IMPORT_C RCredentialList & | Credentials | ( | ) |
Returns: the list of credentials (CSenCredential objects).
IMPORT_C void | EndElementL | ( | const TDesC8 & | aNsUri, |
const TDesC8 & | aLocalName, | |||
const TDesC8 & | aQName | |||
) | [protected, virtual] |
Reimplemented from CSenBaseFragment::EndElementL(const TDesC8 &,const TDesC8 &,const TDesC8 &)
Parameter | Description |
---|---|
aNsUri | The namespace URI of the new element |
aLocalName | The local name of the new element |
aQName | The qualified name of the new element |
IMPORT_C TBool | HasEqualPrimaryKeysL | ( | MSenServiceDescription & | aCandidate | ) |
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).
Parameter | Description |
---|---|
aCandidate | is a service description, which primary keys are checked in this comparison. |
Returns: TBool ETrue if primary keys are equal, EFalse otherwise.
Parameter | Description |
---|---|
aURI | the facet to check, typically some URI. |
aHasFacet | is ETrue if facet is found and EFalse, if not. |
Returns: KErrNone or other system-wide Symbian error codes.
IMPORT_C const CSenIdentityProviderIdArray8 & | IdentityProviderIds8L | ( | ) | [virtual] |
IMPORT_C const TDesC8 & | NewElementName | ( | ) | [virtual] |
Returns: descriptor to XML localname of this service description
IMPORT_C CSenXmlServiceDescription * | NewL | ( | ) | [static] |
Reimplemented from CSenDomFragment::NewL()
Standard 2 phase constructor
Returns: a pointer to a new CSenXmlServiceDescription instance.
IMPORT_C CSenXmlServiceDescription * | NewL | ( | const TDesC8 & | aNamespaceURI | ) | [static] |
Reimplemented from CSenDomFragment::NewL(const TDesC8 &)
Standard 2 phase constructor
Parameter | Description |
---|---|
aNamespaceURI | namespace URI for the service description. |
Returns: a pointer to a new CSenXmlServiceDescription instance
IMPORT_C CSenXmlServiceDescription * | NewL | ( | const TDesC8 & | aEndPoint, |
const TDesC8 & | aContract | |||
) | [static] |
Reimplemented from CSenDomFragment::NewL(const TDesC8 &,const TDesC8 &)
Standard 2 phase constructors
Parameter | Description |
---|---|
aContract | identifies the service type. |
Returns: a pointer to a new CSenXmlServiceDescription instance
IMPORT_C CSenXmlServiceDescription * | NewLC | ( | ) | [static] |
Standard 2 phase constructor
Returns: a pointer to a new CSenXmlServiceDescription instance, which is left on cleanup stack.
IMPORT_C CSenXmlServiceDescription * | NewLC | ( | const TDesC8 & | aNamespaceURI | ) | [static] |
Standard 2 phase constructor
Parameter | Description |
---|---|
aNamespaceURI | namespace URI for the service description. |
Returns: a pointer to a new CSenXmlServiceDescription instance, which is left on cleanup stack.
IMPORT_C CSenXmlServiceDescription * | NewLC | ( | const TDesC8 & | aEndPoint, |
const TDesC8 & | aContract | |||
) | [static] |
Standard 2 phase constructors
Parameter | Description |
---|---|
aContract | identifies the service type. |
Returns: a pointer to a new CSenXmlServiceDescription instance, which is left on cleanup stack.
IMPORT_C TBool | PromptUserInfo | ( | ) |
Getter for current userinfo mode (KSenAttrPromptUserInfo attribute).
Returns: Boolean that indicates the mode: EFalse means that end-user prompts (notifier dialogs) have been explicitely surpressed, and thus will not be shown to end-user: attribute value is exactly as follows: "false" ETrue means that attribute named as KSenAttrPromptUserInfo does not exist (default), or it has ANY value OTHER than "false"
IMPORT_C TPtrC8 | ProviderId | ( | ) |
Returns: the (locally) unique identifier of the (identity) provider KErrNone on success, KErrArgument if aProviderID is of zero-length, or one of the system-wide Symbian error codes otherwise.
IMPORT_C TInt | RebuildFrom | ( | MSenProviderPolicy & | aTemplate | ) | [virtual] |
IMPORT_C void | ResumeParsingFromL | ( | const TDesC8 & | aNsUri, |
const TDesC8 & | aLocalName, | |||
const TDesC8 & | aQName | |||
) | [virtual] |
Reimplemented from CSenDomFragment::ResumeParsingFromL(const TDesC8 &,const TDesC8 &,const TDesC8 &)
Parameter | Description |
---|---|
aNsUri | The namespace URI of the current element |
aLocalName | The local name of the current element |
aQName | The qualified name of the current element |
IMPORT_C TInt | ScoreMatchL | ( | MSenServiceDescription & | aPattern | ) | [virtual] |
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.
Parameter | Description |
---|---|
aPattern | a ServiceDescription, typically with partial information. |
Returns: the score or error. If nothing matches, returns 0. In case of any error, a negative value is returned.
IMPORT_C MSenServicePolicy * | ServicePolicy | ( | ) |
Getter for (web) service policy
Returns: pointer to service policy, or NULL, if it is not available
IMPORT_C void | SetAttributesL | ( | const RAttributeArray & | aAttributes | ) | [virtual] |
Reimplemented from CSenDomFragment::SetAttributesL(const RAttributeArray &)
Parameter | Description |
---|---|
aAttributes | the attribute list. |
IMPORT_C void | SetFrameworkIdL | ( | const TDesC8 & | aFrameworkID | ) |
IMPORT_C void | SetIdentityProviderIdsL | ( | CSenIdentityProviderIdArray8 & | aList | ) | [virtual] |
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.
Parameter | Description |
---|---|
aName | is the Name of the attribute. |
Returns: KErrNone on success, KErrArgument if any of the arguments (descriptors) is of zero-length, or one of the system-wide error codes otherwise.
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>
Parameter | Description |
---|---|
aName | is the Name of the Policy attribute. |
aValue | is the Contents of the Policy attribute. |
Returns: KErrNone on success, KErrArgument if any of the arguments (descriptors) is of zero-length, or one of the system-wide error codes otherwise.
IMPORT_C TInt | SetPolicyL | ( | const TDesC8 & | aName, |
const TDesC8 & | aValue, | |||
const TDesC8 & | aAttribName, | |||
const TDesC8 & | aAttribValue | |||
) |
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>
Parameter | Description |
---|---|
aName | is the Name of the Policy attribute. |
aValue | is the Contents of the Policy attribute. |
aAttribName | is the Name of the attribute in element aName |
aAttribValue | is the Contents of the aAttribName attribute. |
Returns: KErrNone on success, KErrArgument if any of the arguments (descriptors) is of zero-length, or one of the system-wide error codes otherwise.
IMPORT_C void | SetPromptUserInfoL | ( | TBool | aPromptUserInfoMode | ) |
password notifier dialog is shown to end-user or not, when authentication fails (due wrong, or incomplete userinfo).
Parameter | Description |
---|---|
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. |
Parameter | Description |
---|---|
aProviderID | the unique identifier of the (identity) provider |
Returns: KErrNone on success, KErrArgument if aProviderID is of zero-length, or one of the system-wide Symbian error codes otherwise.
IMPORT_C void | SetSnapIdL | ( | TUint32 | aIapId | ) |
Sets the SNAP ID.
Parameter | Description |
---|---|
aIapId | A TUint32 Snap ID |
IMPORT_C void | StartElementL | ( | const TDesC8 & | aNsUri, |
const TDesC8 & | aLocalName, | |||
const TDesC8 & | aQName, | |||
const RAttributeArray & | aAttributes | |||
) | [protected, virtual] |
Reimplemented from CSenDomFragment::StartElementL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &)
Parameter | Description |
---|---|
aLocalName | The local name of the new element |
aQName | The qualified name of the new element |
aAttributes | The attributes of the new element |
IMPORT_C TPtrC8 | TransportCue | ( | ) |
Getter for transport cue, assuming that attribute has been set, and that has "cue" -attribute.
Returns: transport plug-in ECOM cue, or KNullDesC8, if it has not been set in this service description. In each ECOM resource file the cue is defined by "default_data" property.
IMPORT_C void | WriteAsXMLToL | ( | RWriteStream & | aWriteStream | ) | [virtual] |
Reimplemented from CSenBaseFragment::WriteAsXMLToL(RWriteStream &)
Parameter | Description |
---|---|
aWriteStream | to write into. |