MSenServiceDescription.h

00023 #ifndef M_SEN_SERVICE_DESCRIPTION_H
00024 #define M_SEN_SERVICE_DESCRIPTION_H
00025 
00026 //  INCLUDES
00027 #include <e32base.h>
00028 #include <e32des8.h>    
00029 #include <s32strm.h>
00031 // CONSTANTS
_LIT8(KSenFacetValFalse,                "false");
_LIT8(KSenFacetValTrue,                 "true");
00035 // Facet identifier (URN) constants:
_LIT8(KCompleteMessagesFacet,           "urn:nokia.com.serene:complete-messages");
_LIT8(KExposeLocalServiceFacet,         "urn:nokia.com.serene:expose");
_LIT8(KProviderSharableFacet,           "urn:nokia.com.serene.provider:sharable");
_LIT8(KProviderCompleteClientMsgsFacet, "urn:nokia.com.serene.provider:complete-client-messages") ;
_LIT8(KProviderLoadOnStartupFacet,      "urn:nokia.com.serene.provider:load-on-startup") ;
_LIT8(KProviderThreadsafeFacet,         "urn:nokia.com.serene.provider:threadsafe") ;
_LIT8(KProviderReinitializableFacet,    "urn:nokia.com.serene.provider:re-initializable") ;
_LIT8(KProviderStayOnBackgroundFacet,   "urn:nokia.com.serene.provider:stay-on-background") ;
_LIT8(KTransportClassFacet,             "urn:nokia.com:serene:transport:class");
00046 // Transport plug-in types (ECOM cues / class types):
_LIT8(KSenTransportCueHTTP,              "com.nokia.wsf.transport.plugin.httpchannel");
_LIT8(KSenTransportCueVirtualTCP,        "com.nokia.wsf.transport.plugin.virtualtcp"); 
_LIT8(KSenTransportCueLocalEcom,         "com.nokia.wsf.transport.plugin.local");  
_LIT8(KSenTransportCueHostletConnection, "com.nokia.wsf.transport.plugin.hostlet");
00052 // Transport schemes
_LIT8(KSenTransportSchemeHTTP,              "http");
_LIT8(KSenTransportSchemeTCP,               "tcp");
_LIT8(KSenTransportSchemeLocal,             "local");
_LIT8(KSenTransportSchemeHostlet,           "hostlet");
00057 //_LIT8(KSenTransportSchemeVirtualTCP,        "vtcp"); 
00059 const TInt KSenServiceDescriptionBaseScore = 100;
00061 // FORWARD DECLARATIONS
00062 class CSenFacet;
00064 // DATA TYPES
00065 typedef RPointerArray<CSenFacet> RFacetArray;
00067 // CLASS DECLARATION
00076 class MSenServiceDescription
00077     {
00078     public: 
00083         IMPORT_C enum TDescriptionClassType
00084             {
ERoot                               = 0, // not in use
EBaseServiceDescription             = 1, // not in use
EXmlServiceDescription              = 2,
EIdentityProvider                   = 3, 
EServicePattern                     = 4, 
EServiceSession                     = 5,
EWebServiceSession                  = 6,
EBasicWebServiceSession             = 7,
EIdWSFServiceSession                = 8,
EIdWsfServiceInstance               = 9, 
ECoreServiceConsumer                = 10,
ESenInternalServiceConsumer         = 11,
EIdWsfAuthenticationServiceClient   = 12,
EIdWsfDiscoveryServiceClient        = 13,
ERestServiceSession                 = 14,
EWSStarServiceSession               = 15,
EWSStarSTSClient                    = 16,
EWSStarPolicyClient                 = 17,
EWSDescription                      = 18,
EWSPattern                          = 19,
EAtomPubServiceSession              = 20,
EAtomPubAuthClient                  = 21,
EAccount                            = 22,
EOviServiceSession                  = 23,
EOviOAuthClient                     = 24
00110             };
00112         // New functions
00121         virtual TDescriptionClassType DescriptionClassType() = 0;
00142         virtual TBool Matches(MSenServiceDescription& aPattern) = 0;
00149         virtual TPtrC8 Contract() = 0;
00158         virtual TInt HasFacetL(const TDesC8& aURI, TBool& aHasFacet) = 0;
00160         /*
00161         * Method for getting a facet value  from the service description 
00162         * @since Series60 3.0
00163         * @param aURI           the facet to get
00164         * @param aValueTo       a ref-to-pointer into which the value will
00165         *                       be allocated, which ownership is transferred
00166         *                       to the caller.
00167         * @return       KErrNone 
00168         *               KErrNoMemory value couldn't be allocated due to lack 
00169         *               of memory
00170         *               KErrNotFound if the wanted facet was not found.
00171         *               Other system-wide Symbian error codes.
00172         */
00173         virtual TInt FacetValue(TDesC8& aURI, HBufC8*& aValueTo) = 0;
00184         virtual TInt AddFacetL(const CSenFacet& aFacet) = 0;
00197         virtual TInt SetFacetL(const CSenFacet& aFacet) = 0;
00207         virtual TInt RemoveFacet(const TDesC8& aURI) = 0;
00219         virtual TInt FacetsL(RFacetArray& aFacetArray) = 0;
00240         virtual TInt ScoreMatchL(MSenServiceDescription& aPattern) = 0;
00247         virtual TPtrC8 Endpoint() = 0;
00254         virtual TPtrC8 FrameworkId() = 0;
00261         virtual TPtrC8 FrameworkVersion() = 0;
00268         virtual void SetContractL(const TDesC8& aContract) = 0;
00280         virtual void SetEndPointL(const TDesC8& aEndPoint) = 0;
00288         virtual HBufC8* AsXmlL() = 0;
00296         virtual HBufC* AsXmlUnicodeL() = 0;
00303         virtual void WriteAsXMLToL(RWriteStream& aWriteStream) = 0;
00304     };
00306 #endif // M_SEN_SERVICE_DESCRIPTION_H
00307 
00308 // End of File