#include <mw/SenServicePattern.h>
class CSenServicePattern : public CSenXmlServiceDescription |
Protected Attributes | |
---|---|
CSenConsumerPolicy * | iConsumerPolicy |
Protected Member Functions | |
---|---|
CSenServicePattern(MSenServiceDescription::TDescriptionClassType) | |
IMPORT_C void | BaseConstructL() |
IMPORT_C void | BaseConstructL(const TDesC8 &) |
IMPORT_C void | BaseConstructL(const TDesC8 &, const TDesC8 &) |
Class derives the XML service description and further extends it by implementing consumer policy interface.
Service pattern is typically used by Basic Web Service consumers, which often know, which policy to use in the communication with certain Web Service Provider (WSP).
For example, a Basic Web Service consumer application might want strictly define certain Internet Access Point (IAP) to be used when initializing new service connection. Such an application can simply instantiate new ServicePattern and set pre-known IAP ID into it.
The main purpose of this class is to simplify the initialization of service connections for Basic Web Services.
It is important to note, that all the consumer policy information entered via ServicePattern extending the MSenConsumerPolicy is treated in "policy-per-client" terms. In other words, any consumer policy information will not be stored for latter use of other applications (even they might happen to use same WSP and contract!).
This is due the nature of Service Pattern: it acts as a consumer originated filter, after which a service will be resolved.
Any service which "meets" the Service Pattern "constraints", is considered as a "match", because such service accepts this (search) pattern.
IMPORT_C | CSenServicePattern | ( | MSenServiceDescription::TDescriptionClassType | aType | ) | [protected] |
Parameter | Description |
---|---|
aType | enumeration defininng the type of this class. |
IMPORT_C TBool | AcceptsConsumerPolicy | ( | MSenConsumerPolicy & | aPolicyPattern | ) | [virtual] |
IMPORT_C void | BaseConstructL | ( | ) | [protected] |
IMPORT_C void | BaseConstructL | ( | const TDesC8 & | aNamespaceURI | ) | [protected] |
Reimplemented from CSenDomFragment::BaseConstructL(const TDesC8 &)
Parameter | Description |
---|---|
aNamespaceURI | the localname for XML element representation of this class. |
Reimplemented from CSenDomFragment::BaseConstructL(const TDesC8 &,const TDesC8 &)
Parameter | Description |
---|---|
aEndPoint | is the actual endpoint to the service |
aContract | of the service, typically some URI |
IMPORT_C const CSenIdentityProviderIdArray8 & | ConsumerIdentityProviderIds8L | ( | ) | [virtual] |
IMPORT_C HBufC8 * | ConsumerPolicyAsXmlL | ( | ) |
Returns: consumer policy as UTF-8 form XML.
IMPORT_C TBool | Matches | ( | MSenServiceDescription & | aServicePattern | ) |
Reimplemented from CSenXmlServiceDescription::Matches(MSenServiceDescription &)
Returns: ETrue both service description and policy information matches, otherwise EFalse. If some value is not set in current instance, it is not compared.
IMPORT_C CSenServicePattern * | NewL | ( | ) | [static] |
Reimplemented from CSenXmlServiceDescription::NewL()
Standard 2 phase constructors
IMPORT_C CSenServicePattern * | NewL | ( | const TDesC8 & | aNamespaceURI | ) | [static] |
Reimplemented from CSenXmlServiceDescription::NewL(const TDesC8 &)
Standard 2 phase constructor
Parameter | Description |
---|---|
aNamespaceURI | namespace URI for the service pattern. |
IMPORT_C CSenServicePattern * | NewL | ( | const TDesC8 & | aEndPoint, |
const TDesC8 & | aContract | |||
) | [static] |
Reimplemented from CSenXmlServiceDescription::NewL(const TDesC8 &,const TDesC8 &)
Standard 2 phase constructor.
Parameter | Description |
---|---|
aEndPoint | service pattern endpoint. |
aContract | service pattern contract. |
IMPORT_C CSenServicePattern * | NewLC | ( | ) | [static] |
Reimplemented from CSenXmlServiceDescription::NewLC()
Standard 2 phase constructors
IMPORT_C CSenServicePattern * | NewLC | ( | const TDesC8 & | aNamespaceURI | ) | [static] |
Reimplemented from CSenXmlServiceDescription::NewLC(const TDesC8 &)
Standard 2 phase constructor
Parameter | Description |
---|---|
aNamespaceURI | namespace URI for the service pattern. |
IMPORT_C CSenServicePattern * | NewLC | ( | const TDesC8 & | aEndPoint, |
const TDesC8 & | aContract | |||
) | [static] |
Reimplemented from CSenXmlServiceDescription::NewLC(const TDesC8 &,const TDesC8 &)
Standard 2 phase constructor.
Parameter | Description |
---|---|
aEndPoint | service pattern endpoint. |
aContract | service pattern contract. |
IMPORT_C TInt | RebuildFromConsumerPolicy | ( | MSenConsumerPolicy & | aTemplate | ) | [virtual] |
IMPORT_C void | SetConsumerIdentityProviderIdsL | ( | CSenIdentityProviderIdArray8 & | aList | ) | [virtual] |
IMPORT_C void | SetConsumerSnapIdL | ( | TUint32 | aSnapId | ) |
Sets the Consumer SNAP ID.
Parameter | Description |
---|---|
aSnapId | A TUint32 Snap ID |
IMPORT_C void | StartElementL | ( | const TDesC8 & | aNsUri, |
const TDesC8 & | aLocalName, | |||
const TDesC8 & | aQName, | |||
const RAttributeArray & | aAttributes | |||
) |
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 |
aAttributes | The attributes of the new element |