SenXmlServiceDescription.h

00001 /*
00002 * ==============================================================================
00003 *  Name        : SenXmlServiceDescription.h
00004 *  Part of     : Web Services Description
00005 *  Interface   : 
00006 *  Description : Class implements the most common value object used in WSF, 
00007 *                which is used to  describe some invocable service. 
00008 *  Version     : 
00009 *
00010 *  Copyright © 2002-2005 Nokia. All rights reserved.
00011 *  This material, including documentation and any related 
00012 *  computer programs, is protected by copyright controlled by 
00013 *  Nokia. All rights are reserved. Copying, including 
00014 *  reproducing, storing, adapting or translating, any 
00015 *  or all of this material requires the prior written consent of 
00016 *  Nokia. This material also contains confidential 
00017 *  information which may not be disclosed to others without the 
00018 *  prior written consent of Nokia.
00019 * ==============================================================================
00020 */
00022 #ifndef SEN_XML_SERVICE_DESCRIPTION_H
00023 #define SEN_XML_SERVICE_DESCRIPTION_H
00024 
00025 //  INCLUDES
00026 #include <e32base.h>
00027 #include <e32des8.h>
00028 #include <e32std.h>
00029 #include <MSenServiceDescription.h>
00030 #include <MSenProviderPolicy.h>
00031 #include <SenDomFragment.h>
00033 // CONSTANTS
00034 const TInt KStateParsingCredentials         = 12;
00035 const TInt KStateParsingSingleCredential    = 122;
00036 const TInt KStateParsingProviderPolicy      = 1222;
00037 const TInt KStateParsingServicePolicy       = 12222;
_LIT8( KSenAttrSoap12,                  "SOAP12"               );
_LIT8( KSenAttrAddressing,              "Addressing"           );
_LIT8( KSenAttrClientEntropy,           "ClientEntropy"        );
_LIT8( KSenAttrTokenType,               "TokenType"            );
_LIT8( KSenAttrPassportExtensions,      "PassportExtensions"   );
_LIT8( KSenAttrMetadataEndpoint,        "MetadataEndpoint"     );
_LIT8( KSenAttrUsernameTokenOverTLS,    "UsernameTokenOverTLS" );
_LIT8( KSenAttrPromptUserInfo,          "promptUserInfo"       );
00048 // FORWARD DECLARATIONS
00049 class CSenCredential;
00050 class CSenProviderPolicy;
00051 class CSenServicePolicy;
00052 class MSenServicePolicy;
00054 // DATA TYPES
00055 typedef RPointerArray<CSenCredential> RCredentialList;
00057 // CLASS DECLARATION
00077 class CSenXmlServiceDescription : public CSenDomFragment,
00078                                   public MSenServiceDescription,
00079                                   public MSenProviderPolicy
00080     {
00081     public:  // Constructors and destructor
00087         IMPORT_C static CSenXmlServiceDescription* NewL();
00094         IMPORT_C static CSenXmlServiceDescription* NewLC();
00101         IMPORT_C static CSenXmlServiceDescription* NewL(const TDesC8& aNamespaceURI);
00109         IMPORT_C static CSenXmlServiceDescription* NewLC(const TDesC8& aNamespaceURI);
00122         IMPORT_C static CSenXmlServiceDescription* NewL(const TDesC8& aEndPoint,
00123                                                         const TDesC8& aContract);
00137         IMPORT_C static CSenXmlServiceDescription* NewLC(const TDesC8& aEndPoint,
00138                                                          const TDesC8& aContract);
00143         IMPORT_C virtual ~CSenXmlServiceDescription();
00145         // New functions
00159         IMPORT_C void SetFrameworkIdL(const TDesC8& aFrameworkID);
00168         IMPORT_C virtual const TDesC8& NewElementName();
00176         IMPORT_C  RCredentialList& Credentials();        
00178         // Functions from base classes
00180         // From MSenProviderPolicy
00181         IMPORT_C virtual void SetIapIdL(TUint32 aIapId);
00182         IMPORT_C virtual TInt IapId(TUint32& aCurrentIapId);
00183         IMPORT_C virtual void SetIdentityProviderIdsL(
CSenIdentityProviderIdArray8& aList);
00185                 IMPORT_C TInt SetTransportPropertiesL(const TDesC8& aProperties);
00187         IMPORT_C virtual TInt AddIdentityProviderIdL(TDesC8& aProviderId);
00188         IMPORT_C virtual TInt RebuildFrom(MSenProviderPolicy& aTemplate);
00189         IMPORT_C virtual const CSenIdentityProviderIdArray8&
IdentityProviderIds8L();
00191             IMPORT_C TInt TransportPropertiesL(HBufC8*& aProperties);
00193         IMPORT_C virtual TBool Accepts(MSenProviderPolicy& aPolicyPattern);
00195         // From MSenServiceDescription:
00196         IMPORT_C TDescriptionClassType DescriptionClassType();
00197         IMPORT_C TBool Matches(MSenServiceDescription& aPattern);
00198         IMPORT_C TPtrC8 Contract();
00200         // New method
00208         IMPORT_C virtual TInt HasFacetL(const TDesC8& aURI, TBool& aHasFacet);
00210         // From MSenServiceDescription
00211         IMPORT_C virtual TInt FacetValue(TDesC8& aURI, HBufC8*& aValueTo);
00212         IMPORT_C virtual TInt AddFacetL(const CSenFacet& aFacet);
00213         IMPORT_C virtual TInt SetFacetL(const CSenFacet& aFacet);
00214         IMPORT_C virtual TInt RemoveFacet(const TDesC8& aURI);
00215         IMPORT_C virtual TInt FacetsL(RFacetArray& aFacetArray);
00217         // New method
00236         IMPORT_C virtual TInt ScoreMatchL(MSenServiceDescription& aPattern);
00238         // From MSenServiceDescription
00240         IMPORT_C TPtrC8 Endpoint();
00241         IMPORT_C TPtrC8 FrameworkId();
00242         IMPORT_C TPtrC8 FrameworkVersion();
00243         IMPORT_C void SetContractL(const TDesC8& aContract);
00244         IMPORT_C void SetEndPointL(const TDesC8& aEndPoint);
00246         // From CSenBaseFragment 
00254         IMPORT_C virtual HBufC8* AsXmlL();
00262         IMPORT_C virtual HBufC* AsXmlUnicodeL();
00269         IMPORT_C virtual void WriteAsXMLToL(RWriteStream& aWriteStream);
00272         // From CSenDomFragment 
00282         IMPORT_C void SetAttributesL(const RAttributeArray& aAttributes);
00296         IMPORT_C void ResumeParsingFromL(const TDesC8& aNsUri,
00297                                          const TDesC8& aLocalName,
00298                                          const TDesC8& aQName);
00300     protected:  // New functions
00306         IMPORT_C CSenXmlServiceDescription(TDescriptionClassType aType);
00311         IMPORT_C void ConstructL();
00319         IMPORT_C void ConstructL(const TDesC8& aNamespaceURI);
00332         IMPORT_C void ConstructL(const TDesC8& aEndPoint, const TDesC8& aContract);
00334         // Functions from base classes
00336         // From CSenDomFragment 
00346         IMPORT_C virtual void StartElementL(const TDesC8& aNsUri,
00347                                             const TDesC8& aLocalName,
00348                                             const TDesC8& aQName,
00349                                             const RAttributeArray& aAttributes);
00351         // From CSenBaseFragment 
00359         IMPORT_C virtual void EndElementL(const TDesC8& aNsUri,
00360                                           const TDesC8& aLocalName,
00361                                       const TDesC8& aQName);
00363     public:
00382         IMPORT_C TBool HasEqualPrimaryKeysL(MSenServiceDescription& aCandidate);
00384         /*
00385         * Method checks specific pieces of information to determine, whether this
00386         * service description is local or not. Typically this is defined by the
00387         * endpoint's scheme, which is KSenTransportSchemeLocal in most of the cases,
00388         * when this method returns true.
00389         * @return boolean indicating whether this endpoint is local or not.
00390         */
00391         IMPORT_C TBool IsLocalL(); 
00394         /*
00395         * Method for binding transport plug-in type with the endpoint in question.
00396         * Function adds/sets XML attribute called "cue" for <Endpoint> element:
00397         *  
00398         *  <ServiceDescription>
00399         *    <Endpoint cue="com.nokia.wsf.transport.plugin.hostlet">
00400         *        local://urn:nokia.com.test.hostlet
00401         *    </Endpoint>
00402         *  </ServiceDescription>
00403         *
00404         * In above example, eventhough endpoint scheme "local://" would normally
00405         * invoke different type of plug-in (ECOM hostlet), the "cue" attribute 
00406         * overrides this, and forces hostlet connection transport plug-in to be
00407         * loaded.
00408         *
00409         * Transport plug-in types (cues):
00410         *
00411         *    _LIT8(KSenTransportCueHTTP,              "com.nokia.wsf.transport.plugin.httpchannel");
00412         *    _LIT8(KSenTransportCueVirtualTCP,        "com.nokia.wsf.transport.plugin.virtualtcp");
00413         *    _LIT8(KSenTransportCueLocalEcom,         "com.nokia.wsf.transport.plugin.local");  
00414         *    _LIT8(KSenTransportCueHostletConnection, "com.nokia.wsf.transport.plugin.hostlet");
00415         *
00416         *
00417         * Note that this method does not attempt to load the plug-in - it might not
00418         * even exist in the system. Neither is this attribute checked when XML service
00419         * description is parsed. As a conclusion, if non-existant plug-ins are bind 
00420         * to endpoints, they will be ignored, and the transport is created in normal
00421         * way and plug-in is chosen based on endpoint scheme and/or defaults.
00422         * 
00423         * @param aTransportCue is the ECOM cue of CSenTransport implementation.
00424         * In ECOM resource files, cue is the value of "default_data" property.
00425         * @return KErrNone on success
00426         *         KErrSenNoEndpoint, if  endpoint element does not exist in this XML
00427         *         service description.
00428         */
00429         IMPORT_C TInt SetTransportCueL(const TDesC8& aTransportCue);
00439         IMPORT_C TPtrC8 TransportCue();
00445         IMPORT_C MSenServicePolicy* ServicePolicy();
00457         IMPORT_C TInt SetPolicyL(const TDesC8& aName);
00471         IMPORT_C TInt SetPolicyL(const TDesC8& aName, const TDesC8& aValue);
00490         IMPORT_C TInt SetPolicyL(const TDesC8& aName, const TDesC8& aValue, const TDesC8& aAttribName, const TDesC8& aAttribValue);
00499         IMPORT_C TInt SetProviderIdL( const TDesC8& aProviderID );
00508         IMPORT_C TPtrC8 ProviderId();
00523         IMPORT_C void CSenXmlServiceDescription::SetPromptUserInfoL( TBool aPromptUserInfoMode );
00534         IMPORT_C TBool PromptUserInfo();
00536         public:
00541         IMPORT_C void SetSnapIdL(TUint32 aIapId); 
00549         IMPORT_C TInt SnapId(TUint32& aCurrentIapId); 
00551     private:
00552         TInt FacetValueL(TDesC8& aURI, HBufC8*& aValueTo);
00553         TInt RemoveFacetL(const TDesC8& aURI);
00555     protected: // Data
00556         // the type of this class instance
00557         const TDescriptionClassType iType;
00559     private: // Data
00560         CSenServicePolicy* iServicePolicy;
CSenCredential* iCredential;
RCredentialList iCredentialList;
00564         // Timestamp indicating validity of credentials. Using SenDateUtils 
00565         // FromXmlDateTimeL and ToXmlDateTimeUtf8L is recommended for conversions.
00566         TTime iNotOnOrAfter;
00567         CSenProviderPolicy* iProviderPolicy;
00568     };
00570 #endif // SEN_XML_SERVICE_DESCRIPTION_H
00571 
00572 // End of File